day81 初识drf

目录

• 一、web应用模式
• 二、API接口
  • 1 rpc（远程过程调用/远程服务调用）
  • 2 restful（资源状态转换）
• 三、RESTful API规范
• 四、序列化
• 五、Django Rest_Framework
  • 特点
• 六、安装DRF
• 七、体验drf完全简写代码过程
  • 1 创建模型
  • 2 创建序列化器
  • 3 编写视图
  • 4 定义路由
  • 5 运行测试

一、web应用模式

第一种：前后端不分离

客户端看到的所有内容和效果都是由服务端提供的，前端页面涉及到服务端的模版语法

第二种：前后端分离

把前端的页面效果（js，html，css）分离到另外一个项目中，服务端只要提供返回数据即可

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

二、API接口

当前后端分离后，为了防止个人习惯引起的差异，需要找到一种合理的接口规范，减少前后端程序员合作成本

目前常用的接口服务框架：restful、rpc、soap

1 rpc（远程过程调用/远程服务调用）

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

只有一种请求：post

数据连接格式：action=接口函数&参数1=xxx&参数2=xxx

优势：

不需要管是什么请求，也不需要操作url地址的编写，对接简单

缺点：

接口多了就容易难找，容易重复

2 restful（资源状态转换）

把所有的后端数据/文件看做是资源，接口请求数据本质上就是对资源的操作

所以要求在地址栏中声明要操作的资源是什么,然后通过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]

优点：

维护开发简单，不会出现太多重复接口

缺点：

1. 有部分接口不会有明确的增删查改这种区分的，所以会出现一些不伦不类的接口。会因为这些语义不明，不伦不类的接口导致后期的维护成本上升。
2. 因为restful把对于资源的操作都理解成了增删查改，建议使用http，所以restful接口天生局限于web开发。

三、RESTful API规范

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属于非幂等接口。

幂等性例子

幂等

比如我们要请求删除一条数据，对这条数据重复操作删除的还是这条数据，返回的结果也相同，获取/添加同理。

非幂等

比如我们要修改一条数据，返回的是这个数据本身，每次修改获得应该都是不同的返回值

幂等和非幂等，关系到我们接口操作的安全性

四、序列化

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

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

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

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

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

五、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接口】
• 可扩展性，插件丰富

六、安装DRF

打开django的虚拟环境，版本2.2左右

虚拟环境如果想点绿色按钮就启动项目的话

在项目命令行执行，安装drf

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

然后再settings.py的INSTALLED_APPS中添加'rest_framework'

INSTALLED_APPS = [
    ...
    'rest_framework',
]

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

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

七、体验drf完全简写代码过程

1 创建模型

在应用models内创建模型对象

from django.db import models

# Create your models here.
class Student(models.Model):
    # 表字段声明
    # 字段名=models.数据类型(字段约束)
    name = models.CharField(null=False, 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=1000, verbose_name="个性签名")

    # 表信息
    class Meta:
        # 设置表名
        db_table="tb_students"
        verbose_name="学生"
        verbose_name_plural=verbose_name

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

配置数据库，修改数据库驱动，数据迁移

执行上面三步骤后可能会报错

报错1：提示我们mysqlclient版本太低

解决方案：

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

报错2

解决方法：

backends/mysql/operations.py146行里面把decode换成encode：

2 创建序列化器

在应用下创建一个serializers.py用于保存该应用下的序列化器

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

# 创建序列化器类，回头会在试图中被调用
from rest_framework import serializers
from .models import Student
class StudentModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = Student
        fields = "__all__"

• model 指明该序列化器处理的数据字段从模型类BookInfo参考生成
• fields 指明该序列化器包含模型类中的哪些字段，'all'指明包含所有字段

3 编写视图

在views中编写CBV

from rest_framework.viewsets import ModelViewSet
from .models import Student
from .serializers import StudentModelSerializer
# Create your views here.
class StudentViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

• queryset 指明该视图集在查询数据时使用的查询集
• serializer_class 指明该视图在进行序列化或反序列化时使用的序列化器

4 定义路由

在总路由分发后，子路由下

from . import views
from rest_framework.routers import DefaultRouter

# 路由列表
urlpatterns = []

router = DefaultRouter()  # 可以处理视图的路由器
router.register('students', views.StudentViewSet)  # 向路由器中注册视图集

urlpatterns += router.urls  # 将路由器中的所以路由信息追到到django的路由列表中

5 运行测试

略