DRF学习day01（web应用模式，api接口，RESTful API规范，序列化，Django Rest_Framework）

DRF学习day01

1.web的应用模式

在开发web应用中，有两种应用模式：

  1. 前后端不分离（客户端看到的所有内容和界面都是由服务器提供的）

    在这种情况下，前端页面会出现很多涉及后端的模板语法。

  2. 前后端分离（把前端的页面效果（html,css,js）分离到另外一个项目中，后端只需要返回数据即可）

前端形成一个独立的网站，后端也形成一个独立的网站

"""
django，一般都是做web网站。如果可以利用django实现前后端分离，则django就可以完成地铁站的运营调度系统，路由的终端系统，pos机的服务端系统，游戏的服务端后台，软件的服务端后台。
"""

2.api接口

"""
    为了在团队内部形成共识、防止个人习惯差异引起的混乱，我们需要找到一种大家都觉得很好的接口实现规范，而且这种规范能够让后端写的接口，用途一目了然，减少双方之间的合作成本。
"""

目前市面上大部分公司开发人员使用的接口服务架构主要有：restful、rpc，soap。

rpc是远程过程调用(Remote Procedure Call)的缩写形式。

服务端提供单一的请求数据api地址：http://api.renran.cn/

例如：post请求

action=get_all_student&class=301&sex=1

# 优势
不需要管当前操作是什么http请求，也不需要操作url地址的编写，对接简单。
# 劣势
接口多了,对应函数名和参数就多了,前端在请求api接口时,就会比较难找.容易出现重复的接口

soap是简单对象访问协议(Simple Object Access Protocol) 的缩写形式。是一种轻量的、简单的、基于XML（标准通用标记语言下的一个子集）的协议，它被设计成在WEB上交换结构化的和固化的信息。

restful表示资源状态装换。它将后端所有的数据和文件都看成资源，那么接口请求数据，本质上来说就是对资源的操作。

web项目中的操作资源，无非就是增删改查等操作，所以要求在地址栏中要声明需要操作的资源是什么，然后通过http请求的动词来表示对资源做什么操作。

POST http://www.renran.cn/api/students/ 添加学生数据

GET http://www.renran.cn/api/students/ 获取所有学生

DELETE http://www.renran.cn/api/students// 删除id=pk的一个学生

PUT http://www.renran.cn/api/students// 修改一个学生的全部信息 [id,name,sex,age,]

PATCH http://www.renran.cn/api/students// 修改一个学生的部分信息[age]

# 优势
维护开发简单，可以保证后期的开发不会出现太多重复接口。
# 劣势
有部分接口不会有明确的增删查改这种区分的，所以会出现一些不伦不类的接口。会因为这些语义不明，不伦不类的接口导致后期的维护成本上升。

因为restful把对于资源的操作都理解成了增删查改，建议使用http，所以restful接口天生局限于web开发。

3.RESTful API 规范

REST是表征性状态转移(Representational State Transfer)的缩写形式。它首次出现在2000年Roy Fielding的博士论文中。

RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中。

这种风格的理念认为后端开发任务就是提供数据的，对外提供的是数据资源的访问接口，所以在定义接口时，客户端访问的URL路径就表示这种要操作的数据资源。

而对于数据资源分别使用POST、DELETE、GET、UPDATE等请求动作来表达对数据的增删查改。

请求方法 请求地址 后端操作
GET /students 获取所有学生
POST /students 增加学生
GET /students/ 获取主键为pk的学生
PUT /students/ 修改主键为pk的学生
DELETE /students/ 删除主键为pk的学生

事实上，我们可以使用任何一个框架都可以实现符合restful规范的API接口。

参考文档：http://www.runoob.com/w3cnote/restful-architecture.html

接口实施过程中，会存在幂等性。所谓幂等性是指代客户端发起多次请求是否对于服务端里面的资源产生不同结果。如果多次请求，服务端结果还是一样，则属于幂等接口，如果多次请求，服务端产生结果是不一样的，则属于非幂等接口。在http请求，get/put/patch/delete都属于幂等性接口，post属于非幂等接口。

为什么要考虑幂等性？主要就是接口操作的安全性问题。

delete /api/students/1

get /api/students/

post /api/students/

4.序列化

api接口开发，最核心最常见的一个过程就是序列化，所谓序列化就是把数据转换格式，序列化可以分两个阶段。

序列化： 把我们识别的数据转换成指定的格式提供给别人。

"""
例如：我们在django中获取到的数据默认是模型对象，但是模型对象数据无法直接提供给前端或别的平台使用，所以我们需要把数据进行序列化，变成字符串或者json数据，提供给前端或者其他平台。
"""

反序列化：把别人提供的数据转换/还原成我们需要的格式。

"""
例如：前端js提供过来的json数据，对于python而言就是字符串，我们需要进行反序列化换成模型类对象，这样我们才能把数据保存到数据库中。
"""

5.Django Rest_Framework

"""
核心思想：编写api接口的代码

Django REST framework是一个建立在Django基础之上的Web 应用开发框架,本质上就是一个内置在django里面的子应用，可以快速的开发REST API接口应用。
"""

在REST framework中，提供了序列化器对象Serialzier的定义，可以帮助我们简化序列化与反序列化的过程，不仅如此，还提供丰富的类视图、扩展类、视图集来简化视图的编写工作。REST framework还提供了认证、权限、限流、过滤、分页、接口文档等功能支持。REST framework提供了一个用于测试API接口 的可视化Web界面【可以浏览器直接访问接口，drf的api接口测试页面非常美观】。

中文文档：https://q1mi.github.io/Django-REST-framework-documentation/#django-rest-framework

github: https://github.com/encode/django-rest-framework/tree/master

特点

  • 提供了定义序列化器Serializer的方法，可以快速根据 Django ORM 或者其它库自动序列化/反序列化；
  • 提供了丰富的类视图、Mixin扩展类，简化视图的编写；
  • 丰富的定制层级：函数视图、类视图、视图集合到自动生成 API，满足各种需要；
  • 多种身份认证和权限认证方式的支持；[jwt Json web token]
  • 内置了限流系统；
  • 直观的 API web 界面；【方便我们调试开发api接口】
  • 可扩展性，插件丰富

6.环境安装与配置

DRF需要以下依赖：

  • Python (2.7, 3.2以上)
  • Django (1.10, 1.11, 2.0以上)

DRF是以Django扩展应用的方式提供的，所以我们可以直接利用已有的Django环境而无需从新创建。（若没有Django环境，需要先创建环境安装Django）

6.1 安装DRF

前提是已经安装了django，建议安装在虚拟环境

# mkvirtualenv drfdemo -p python3
# pip install django==2.2.0  -i https://pypi.douban.com/simple

pip install djangorestframework -i https://pypi.douban.com/simple

# 因为我们需要接下来，需要开发api接口肯定要操作数据，所以安装pymysql
pip install pymysql -i https://pypi.douban.com/simple

linux的终端下 粘贴内容 快捷键： shift+insert

6.1.1 创建Django 项目

cd ~/Desktop
django-admin startproject drfdemo

6.2 添加rest_framework应用

在settings.py的INSTALLED_APPS中添加rest_framework。

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'rest_framework'
]

接下来就可以使用DRF提供的功能进行api接口开发了。在项目中如果使用rest_framework框架实现API接口，主要有以下三个步骤：

  • 将请求的数据（如JSON格式）转换为模型类对象
  • 通过模型类对象进行数据库操作，完成客户端请求的增删查改
  • 将模型类对象转换为响应的数据（如JSON格式）

6.3 使用DRF写代码

6.3.1 创建一个子应用

(drfdemo) moluo@ubuntu:~/Desktop/drfdemo$ python manage.py startapp students

6.3.2 创建模型操作类

在子应用的models.py中创建模型对象。

from django.db import models


# Create your models here.
class Student(models.Model):
    # 表字段声明
    name = models.CharField(null=True, max_length=32, verbose_name="姓名")
    sex = models.BooleanField(default=True, verbose_name="性别")
    age = models.IntegerField(verbose_name="年龄")
    class_num = models.CharField(max_length=5, verbose_name="班级编号")
    description = models.TextField(max_length=1024, verbose_name="个性签名")

    # 表元信息
    class Meta:
        db_table = "db_students"
        verbose_name = "学生表"
        verbose_name_plural = verbose_name

    # 模型类的操作方法
    def __str__(self):
        return self.name

为了方便测试，我们先创建一个数据库

create database students charset=utf8;

6.3.2.1执行数据库迁移

先将students子应用进行注册。

INSTALLED_APPS = [
    ...
    'rest_framework',
    'students',
]

初始化数据库连接

pip install pymysql # 安装pymysql

# 在主应用的`__init__.py`文件中设置使用`pymysql`作为数据库驱动

import pymysql

pymysql.install_as_MySQLdb()

# 在`settings.py`中设置mysql的账号密码

# DATABASES = {
#     'default': {
#         'ENGINE': 'django.db.backends.sqlite3',
#         'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
#     }
# }

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': "students",
        "HOST": "127.0.0.1",
        "PORT": 3306,
        "USER": "root",
        "PASSWORD": "123",
    },
}

# 执行两条数据库迁移命令
# 将数据库的操作以文件的形式存储下来，方便以后检查、调用、重做等等。尤其是对于Git版本管理，它无法获知数据库是如何变化的，只能通过迁移文件中的记录来追溯和保存。
python manage.py makemigrations 

# 使数据库状态与当前模型集和迁移集同步。其实就是将对数据库的更改，主要是数据表设计的更改，在数据库中真实执行。例如，新建、修改、删除数据表，新增、修改、删除某数据表内的字段等等。
python manage.py migrate

在执行数据迁移命令的过程中报错

注释掉 backends/mysql/base.py中的35和36行代码。

如果发生以下的错误：

# 解决方法
backends/mysql/operations.py146行里面把decode换成encode

6.3.3 创建序列化孵化器

在students应用目录中新建serializers.py用于保存该应用的序列化器。

创建一个StudentModelSerializer用于序列化与反序列化。

from rest_framework import serializers

from .models import Student


class StudentModelSerializer(serializers.ModelSerializer):
    # 需要进行数据转换的字段

    # 当前转换模型类的相关声明
    class Meta:
        model = Student
        fields = "__all__"

    # 验证数据的方法[反序列化: 接受客户端的数据]

    # 操作数据的代码[反序列化: 保存数据(添加/更新)]
  • model 指明该序列化器处理的数据字段从模型类Student参考生成
  • fields 指明该序列化器包含模型类中的哪些字段，__all__指明包含所有字段

6.3.4 编写视图

在students应用的views.py中创建视图StudentViewSet，这是一个视图集合。

from django.shortcuts import render

# Create your views here.
# Django中的视图有两种： FBV函数视图和CBV类视图
# 在drf中，我们经常使用类视图

from rest_framework.viewsets import ModelViewSet
from .models import Student
from .serializers import StudentModelSerializer


class StudentAPIView(ModelViewSet):
    """这里提供了5个基本的API接口
    添加一条数据
    修改一条数据
    删除一条数据
    获取一条数据
    获取所有数据
    """
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer
  • queryset 指明该视图集在查询数据时使用的查询集
  • serializer_class 指明该视图在进行序列化或反序列化时使用的序列化器

6.3.5 定义路由

在students应用的urls.py中定义路由信息

from .views import StudentAPIView
from rest_framework.routers import DefaultRouter

# 路由列表
urlpatterns = []
# 使用drf提供的路由类来自动生成路由
router = DefaultRouter() # 可以处理视图的路由器
router.register("stu", StudentAPIView)# 向路由器中注册视图集
urlpatterns += router.urls # 将路由器中的路由信息追到到django的路由列表中

最后把students子应用中的路由文件加载到总路由文件中。

# drfdemo/urls.py

from django.contrib import admin
from django.urls import path, include

# 新版的django把url拆分成了2个路由函数
# django.urls.path 专门编写字符串路由
# django.urls.re_path 专门编写正则路由
urlpatterns = [
    path('admin/', admin.site.urls),
    path('students/', include("students.urls")),
]

6.3.6 运行测试

执行以下的命令：

python manage.py runserver 127.0.0.1:8000

  1. 点击链接http://127.0.0.1:8000/students/stu/可以访问获取所有数据的接口，呈现如下页面：

  2. 在页面底下表单部分填写学生信息，可以访问添加新学生的接口，保存学生信息：

    点击post后返回如下页面信息：

  3. 在浏览器中输入网址http://127.0.0.1:8000/students/stu/4/，可以访问获取单一学生信息的接口（id为4的学生），呈现如下页面：

  4. 在页面底部表单中填写学生信息，可以访问修改学生的接口：

    点击PUT，返回如下页面信息：

  5. 点击DELETE按钮，可以访问删除学生的接口：

    返回，如下页面：

【推广】 免费学中医，健康全家人
原文地址：https://www.cnblogs.com/surpass123/p/13184570.html