drf框架

web应用模式

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

• 前后端不分离 ，客户端看到的内容和所有的页面效果都是服务端提供出来的，这种情况下，前端页面中会出现很多涉及到服务端的模板语法

• 前后端分离，把前端页面的效果(html,css,js分离到一个项目中，python服务端只需要返回数据即可)前端形成一个独立的网站，服务端形成一个独立的网站

api接口

服务端对接客户端的接口，市面上常用的接口服务框架有，restful、rpc、soap。

• rpc:远程过程调用，远程服务调用
  服务端提供统一的请求数据的api地址：http://api.xxx.cn
  客户端需要使用post请求
  api地址加参数，可以调用后端的函数如：action=get_all_student&class=301&sex=1
  优点：不需要关心当前操作是什么请求，也不需要操作url地址的编写，对接简单
  缺点：接口多了，对应的函数名和参数就多了，前端在请求api接口的时候，就会比较难找容易出现重复的接口
• restful:资源状态转换
  把后端所有的数据/文件都看作是资源
  接口请求数据本质上来说就是对资源的操作了
  web项目中操作资源，无非就是增删改查，所以要求在地址栏中声明要操作的资源是什么，然后通过http请求方法来说明对资源进行哪一种操作。
  POST 添加 http://www.xxx.cn/api/students/
  GET 获取 http://www.xxx.cn/api/students/
  DELETE 删除某条信息 http://www.xxx.cn/api/students//
  PUT 修改一个学生全部信息 http://www.xxx.cn/api/students//
  PATCH 修改一个学生部分信息 http://www.xxx.cn/api/students//
  优点:维护开发简单，可以保证后期的开发不会出现太多重复的接口
  缺点：1.有部分接口不会有明确的增删改查的区分，会导致后期维护成本上升
  2.因为restful把对于资源的操作都理解成了增删改查，建议使用http,所以restful接口天生局限于web开发。

restful api接口规范

REST全程Representational State Transfer

restful是一种定义web api接口的设计风格，尤其适用于前后端分离的应用模式中

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

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

文档链接：http://www.runoob.com/w3cnote/restful-architecture.html

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

考虑幂等性，主要是接口操作的安全性问题

具体规范举例：

1. 域名
   应该尽量将API部署在专用域名下面
   https://api.example.com
   如果确定API很简单，不会有进一步的扩展，可以考虑放在主域名下面
   https://www.example.org/api/
2. 版本 Versioning
   项目开发过程中都会对项目进行版本迭代，所以每一个版本的api接口肯定都有可能存在差异，因此应该将API本本号放入URL.
   http://www.example.com/api/1.0/
   http://www.example.com/api/1.1/
   http://www.example.com/api/2.0/
   另一种做法是，将版本号放在HTTP头部信息中，但是不如放在url中方便和直观
   因为是不同的版本，可以理解成同一种资源的不同表现形式，所以应该采用同一个URL,版本号可以在HTTP请求头信息的Accept字段进行区分
   Accept: vnd.example-com.foo+json; version=1.0
   Accept: vnd.example-com.foo+json; version=1.1
   Accept: vnd.example-com.foo+json; version=2.0
3. 路径 Endpoint
   路径又称终点，表示API的具体网址，每个网闸代表一种资源（resource）
   资源作为网址，只能有名词不能有动词，而且所用的名词往往于数据库的表明对应
   不好的例子：
   /getProducts
   /listOrders
   /retreiveClientByOrder?orderId=1
   对于一个简介的结构，应该使用名词，此外利用HTTP方法可以分离网址中的资源名称的操作
   GET /products ： 将返回所有产品清单
   POST /products ： 将产品新建到集合
   GET /products/4 ： 将获取产品 4
   PATCH（或）PUT /products/4 ：将更新产品 4
   API中的名词应该使用复数，无论是子资源还是所有资源
   如：获取产品的API可以这样定义：
   获取单个产品：http://127.0.0.1:8080/AppName/rest/products/1
   获取所有产品: http://127.0.0.1:8080/AppName/rest/products
4. HTTP动词
   对于资源的具体操作类型，有HTTP动词表示
   常见的HTTP动词有下面四个（括号里对相应sql命令）
   • GET（SELECT）：从服务器取出资源（一项或多项）。
   • POST（CREATE）：在服务器新建一个资源。
   • PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
   • DELETE（DELETE）：从服务器删除资源。

三个不常用的HTTP动词

• PATCH（UPDATE）：在服务器更新(更新)资源（客户端提供改变的属性）。
• HEAD：获取资源的元数据。
• OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

举例：
GET /zoos：列出所有动物园
POST /zoos：新建一个动物园（上传文件）
GET /zoos/ID：获取某个指定动物园的信息
PUT /zoos/ID：更新某个指定动物园的信息（提供该动物园的全部信息）
PATCH /zoos/ID：更新某个指定动物园的信息（提供该动物园的部分信息）
DELETE /zoos/ID：删除某个动物园
GET /zoos/ID/animals：列出某个指定动物园的所有动物
DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物

1. 过滤信息 Filtering
   如果记录数量很多，服务器不可能都将他们返回给用户，API应提供参数，过滤返回结果
   下面是一些常见的参数，query_string 查询字符串,地址栏后面问号后面的数据,格式: name=xx&sss=xxx
   参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoos/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。

   完整的URL地址格式：
   协议://域名(IP):端口号/路径?查询字符串#锚点

   ?limit=10：指定返回记录的数量
   ?offset=10：指定返回记录的开始位置。
   ?page=2&per_page=100：指定第几页，以及每页的记录数。
   ?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
   ?animal_type_id=1：指定筛选条件

2. 状态码 Status Codes
   http所有的请求 必有回应的协议
   服务器向用户返回的状态码和提示信息，常见的有以下（括号中是该状态码对应HTTP动词）

   1xx 表示当前本次请求还是持续，没结束
   2xx 表示当前本次请求成功
   3xx 表示当前本次请求成功，但是服务器进行代理操作/重定向
   4xx 表示当前本次请求失败，主要是客户端发生了错误
   5xx 表示当前本次请求失败，主要是服务器发生了错误

   • 200 OK - [GET]：服务器成功返回用户请求的数据
   • 201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
   • 202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
   • 204 NO CONTENT - [DELETE]：用户删除数据成功。
   • 400 INVALID REQUEST - [GET/POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作
   • 401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
   • 403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
   • 404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
   • 406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
   • 410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
   • 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
   • 500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。
   • 507 数据存储出错，往往数据库操作错误出错，服务器就返回这个

3. 错误处理 Error handling
   如果状态码是4xx,服务器就应该向用户返回错误信息，一般来说，返回的信息中将error作为键名，出错信息作为值

   {
   error: "Invalid API key"
   }

4. 返回结果
   针对不同操作，服务器向用户返回的结果应该符合以下规范。

   • GET /collection：返回资源对象的列表（数组）
   • GET /collection/ID：返回单个资源对象(json)
   • POST /collection：返回新生成的资源对象(json)
   • PUT /collection/ID：返回完整的资源对象(json)
   • DELETE /collection/ID：返回一个空文档(空字符串)

5. 超媒体 Hypermedia API
   RESTful API最好做到Hypermedia ，就是返回结果中提供链接，连向其他API方法，这样可以让用户不查文档也知道下一步应该做什么
   比如，Github的API就是这种设计，访问api.github.com会得到一个所有可用API的网址列表。
   从上面可以看到，如果想获取当前用户的信息，应该去访问api.github.com/user，然后就得到了下面结果。
   上面代码表示，服务器给出了提示信息，以及文档的网址。

   {
   "current_user_url": "https://api.github.com/user",
   "authorizations_url": "https://api.github.com/authorizations",
   // ...
   }

   {
   "message": "Requires authentication",
   "documentation_url": "https://developer.github.com/v3"
   }

6. 其他
   服务器返回的数据格式，应该尽量使用JSON，避免使用XML

序列化

api接口开发中，最常见核心的就是序列化，所谓序列化就是把数据格式进行转换，序列化可以分为两段

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

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

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

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

Django REST_Framework

Django REST_Framework是建立在Django基础之上的web应用开发框架，本质就是一个内置在django里面的子应用，可以快速的开发rest api接口应用

在REST_Framework中，提供了序列化器 对象Serialzier的定义，可以帮助我们简化序列化与反序列化的操作，还提供丰富的类视图，扩展类，视图集来简化视图的编写工作，REST_Framework还提供了认证，权限，限流，过滤，分页，接口文档等功能支持，REST_Framework提供了一个用于测试api接口的可视化web页面，可以游览器直接访问接口

restful就是一个接口开发的规范，不局限于django或者drf，即使不使用drf，也能实现符合restful规范的api接口

特点：

• 提供了定义序列化器serializer的方法可以快速根据 Django ORM或者其他库自动序列化或反序列化
• 提供了丰富的类视图、Mixin扩展类，简化视图的编写
• 丰富的定制层级，函数视图、类视图、视图集合到自动生成API,满足各种需求
• 多种身份认证和权限认证方式的支持 jwt json web token
• 内置限流系统
• 直观的API web 界面，方便调试
• 可扩展性，插件丰富

文档链接：

https://q1mi.github.io/Django-REST-framework-documentation/#django-rest-framework

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

drf框架执行流程：

环境安装依赖：

drf是以django扩展应用的方式提供的，所以可以直接利用已有的django环境无需重新创建，如果没有django环境就要先创建django

python （2.7，3.2以上）

Django （1.10，1.11，2.0以上）

# mkvirtualenv drfdemo -p python3 
#创建虚拟环境
#pip install django==2.2.0 -i https://pypi.douban.com/simple
# 安装django
pip install djangorestframework -i https://pypi.douban.com/simple
#安装djangorestframework
pip install pymysql -i https://pypi.douban.com/simple

添加rest_framework应用

在setting.py中的INSTALLED_APPS中注册”rest_framework”,把drf框架注册到Django项目中

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

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

体验drf完全简写代码过程

• 在django下创建子应用
  python manage.py startapp students
• 创建模型操作类
  子应用的models.py文件中创建模型对象
  执行数据迁移（注意准备步骤，注册app,设置操作数据库驱动pymysql，setting中配置数据库信息） ```python from django.db import models

创建一个模型类

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

-  创建序列化器<br />在students应用目录中新建serializers.py用于保存该应用的序列化器<br />创建一个StudentModelSerializer用于序列化和反序列化  
```python
#创建序列化器，在视图中调用该类
from rest_framework import serializers
from .models import Student
class StudentModelSerializer(serializers.ModelSerializer):
    #创建一个学生信息的序列化器 类
    #模型序列化器相关声明
    class Meta:
        model = Student
        fields ="all"
# model 指明该序列化器处理的数据字段从模型类studnet生成
# fields 指明该序列化器包含模型类中的哪些字段，all代表包含所有

• 编写视图
  在students应用的views.py中创建视图 StudentsViewSet，这是一个视图集合
  ```python from rest_framework.viewsets import ModelViewSet from .models import Student from .serializers import StudentModelSerializer

class StudentViewSet(ModelViewSet): queryset = Student.object.all() serializer_class = StudentModelSerializer

queryset 指明该视图集在查询数据时使用的数据集

serializer_class 指明该视图在进行序列化或者反序列化时使用的序列化器

-  定义路由<br />在students应用的urls.py中定义路由信息  
```python
from . import views
from django.urls import path.re_path
from rest_framework.routers import DefaultRouter
#路由列表
urlpatterns = []
#可以处理视图的路由器
router = DefaultRouter() 
#向路由器中注册视图集
router.register('studnets',views.StudnetviewSet)
#将路由器中的所有路由信息追加到django的路由列表中
urlpatterns += router.urls

• 网页访问应用

序列化器-Serializer

• 序列化，序列化器会把模型对象转换成字典，将来提供给视图经过response以后变成json字符串
• 反序列化，把客户端发送过来的数据，经过视图调用request以后变成python字典，序列化器可以把字典转换成模型
• 反序列化，完成数据校验功能和操作数据库
• serializer不是只能为数据库模型定义类，也可以为非数据库模型类的数据定义，serializer是独立于数据库之外的存在

序列化器使用阶段：

1. 在客户端请求的时候，使用序列化器可以完成对数据的反序列化
2. 在服务端响应时，使用序列化器可以完成对数据的序列化

序列化器支持的数据格式：

选项参数：

通用参数：

定义序列化器

django REST framework 中的Serializer使用类来定义，必须继承rest_framework.serializers.Serializer

1.在应用中新建 serializers.py文件 用来存放序列化器类 
import rest_framework import serializers
class StudentSerializer(serializers.Serializer):
    #需要进行转换的字段，都写在该类中，接收来自模型的数据进行转换，模型中的name字段转换成CharField格式
    name = serializers.CharField()
2.在视图中创建类
from django.views import View
from serializers import StudentSerializer #引入写的序列化器类
from django.http.response import HttpResponse
from students.models import Student #引入写的模型类，用于查询数据，传给序列化器
from django.http.response import JsonResponse
class StudentView(View):
    def get(self,request):
        #根据模型类获取所有的数据，也可以获取某条数据
        student_list = Student.objects.all()
        #实例化序列化器，创建序列化器对象
        serializer = StudentSerializer（instance=student_list,data=,context=,many=True）
        #instance 模型对象或者模型列表
        #data 进行反序列化阶段使用的数据，数据来自于客户端的提交
        #context 当需要从视图中转发数据到序列化器时，可以使用
        #many 当instance参数为模型列表时，则many值必须为True，表示传递的参数是多个
        print(serializer.data)
        转换后的数据放在序列化器对象.data中
        #【0rderedDict([(name:XXX)]),0rderedDict([(name:ccc)])】
        #0rderedDict python内置的高级数据类型，有序字典
        # from collection import 0rderedDict
        print(student_list)
        #<QuerySet [<studnet:xxx>,<Studnet:ccc>]>
        return JsonResponse(serializer.data,safe=False)
        #JsonResponse不识别列表，所以加上safe=False

创建Serializer对象

定义好Serializer类后，就可以创建Serializer对象了。

Serializer的构造方法为：

Serializer(instance=None, data=empty, **kwarg)

说明：

• 用于序列化时，将模型类对象传入instance参数
• 用于反序列化时，将要被反序列化的数据传入data参数
• 除了instance和data参数外，在构造Serializer对象时，还可通过context参数额外添加数据，如

serializer = AccountSerializer(account, context={'request': request})

通过context参数附加的数据，可以通过Serializer对象的context属性获取。

• 使用序列化器的时候一定要注意，序列化器声明了以后，不会自动执行，需要我们在视图中进行调用才可以。
• 序列化器无法直接接收数据，需要我们在视图中创建序列化器对象时把使用的数据传递过来。
• 序列化器的字段声明类似于我们前面使用过的表单系统。
• 开发restful api时，序列化器会帮我们把模型数据转换成字典.
• drf提供的视图会帮我们把字典转换成json,或者把客户端发送过来的数据转换字典.

序列化-基本使用

1） 先查询出一个学生对象

from students.models import Student
student = Student.objects.get(id=3)

2） 构造序列化器对象

from .serializers import StudentSerializer
serializer = StudentSerializer(instance=student)

3）获取序列化数据

通过data属性可以获取序列化后的数据

serializer.data
# {'id': 4, 'name': '小张', 'age': 18, 'sex': True, 'description': '猴赛雷'}

序列化器进行反序列化验证数据

数据验证

开发中，用户的数据是不可信的

使用序列化器进行反序列化时，需要对数据进行验证后，才能获取成功的数据或保存成模型类对象

在获取反序列化的客户端数据前，必须在视图中调用序列化对象的is_valid()方法，序列化器内部是在is_valid方法内部调用验证选项和验证方法进行验证，验证成功返回True,否在返回False

验证失败，可以通过序列化器对象的errors属性获取错误信息，返回字典，包含了字段和字段的错误提示，如果是非字段错误，可以通过修改REST Farmework配置中的NON_FIELD_ERRORS_KEY来控制错误字典中的键名

验证成功，可以通过序列化器对象的validated_data属性获取数据

在定义序列化器时，指明每个字段的序列化类型和选项参数，本身就是一种验证行为

反序列化验证数据案例

客户端传数据过来使用反序列化对数据进行验证

• 创建新的子应用
• 创建反序列化器
  ```python 在子应用的目录下新建：serializers.py文件

from rest_framework import serializers

字段验证函数 只能验证一个字段数据

def check_class_num(data): if data ==”404”: raise serializers.ValidationError(“没有404的班级”) return data

class StudentSerializer(serializers.Serializer): name = serializers.CharField(max_length=20,required=True)

#定义的规则检测name是否是字符串类型，并且最大长度20，是必填项，字段内置验证
age = serializers.IntegerField(max_value=100,)
sex = serializers.BooleanField(allow_null=True,default=1)
#validators=[check_class_num]，是使用字段验证函数对该字段进行验证
class_num = serializers.CharField(required=True,validators=[check_class_num])
description = serializers.CharField(allow_null=True,allow_blank=True)
#字段验证方法 :validate() 验证所有字段，validate_字段名()验证单个字段,字段名必须是上面定义的名字
def validate_name(self,attrs):
    if attrs =="王"：
        #抛出错误
        raise serializers.ValidationError("错误信息")    
    #每次验证完成以后，必须要返回数据，返回的就是传过来的数据，当然可以修改后返回，不返回会数据丢失
    return attrs
def validate(self,attrs):
    #attrs接收的是，视图中实例化序列化器对象的时候传入的数据，此案例中是data
    if attrs.get("age") >60 and attrs.get('sex')==1:
        raise serializers.ValidationError("错误信息")    
    return attrs

单个字段的校验优先级比多个字段的优先级高

“”” 视图中的序列化器对象在传递数据的时候 ，必填字段是必须传递的也就是我们定义的规则中有required=True的必须传，否则会抛出验证异常，我们可以使用partial参数来允许部分字段的更新,

如： 在视图中实例化序列化器对象的时候添加该参数： serializer = StudentSerializer(studnet,data,partial=True) partial=True 是设置序列化器只针对客户端提交的字段进行验证，没有提交的字段即使有验证选项和方法也不进行验证，客户端没提交的那些就默认通过，当然数据库中的字段规则设置也要是允许该字段为空否则会报错

“””

在视图文件中编写类：

from django.Views import View from django.http.response import HttpResponse

class StudentView(View): def post(self,request): print(request.body) import json data = json.loads(request.body)

    #反序列化
    #1.实例化序列化器对象
    serialiser = StudentSerializer(data = data)
    #2.调用验证方法，验证客户端传来的数据和序列化器类中的定义规则是否符合，通过返回True,失败返回False,raise_exception=True是指如果验证失败，以后的代码就不执行了，直接抛出错误
    """
    is_valid实际上内部执行了三种不同的验证方式
    1.先执行字段内置的验证选项
    2.再执行字段验证函数
    3.最后执行validate自定义验证方法，包括validate_字段，validate
    """
    ret = serializer.is_valid(raise_exception=True)
    #验证成功后，将通过验证的信息存放在validated_data中
    serializer.validated_data
    #验证失败的错误信息存在
    serializer.errors
    return HttpResponse("OK")

<a name="9f7e9f84"></a>
#### 使用序列化器进行反序列化阶段操作数据库
数据保存
通过序列化器完成数据的更新或者添加，把视图中对于模型中的操作代码移出视图，放入序列化器
前面的验证数据成功后，可以使用序列化器完成数据反序列化的过程，这个过程可以把数据转成模型类对象
可以通过create()和update()两个方法来实现，是定义在序列化器类中的,必须是create和update名
```python
''#序列化器文件中
from .models import Student
class StudentSerializer(serializers.Serializer):
    def create(self,validate_data):
        #添加数据
        #validate_data接收的是数据验证成功后传过来的数据，自动传的
        #models语法进行数据库的操作
        ret = Studnet.objects.create(
         **validated_data
        )
        return ret 
        #把添加的结果返回
        #接下来就可以在视图中使用 serializer.save(),会自动调用序列化器内的create()方法或者update()方法
    def update(self,instance,validated_data):
        #更新数据
        #instances是更新的模型是哪个，也就是models类是哪个,validated_data是更新的数据]
        #validated_data传递过来几个参数就要更新几个参数
        #validated_data是验证成后的数据，都是自动传参的
        instance.name = validated_data.get("name")
        instance.age = validated_data.get("age")
        #这是模型的save和序列化中的save是不一样的
        instance.save()
        return ret 
#视图文件中
from django.Views import View
from django.http.response import HttpResponse
class StudentView(View):
    def put(self,request):
        """修改数据"""
        import json
        data = json.loads(request.body)
        id = data.get('id')
        student = Student.objects.get(pk=id)
        #创建序列化器对象,此时数据是还没有更新的
        serializer = SudentSerializer(instance=student,data=data)
        serializer.is_valid(raise_exception=True)
        #会调用序列器的update方法，具体的更新在update方法中写
        #serializer.save()会根据我们是否传入instance来判断是调用create还是update，传入了instance则是updata，没传则是create
        serializer.save()
        """
        在对序列化器进行save保存时，可以传递额外的数据，这些数据可以在create()和update()中的validated_data中获取到
        如：
        request.user是django中记录当前登陆用户的模型对象
        serializer.save(owner=request.user)
        """

序列化器操作数据库附加参数说明

• 对序列化器进行save()保存时，可以额外传递数据，这些数据可以在create()和update()中的validated_data中获取到

可以传递任意参数到数据保存方法中
如：request.user 是django中记录当前登录用户的模型对象
serializer.save(owner=request.user)

• 默认序列化器必须传递所有必填字段[required=True]，否则会抛出异常验证，但是可以使用partial参数来允许部分字段更新

#update BookInfo with partial data
partial =True 设置序列化器只是针对客户端提交的字段进行验证，没有提交的字段，即使有验证选项或方法也不进行验证,设置此字段的时候要在模型类中定义的字段要允许字段为空，也就是定义的字段要有null=True
serializer = BookInfoSerializer(book,data=data,partial=True)

模型类的序列化器

如果我们想要使用的序列化器对应的是Django的模型类，DRF为我们提供了ModelSerializer模型类序列化器来帮助我们快速创建一个Serializer类

ModelSerializer与常规的Serializer相同，但是提供了

• 基于模型类自动生成一系列序列化器字段
• 基于模型类自动为Serializer生成validators，如unique_together
• 包含默认默认的create()和update()的实现

定义模型类序列化器

class BookInfoSerializer(serializers.ModelSerializer):
    #图书数据序列化器
    #也可以定义字段声明
    token = serializers.CharField(read_only=True,default='abc')
    #模型声明
    class Meta:
        model=BookInfo
        #调用模型所有字段
        fields = '__all__'
        #fields = ["id","name","age"]
        #read_only_fields表示设置模型中那些字段属于只读类型，对于不在模型中的字段无效
        read_only_fields=["id",'name']
        #添加额外的属性，相当于定义的字段声明
        extra_kwargs={
            'token':{'read_only':True},
            'age':{"min_value":1."max_value":100}
        }
"""
model 指明参考那个模型类
fields 指明为模型类的那些字段生成
"""

指定字段

• 使用fields来明确字段，__all__表名包含所有字段，也可以写明具体哪些字段，如

class BookInfoSerializer(serializers.ModelSerializer):
    """图书数据序列化器"""
    class Meta:
        model = BookInfo
        fields = ('id', 'btitle', 'bpub_date')

• 使用exclude可以明确排除掉哪些字段

class BookInfoSerializer(serializers.ModelSerializer):
    """图书数据序列化器"""
    class Meta:
        model = BookInfo
        exclude = ('image',)

• 显示指明字段，如：

class HeroInfoSerializer(serializers.ModelSerializer):
    hbook = BookInfoSerializer()
    class Meta:
        model = HeroInfo
        fields = ('id', 'hname', 'hgender', 'hcomment', 'hbook')

• 指明只读字段

可以通过read_only_fields指明只读字段，即仅用于序列化输出的字段

class BookInfoSerializer(serializers.ModelSerializer):
    """图书数据序列化器"""
    class Meta:
        model = BookInfo
        fields = ('id', 'btitle', 'bpub_date'， 'bread', 'bcomment')
        read_only_fields = ('id', 'bread', 'bcomment')

添加额外参数

我们可以使用extra_kwargs参数为ModelSerializer添加或修改原有的选项参数

class BookInfoSerializer(serializers.ModelSerializer):
    """图书数据序列化器"""
    class Meta:
        model = BookInfo
        fields = ('id', 'btitle', 'bpub_date', 'bread', 'bcomment')
        extra_kwargs = {
            'bread': {'min_value': 0, 'required': True},
            'bcomment': {'min_value': 0, 'required': True},
        }
# BookInfoSerializer():
#    id = IntegerField(label='ID', read_only=True)
#    btitle = CharField(label='名称', max_length=20)
#    bpub_date = DateField(allow_null=True, label='发布日期', required=False)
#    bread = IntegerField(label='阅读量', max_value=2147483647, min_value=0, required=True)
#    bcomment = IntegerField(label='评论量', max_value=2147483647, min_value=0, required=True)

http请求与响应

drf除了在数据序列化部分简写代码以外，还在试图中提供了简写操作，所以在django原有的django.views.View类基础上，drf封装了多个视图子类提供使用

Django REST Framework提供的试图的主要作用：

• 控制序列化器的执行（检验，保存，转换数据）
• 控制数据库查询的执行
• 调用请求类和响应类，这两个类也是由drf帮我们再次扩展了一些功能类。

Request

rest_framework.request.Request

REST Framework传入视图的request对象不再是Django默认的HTTP Request对象，而是在REST Framework提供的扩展了HTTP Request类的Request类的对象，在drf中原生的django的http请求对象，通过request._request调用

REST Framework提供了Parser解析器，在接受请求后会自动根据Content-Type指明的请求数据类型如json 表单等将请求数据进行parse解析，解析为Query Dict对象保存到Request对象中

Request对象的数据是自动根据前端发送数据的格式进行解析之后的结构

无论前端发生的是哪一种数据格式，我们都可以统一的方式读取数据

常用属性

• .data

request.data返回解析之后的请求体数据，类似于django中标准的request.POST和request.FIELS属性，但是提供如下特性。

1. 包含了解析之后的文件和非文件数据
2. 包含了对POST PUT PATCH请求方式解析后的数据
3. 利用了REST Framework的parse解析器，不仅支持表单类型数据，也支持json数据
4. 相当于drf的request.data替代了 django的request.POST，request.FILES，request.body、

• .query_params

request.query_params返回解析之后的查询字符串数据，是字典形式的 query dict,字典形式的我们可以使用.get()和.getlist()进行取值，如：一个键名重复出现多次的时候 get只能查出最后一个值 getlist可以获取所有的值是一个列表

request.query_params.get(“字典中的键”)

request.query_params.getlist(“字典中的键”)

request.query_params与Django原生的request.GET相同，只是更换了更正确的名称而已。

Response

rest_framework.response.Response

REST framework 提供了一个响应类Response，使用该类构造响应对象时，响应的具体数据内容会被转换（renderer渲染器）成符合前端需求的类型

REST framework 提供了Renderer渲染器，用来根据请求头中的Accept(接受数据类型声明)来自动转换响应数据到对应格式，如果前端请求中未生名Accept,则会采用默认的方式处理响应数据，可以通过配置来修改默认响应格式[就是Renderer能通过请求中的Accept查询出客户端支持和希望的数据类型，把视图的结果以客户端能识别的格式返回]

可以在rest_framework.settings.py查找所有的drf默认配置项

REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES': (  # 默认响应渲染类
        'rest_framework.renderers.JSONRenderer',  # json渲染器
        'rest_framework.renderers.BrowsableAPIRenderer',  # 浏览器API渲染器
    )
}

构造方式

Response(data, status=None, template_name=None, headers=None, content_type=None)
"""
data数据不是要renderer处理后的数据，只传递python的内置类型数据就可以，REST Framework 会使用renderer渲染器处理data
data不能是复杂的数据结构，如Django的模型类对象，对于这样的数据可以使用Serializer序列化器进行序列化后，再传递给data
参数说明
data 为响应准备的序列化处理后的数据
status 状态码默认是200
template_name 模板名称 如果使用HTMLRenderer 时需指明
headers 存放响应头信息的字典
content_type 响应数据的Content-Type，通常此参数无需传递，REST framework会根据前端所需类型数据来设置该参数。
"""
from rest_framework .Views import APIView
from rest_framework .response import Response
class StudentAPIView(APIView):
    def get(self,request):
        response = Response("ok")
        #设置cookie
        response.set_cookie("username","li")
        #设置响应头信息
        response['comm']='oldhy'
        return response
#使用 rest_framework .response.Response的视图必须继承APIView，否则无法实现相应的效果

常用属性

• .data

传给response对象的序列化后，但尚未render处理的数据

• .status_code

状态码的数字

• .content

经过renderer处理后的响应数据

状态码

方便设置状态码，REST framewrok在rest_framework.status模块中提供了常用状态码常量。

• 信息告知 - 1xx

HTTP_100_CONTINUE
HTTP_101_SWITCHING_PROTOCOLS

• 成功 - 2xx

HTTP_200_OK
HTTP_201_CREATED
HTTP_202_ACCEPTED
HTTP_203_NON_AUTHORITATIVE_INFORMATION
HTTP_204_NO_CONTENT
HTTP_205_RESET_CONTENT
HTTP_206_PARTIAL_CONTENT
HTTP_207_MULTI_STATUS

• 重定向 - 3xx

HTTP_300_MULTIPLE_CHOICES
HTTP_301_MOVED_PERMANENTLY
HTTP_302_FOUND
HTTP_303_SEE_OTHER
HTTP_304_NOT_MODIFIED
HTTP_305_USE_PROXY
HTTP_306_RESERVED
HTTP_307_TEMPORARY_REDIRECT

• 客户端错误 - 4xx

HTTP_400_BAD_REQUEST
HTTP_401_UNAUTHORIZED
HTTP_402_PAYMENT_REQUIRED
HTTP_403_FORBIDDEN
HTTP_404_NOT_FOUND
HTTP_405_METHOD_NOT_ALLOWED
HTTP_406_NOT_ACCEPTABLE
HTTP_407_PROXY_AUTHENTICATION_REQUIRED
HTTP_408_REQUEST_TIMEOUT
HTTP_409_CONFLICT
HTTP_410_GONE
HTTP_411_LENGTH_REQUIRED
HTTP_412_PRECONDITION_FAILED
HTTP_413_REQUEST_ENTITY_TOO_LARGE
HTTP_414_REQUEST_URI_TOO_LONG
HTTP_415_UNSUPPORTED_MEDIA_TYPE
HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE
HTTP_417_EXPECTATION_FAILED
HTTP_422_UNPROCESSABLE_ENTITY
HTTP_423_LOCKED
HTTP_424_FAILED_DEPENDENCY
HTTP_428_PRECONDITION_REQUIRED
HTTP_429_TOO_MANY_REQUESTS
HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE
HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS

• 服务器错误 - 5xx

HTTP_500_INTERNAL_SERVER_ERROR
HTTP_501_NOT_IMPLEMENTED
HTTP_502_BAD_GATEWAY
HTTP_503_SERVICE_UNAVAILABLE
HTTP_504_GATEWAY_TIMEOUT
HTTP_505_HTTP_VERSION_NOT_SUPPORTED
HTTP_507_INSUFFICIENT_STORAGE
HTTP_511_NETWORK_AUTHENTICATION_REQUIRED

http请求响应状态码使用案例

1.新建Django项目创建app
2.注册路由 注册应用
3. 在试图文件中编写代码
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status
class Student1APIView(APIView):
    def get(self,request):
        #使用Response进行返回数据
        response = Response("ok")
        #设置cookie
        response.set_cookie("username","li")
        #设置响应头信息
        response['comm']='oldhy'
        return response
    def get(self,request):
        #使用request提取数据
        data = request.data
        new_data = request.query_params.get("用户传过来的数据字典形式的键")
        #使用Response返回状态码
        return Response(status=status.HTTP_201_CREATED)

drf 视图

Django REST Framework 提供的视图的主要作用有：

• 控制序列化器的执行 （检验 保存 转换数据）
• 控制数据库查询的执行（数据库的删除 查询代码写在视图中 更新和添加写在序列化器中）

REST Framework 提供了众多的通用视图基类与扩展类，用来简化视图的编写

基类

APIView

rest_framework.views.APIView

APIView是REST Framework提供的所有视图的基类，继承自Django的View父类

drf的APIView在继承django view的基础上新增了

• 传入到视图方法中的是REST Framework的Request对象，而不是Django的HttpRequest对象
• 视图方法可以返回REST Framework 的Response对象，视图会为响应数据设置（render）符合前端要求的格式
• 任何APIException异常都会被捕获到，并且处理成合适的响应信息
• 重写了as_view()，在进行dispatch()路由分发前，会对http请求进行身份认证 权限检查 访问流量控制

支持定义的类属性

• authentication_classes 列表或者元组 ，身份认证类
• permissoin_classes 列表或元组 权限检查类
• throttle_classes 列表或元组 流量控制类

在APIView中仍以常规的类视图定义方法实现get() post()或者其他请求的方法

举例：
# Create your views here.
"""APIView是drf里面提供的所有视图类的父类
   APIView提供的功能/属性/方法是最少的,所以使用APIView基本类似我们使用django的View
"""
"""
GET   /students/ 获取多个学生信息
POST  /students/ 添加一个学生信息
GET    /students/<pk>/  获取一个学生信息 
PUT    /students/<pk>/  修改一个学生信息
DELETE /students/<pk>/  删除一个学生信息
"""
from rest_framework.views import APIView
from students.models import Student
from .serializers import StudentModelSerializer
from rest_framework.response import Response
from rest_framework import status
class Student1APIView(APIView):
    def get(self,request):
        """获取所有学生信息"""
        # 1. 获取学生信息的数据模型
        student_list = Student.objects.all()
        # 2. 调用序列化器
        serializer = StudentModelSerializer(instance=student_list, many=True)
        # 3. 返回数据
        return Response(serializer.data)
    def post(self,request):
        """添加一个学生信息"""
        # 1. 调用序列化器对用户提交的数据进行验证
        serializer = StudentModelSerializer(data=request.data)
        serializer.is_valid(raise_exception=True)
        # 2. 调用序列化器进行数据库操作
        instance = serializer.save() # save()方法返回的是添加成功以后的模型对象
        serializer = StudentModelSerializer(instance=instance)
        # 3. 返回新增数据
        return Response(serializer.data, status=status.HTTP_201_CREATED)
class Student2APIView(APIView):
    def get(self,request,pk):
        """获取一个学生信息"""
        # 1. 根据pk获取模型对象
        student = Student.objects.get(pk=pk)
        # 2. 序列化器转换数据
        serializer = StudentModelSerializer(instance=student)
        # 3. 响应数据
        return Response(serializer.data)
    def put(self,request,pk):
        """修改一个学生信息"""
        # 1. 通过pk查询学生信息
        student = Student.objects.get(pk=pk)
        # 3. 调用序列化器对客户端发送过来的数据进行验证
        serializer = StudentModelSerializer(instance=student, data=request.data)
        serializer.is_valid(raise_exception=True)
        # 4. 保存数据
        instance = serializer.save() #?这里实际上调用的序列化器里面的update方法
        serializer = StudentModelSerializer(instance=instance)
        # 5. 返回结果
        return Response(serializer.data, status=status.HTTP_201_CREATED)
    def delete(self, request, pk):
        # 1. 通过pk查询学生信息
        Student.objects.get(pk=pk).delete()
        return Response({"message":"ok"}, status=status.HTTP_204_NO_CONTENT)
#路由分发
urlpatterns = [
    path('asview', 视图中的类名.as_view())
]
as_view()可以根据客户端的请求方法自动去视图中的类去匹配相应的方法名，并执行该方法，如客户端使用的get方法进行请求，则匹配到的是视图类中的get方法

GenericAPIView

通过视图类主要作用就是把视图中独特的代码抽取出来，让视图方法中的代码更加通用，方便把通用代码进行简写

rest_framework.generics.GenericAPIView

继承自APIView，主要增加操作序列化器和数据库查询的方法，作用是为下面Mixin扩展类的执行提供方法支持，通常在使用时可以搭配一个或多个Minxin扩展类

GenericAPIView类提供的关于序列化器使用的属性与方法

• serializer_class 属性

指明视图使用的序列化器是哪一个

• get_serializer_class(self)方法

当出现一个类视图中调用多个序列化器时候，可以通过条件判断在get_serializer_class方法中返回不同序列化器的类名，就可以让视图方法执行不同的序列化器对象了

返回序列化器类，默认返回的是serializer_class可以重写get_serializer_class(self)方法

如：

def get_serializer_class(self):
    if self.request.method == 'get':
        return getSerializer
    return postSerializer

• get_serializer(self,args,*kwargs)方法

返回值是序列化器对象，就是返回get_serializer_class中返回的那个序列化器对象，主要用来提供给Mixin扩展类使用，如果我们在视图中想要获取序列化器对象，可以直接调用该方法

注意，该方法在提供序列化器对象的时候，会向序列化器对象的context属性补充三个数据：request,format,view这个三个数据对象可以在定义序列化器时使用

requets: 当前视图的请求对象

view:当前请求的类视图对象

format:当前请求期望返回的数据格式

GenericAPIView类提供的关于数据库查询的属性与方法

• query_set属性

指明使用的数据查询集合

• get_queryset(self)方法

返回视图使用的查询集，主要用来提供给Mixin扩展类使用，是列表视图与详情视图获取数据的基础，默认返回queryset属性，可以重写。

如：

def get_queryset(self):
    user = self.request.user
    return user.accounts.all()

• get_object(self)方法

返回单个视图模型类对象，主要是用来给Mixin扩展类使用

在视图中可以调用该方法获取单条详情信息的模型类对象

如详情信息的模型类对象不在会返回404

该方法会默认使用APIView提供的check_object_permissions方法检查当前对象是否有权限被访问

如：

# url(r'^books/(?P<pk>\d+)/$', views.BookDetailView.as_view()),
class BookDetailView(GenericAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer
    def get(self, request, pk):
        book = self.get_object() # get_object()方法根据pk参数查找queryset中的数据对象
        serializer = self.get_serializer(book)
        return Response(serializer.data)

• pagination_class属性

指明分页控制类

• fiter_backends属性

指明过滤控制后端

GenericAPIView属性方法案例

案例1：
from rest_framework.response import Response
from rest_framework import status
from rest_framework.generics import GenericAPIView
from students.models import Student
from students.serializers import StudentModelSerializer,Student2ModelSerializer
class Student1APIView(GenericAPIView):
    # 用于指定当前视图类中使用的默认序列化器
    serializer_class = StudentModelSerializer
    # 用于指定当前视图类中使用的数据集
    queryset = Student.objects.all()
    # get_serializer_class 这个方法主要的作用就是提供给开发者需要在同一个视图类中调用多个序列化器时进行重写时使用的.
    def get_serializer_class(self):
        if self.request.method.lower() == "get":
            return Student2ModelSerializer
        else:
            return StudentModelSerializer
    def get(self,request):
        """获取多条"""
        # serializer = self.serializer_class(instance=self.queryset.all(),many=True)
        serializer = self.get_serializer(instance=self.get_queryset(),many=True)
        return Response(serializer.data)
    def post(self,request):
        """添加信息"""
        serialzier = self.get_serializer(data=request.data,context={})
        serialzier.is_valid(raise_exception=True)
        serialzier.save()
        return Response(serialzier.data)
class Student2APIView(GenericAPIView):
    serializer_class = StudentModelSerializer
    # 面向对象中, 类属性的值不能出现变量赋值的情况,一定要具体的代码逻辑或者具体值
    queryset = Student.objects.all()
    def get(self,request,pk):
        """获取一条数据"""
        # serializer = self.serializer_class(instance=self.queryset.get(pk=pk))
        serializer = self.get_serializer(instance=self.get_object())
        return Response(serializer.data)
    def put(self,request,pk):
        serializer = self.get_serializer(instance=self.get_object(), data=request.data)
        serializer.is_valid(raise_exception=True)
        serializer.save()
        return Response(serializer.data)
    def delete(self,request,pk):
        self.get_object().delete()
        return Response(status=status.HTTP_204_NO_CONTENT)

案例2：
from rest_framework.generics import GenericAPIView
from students.models import Student
from .serializers import StudentModelSerializer, StudentModel2Serializer
from rest_framework.response import Response
class StudentsGenericAPIView(GenericAPIView):
    # 本次视图类中要操作的数据[必填]，就是模型类查询出的数据
    queryset = Student.objects.all()
    # 本次视图类中要调用的默认序列化器[选填],当类继承GenericAPIView的时候必须声明serializer_class
    serializer_class = StudentModelSerializer
    def get(self, request):
        """获取所有学生信息"""
        serializer = self.get_serializer(instance=self.get_queryset(), many=True)
        return Response(serializer.data)
    def post(self,request):
        data = request.data
        serializer = self.get_serializer(data=data)
        serializer.is_valid(raise_exception=True)
        instance = serializer.save()
        serializer = self.get_serializer(instance=instance)
        return Response(serializer.data)
class StudentGenericAPIView(GenericAPIView):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer
    def get_serializer_class(self):
        """重写获取序列化器类的方法"""
        if self.request.method == "GET":
            return StudentModel2Serializer
        else:
            return StudentModelSerializer
    # 在使用GenericAPIView视图获取或操作单个数据时,视图方法中的代表主键的参数最好是pk
    def get(self,request,pk):
        """获取一条数据"""
        serializer = self.get_serializer(instance=self.get_object())
        return Response(serializer.data)
    def put(self,request,pk):
        data = request.data
        serializer = self.get_serializer(instance=self.get_object(),data=data)
        serializer.is_valid(raise_exception=True)
        serializer.save()
        serializer = self.get_serializer(instance=self.get_object())
        return Response(serializer.data)
序列化器类：
from rest_framework import serializers
from students.models import Student
class StudentModelSerializer(serializers.ModelSerializer):
    class Meta:
        model= Student
        fields = "__all__"
class StudentModel2Serializer(serializers.ModelSerializer):
    class Meta:
        model= Student
        fields = ("name","class_null")

扩展类

• ListModeMixin

列表视图扩展类，提供了list(request,args,*kwargs)方法快速实现列表视图，返回200状态码

该Mixin的list方法会对数据进行过滤和分页

源代码：

class ListModelMixin(object):
    """
    List a queryset.
    """
    def list(self, request, *args, **kwargs):
        # 过滤
        queryset = self.filter_queryset(self.get_queryset())
        # 分页
        page = self.paginate_queryset(queryset)
        if page is not None:
            serializer = self.get_serializer(page, many=True)
            return self.get_paginated_response(serializer.data)
        # 序列化
        serializer = self.get_serializer(queryset, many=True)
        return Response(serializer.data)

案例：

from rest_framework.mixins import ListModelMixin
class BookListView(ListModelMixin, GenericAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer
    def get(self, request):
        #提供的list方法
        return self.list(request)

• CreateModelMixin

创建视图扩展类，提供create(request,args,*kwargs)方法快速实现创建资源的视图，成功返回201状态码

如果序列化器对前端发送的数据验证失败，返回400错误

源码：

class CreateModelMixin(object):
    """
    Create a model instance.
    """
    def create(self, request, *args, **kwargs):
        # 获取序列化器
        serializer = self.get_serializer(data=request.data)
        # 验证
        serializer.is_valid(raise_exception=True)
        # 保存
        self.perform_create(serializer)
        headers = self.get_success_headers(serializer.data)
        return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)
    def perform_create(self, serializer):
        serializer.save()
    def get_success_headers(self, data):
        try:
            return {'Location': str(data[api_settings.URL_FIELD_NAME])}
        except (TypeError, KeyError):
            return {}

案例：

class BookDetailView(RetrieveModelMixin, GenericAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer
    def post(self, request):
        return self.create(request)

• RetrieveModelMixin

详情视图扩展类，提供retrieve(request,args,*kwargs)方法可以快速实现返回一个存在的数据对象

如果存在，返回200，否则返回404

源码：

class RetrieveModelMixin(object):
    """
    Retrieve a model instance.
    """
    def retrieve(self, request, *args, **kwargs):
        # 获取对象，会检查对象的权限
        instance = self.get_object()
        # 序列化
        serializer = self.get_serializer(instance)
        return Response(serializer.data)

案例：

class BookDetailView(RetrieveModelMixin, GenericAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer
    def get(self, request, pk):
        return self.retrieve(request)

• UpdateModelMixin

更新视图扩展类，提供update(request,args,*kwargs)方法，可以快速实现更新一个存在的数据对象

同时也提供partial_update(request,args,*kwargs)方法，可以实现局部更新

成功返回200，序列化器校验数据失败时，返回400错误

源码：

class UpdateModelMixin(object):
    """
    Update a model instance.
    """
    def update(self, request, *args, **kwargs):
        partial = kwargs.pop('partial', False)
        instance = self.get_object()
        serializer = self.get_serializer(instance, data=request.data, partial=partial)
        serializer.is_valid(raise_exception=True)
        self.perform_update(serializer)
        if getattr(instance, '_prefetched_objects_cache', None):
            # If 'prefetch_related' has been applied to a queryset, we need to
            # forcibly invalidate the prefetch cache on the instance.
            instance._prefetched_objects_cache = {}
        return Response(serializer.data)
    def perform_update(self, serializer):
        serializer.save()
    def partial_update(self, request, *args, **kwargs):
        kwargs['partial'] = True
        return self.update(request, *args, **kwargs)

案例：

class Student4APIView(UpdateModelMixin,GenericAPIView):
    serializer_class = StudentModelSerializer
    queryset = Student.objects.all()
    def put(self,request,pk):
        return self.update(request,pk)

• DestroyModelMixin

删除视图扩展类，提供destroy(request,args,*kwargs)方法，可以快速实现删除一个存在的数据对象

成功返回204 不存在返回404

源码：

class DestroyModelMixin(object):
    """
    Destroy a model instance.
    """
    def destroy(self, request, *args, **kwargs):
        instance = self.get_object()
        self.perform_destroy(instance)
        return Response(status=status.HTTP_204_NO_CONTENT)
    def perform_destroy(self, instance):
        instance.delete()

案例：

class Student4APIView(DestroyModelMixin,GenericAPIView):
    serializer_class = StudentModelSerializer
    queryset = Student.objects.all()
    def delete(self,request,pk):
        return self.destroy(request,pk)

扩展类综合案例：

"""GenericAPIView结合视图扩展类实现api接口"""
from rest_framework.mixins import ListModelMixin,CreateModelMixin
class Students2GenericAPIView(GenericAPIView,ListModelMixin,CreateModelMixin):
    # 本次视图类中要操作的数据[必填]
    queryset = Student.objects.all()
    # 本次视图类中要调用的默认序列化器[选填]
    serializer_class = StudentModelSerializer
    def get(self, request):
        """获取多个学生信息"""
        return self.list(request)
    def post(self,request):
        """添加学生信息"""
        return self.create(request)
from rest_framework.mixins import RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin
class Student2GenericAPIView(GenericAPIView,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer
    # 在使用GenericAPIView视图获取或操作单个数据时,视图方法中的代表主键的参数最好是pk
    def get(self,request,pk):
        """获取一条数据"""
        return self.retrieve(request,pk)
    def put(self,request,pk):
        """更新一条数据"""
        return self.update(request,pk)
    def delete(self,request,pk):
        """删除一条数据"""
        return self.destroy(request,pk)

GenericAPIView的视图子类

由视图扩展类和通用视图类还可以进行组合,产生新的视图这些视图子类,可以让我们开发基本的API接口变得更加简单

• CreateAPIView

提供post方法

继承自 GenericAPIView、CreateModelMixin

• ListAPIView

提供 get 方法

继承自：GenericAPIView、ListModelMixin

• RetrieveAPIView

提供 get 方法

继承自: GenericAPIView、RetrieveModelMixin

• DestoryAPIView

提供 delete 方法

继承自：GenericAPIView、DestoryModelMixin

• UpdateAPIView

提供 put 和 patch 方法

继承自：GenericAPIView、UpdateModelMixin

• RetrieveUpdateAPIView

提供 get、put、patch方法

继承自： GenericAPIView、RetrieveModelMixin、UpdateModelMixin

• RetrieveUpdateDestoryAPIView

提供 get、put、patch、delete方法

继承自：GenericAPIView、RetrieveModelMixin、UpdateModelMixin、DestoryModelMixin

案例 ：

视图文件中:
class Student6APIView(RetrieveUpdateDestroyAPIView):
    serializer_class = StudentModelSerializer
    queryset = Student.objects.all()
#在想使用哪些方法的时候直接继承该类就可以了，该类的基类中帮我们提供了处理代码，我们是需要使用就可以了，但是要指明使用的序列化器和处理的数据集

视图集VIewSet

为了让视图代码变得更加简短，drf提供了视图集，视图集允许开发者自定义类视图的方法名，还允许为一个类分配多个不同的路由，从而让操作同一个模型的视图方法写在一个视图类中

使用视图集ViewSet，可以将一系列逻辑相关的动作放到一个类中

• list()提供一组数据
• retrieve()提供单个数据
• create()创建数据
• update()保存数据
• destory()删除数据

ViewSet视图集类不再是get(),post()等方法，而是实现动作action 如：list(),create()等

视图集只在使用as_view()方法进行路由分发的时候，才会将action动作与具体请求方式对应上 ，就是将客户端的请求方法与视图类中的方法进行对应

如：

class BookInfoViewSet(viewsets.ViewSet):
    def list(self, request):
        books = BookInfo.objects.all()
        serializer = BookInfoSerializer(books, many=True)
        return Response(serializer.data)
    def retrieve(self, request, pk=None):
        try:
            books = BookInfo.objects.get(id=pk)
        except BookInfo.DoesNotExist:
            return Response(status=status.HTTP_404_NOT_FOUND)
        serializer = BookInfoSerializer(books)
        return Response(serializer.data)

在设置路由时，可以进行如下操作：

urlpatterns = [
    url(r'^books/$', BookInfoViewSet.as_view({'get':'list'}),#当客户端请求是get方法且路由可以匹配上，就去执行BookInfoViewSet视图类的list方法
    url(r'^books/(?P<pk>\d+)/$', BookInfoViewSet.as_view({'get': 'retrieve'})
]

常见的视图集父类

• ViewSet

继承自APIView 和 ViewSetMixin 作用也与APIView基本类似，提供了身份认证，权限校验，流量管理等

ViewSet主要通过继承ViewSetMixin来实现在调用as_view()时传入字典的映射来处理工作

在VIewSet中，没有提供任何动作 action方法，需要我们自己实现action方法，就是需要自己在视图类中写处理逻辑

• GenericViewSet

使用ViewSet通常并不方便，因为list、retrieve、create、update、destory等方法都需要自己编写，而这些方法与前面讲过的Mixin扩展类提供的方法同名，所以我们可以通过继承Mixin扩展类来复用这些方法而无需自己编写。但是Mixin扩展类依赖与GenericAPIView，所以还需要继承GenericAPIView。

GenericViewSet就帮助我们完成了这样的继承工作，继承自GenericAPIView与ViewSetMixin，在实现了调用as_view()时传入字典（如{'get':'list'}）的映射处理工作的同时，还提供了GenericAPIView提供的基础方法，可以直接搭配Mixin扩展类使用。

如：

from rest_framework.viewsets import GenericViewSet
from rest_framework.mixins import ListModelMixin,CreateModelMixin,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin
class 
Student4ViewSet(GenericViewSet,ListModelMixin,CreateModelMixin,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

url配置

urlpatterns = [
    path("students7/", views.Student4ViewSet.as_view({"get": "list", "post": "create"})),
    re_path("students7/(?P<pk>\d+)/", views.Student4ViewSet.as_view({"get": "retrieve","put":"update","delete":"destroy"})),
]

• ModelViewSet

继承自GenericViewSet，同时包括了ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestoryModelMixin。

• ReadOnlyModelViewSet

继承自GenericViewSet，同时包括了ListModelMixin、RetrieveModelMixin。

视图集中定义附加action动作

在视图集中，处理上述默认的方法动作外还可以添加自定义动作

如：

from rest_framework.viewsets import ModelViewSet,ReadOnlyModelViewSet
class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer
    def login(self,request):
        """学生登录功能"""
        return Response({"message":"登录成功"})

url配置

urlpatterns = [
    path("students8/", views.StudentModelViewSet.as_view({"get": "list", "post": "create"})),
    re_path("students8/(?P<pk>\d+)/",
            views.StudentModelViewSet.as_view({"get": "retrieve", "put": "update", "delete": "destroy"})),
    path("stu/login/",views.StudentModelViewSet.as_view({"get":"login"}))
]

action属性

在视图集中，我们可以通过action对象属性来获取当前请求视图集时的action动作是哪个。

如：

from rest_framework.viewsets import ModelViewSet
from students.models import Student
from .serializers import StudentModelSerializer
from rest_framework.response import Response
class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer
    def get_new_5(self,request):
        """获取最近添加的5个学生信息"""
        # 操作数据库
        print(self.action) # 获取本次请求的视图方法名
通过路由访问到当前方法中.可以看到本次的action就是请求的方法名

路由

对于视图集ViewSet我们除了可以自己手动指明请求方式与动作action之间的对应关系外，还可以使用Routers来帮助我们快速实现路由信息

REST Framework提供了两个router

• SimpleRouter
• DefaultRouter

使用方法

• 创建router对象 并注册视图集

URLS 文件中：
from rest_framework import routers
router = routers.DefaultRouter()
router.register(r'router_stu', StudentModelViewSet, base_name='student')
#
如上述代码会形成的路由如下
^router_stu/$    name: student-list
^router_stu/{pk}/$   name: student-detail

register(prefix, viewset, base_name)

prefix 该视图集的路由前缀

viewset 视图集

base_name 路由别名的前缀

• 添加路由数据

就是添加到路由列表中‘

urlpatterns = [
    ...
]
urlpatterns += router.urls
或
urlpatterns = [
    ...
    url(r'^', include(router.urls))
]
两种都可以

路由使用案例：

视图文件：
from rest_framework.viewsets import ModelViewSet,ReadOnlyModelViewSet
class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer
    def login(self,request):
        """学生登录功能"""
        print(self.action)
        return Response({"message":"登录成功"})
路由文件：
from django.urls import path, re_path
from . import views
urlpatterns = [
    ...
]
"""使用drf提供路由类router给视图集生成路由列表"""
# 实例化路由类
# drf提供一共提供了两个路由类给我们使用,他们用法一致,功能几乎一样
from rest_framework.routers import DefaultRouter
router = DefaultRouter()
# 注册视图集
# router.register("路由前缀",视图集类)
router.register("router_stu",views.StudentModelViewSet)
# 把生成的路由列表追加到urlpatterns
print( router.urls )
urlpatterns += router.urls

上面的代码就成功生成了路由地址[增/删/改/查一条/查多条的功能]，但是不会自动我们在视图集自定义方法的路由。

所以我们如果也要给自定义方法生成路由，则需要进行action动作的声明

视图集中附加action的声明

在视图集中，如果想要让Router自动帮助我们为自定义的动作生成路由信息，需要使用 rest_framework.decorators.action装饰器

以action装饰器装饰的方法名会作为action动作名，与list、retrieve等同。

action装饰器可以接收两个参数

• methods 声明该action对应的请求方式，列表传递
• detail

声明该action的路径是否与单一资源对应，就是是否可以携带pk值
xxx/<pk>/action方法名/
True 表示路径格式是xxx/<pk>/action方法名/
False 表示路径格式是xxx/action方法名/

如：

from rest_framework.viewsets import ModelViewSet
from rest_framework.decorators import action
class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer
    # methods 设置当前方法允许哪些http请求访问当前视图方法
    # detail 设置当前视图方法是否是操作一个数据
    # detail为True，表示路径名格式应该为 router_stu/{pk}/login/
    @action(methods=['get'], detail=True)
    def login(self, request,pk):
        """登录"""
        ...
    # detail为False 表示路径名格式应该为 router_stu/get_new_5/
    @action(methods=['put'], detail=False)
    def get_new_5(self, request):
        """获取最新添加的5个学生信息"""
#路由生成的信息如下：
^router_stu/get_new_5/$    name: router_stu-get_new_5
^router_stu/{pk}/login/$   name: router_stu-login

路由router形成url的方式

SimpleRouter

DefaultRouter

DefaultRouter与SimpleRouter的区别是，DefaultRouter会多附带一个默认的API根视图，返回一个包含所有列表视图的超链接响应数据。

DRF框架常用的组件

认证Authentication

可以在配置文件中配置全局默认的认证方案

site-packages/rest_framework/settings.py

# 可以在项目的主应用的settings.py配置文件中加入以下配置覆盖全局默认的配置方案。
REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': (
        'rest_framework.authentication.SessionAuthentication',  # session认证
        'rest_framework.authentication.BasicAuthentication',    # 基本认证
    )
}

也可以在每个视图中通过设置authentication_classess类属性来设置

from rest_framework.authentication import SessionAuthentication, BasicAuthentication
from rest_framework.views import APIView
class ExampleView(APIView):
    # 类属性
    authentication_classes = [SessionAuthentication, BasicAuthentication]
    def get(self,request):
        pass

认证失败会有两种可能的返回值从，这个需要我们配合权限组件来使用

• 401 Unauthorized 未认证
• 403 Permission Denied 权限被禁止

权限 Permissions

权限控制可以根据用户对于视图的访问和对于具体数据对象的访问

• 在执行视图的as_view()方法的dispatch()方法前，会先进行视图访问权限的判断
• 在通过get_object()获取具体模型对象时，会进行模型对象访问权限的判断

提供的权限

AllowAny 允许所有用户
IsAuthenticates 仅通过登录认证的用户
IsAdminUser 仅管理员用户
IsAuthenticatedOrReadOnly 已经登录认证的用户可以对数据进行增删改查操作，没有登录认证的只能查看数据

可以在配置文件settings.py中全局设置默认的权限管理类：如：

# drf的配置信息，需要卸载django的配置文件，而且必须写在REST_FRAMEWORK的字典中，才能被drf识别
REST_FRAMEWORK = {
    ....
    #  权限[全局配置，所有的视图都会被影响到]
    'DEFAULT_PERMISSION_CLASSES': (
        'rest_framework.permissions.IsAuthenticated', # 已经登录认证的用户才能访问
    )
}

如果没有设置权限组件，默认使用的配置如下：

'DEFAULT_PERMISSION_CLASSES': (
   'rest_framework.permissions.AllowAny',
)

也可以在具体的视图中通过permission_classes属性来设置，如

from rest_framework.permissions import IsAuthenticated
from rest_framework.views import APIView
class ExampleView(APIView):
    permission_classes = (IsAuthenticated,)

认证和权限使用案例：

from rest_framework.authentication import SessionAuthentication
from rest_framework.permissions import IsAuthenticated
from rest_framework.generics import RetrieveAPIView
class StudentAPIView(RetrieveAPIView):
    queryset = Student.objects.all()
    serializer_class = StudentSerializer
    authentication_classes = [SessionAuthentication]
    permission_classes = [IsAuthenticated]

自定义权限

如果需要自定义权限，需继承rest_framework.permissions.BasePermission父类，并实现一下两个中的任何一个方法或全部方法。

• .has_permission(self,request,view)

是否可以访问视图，view表示当前视图对象

• .has_object_permission(self,request,view,obj)

是否可以访问数据对象，view表示当前视图，obj为模型类数据对象

如：

在当前子应用下，创建一个权限文件permissions.py中声明自定义权限类:
from rest_framework.permissions import BasePermission
class IsXiaoMingPermission(BasePermission):
    def has_permission(self, request, view):
        if request.user and request.user.username == "xiaoming":
            return True
视图文件：
from .permissions import IsXiaoMingPermission
class StudentViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentSerializer
    permission_classes = [IsXiaoMingPermission]

可选限流类

• AnonRateThrottle

限制所有匿名未认证用户，使用ip区分用户

使用 DEFAULT_THROTTLE_RATES[‘anon’]来设置频次

• UserRateThrottle

限制认证用户，使用user id来区分

使用 DEFAULT_THROTTLE_RATES[‘user’]来设置频次

• ScopedRateThrottle

限制用户对于每个视图的访问频次，使用ip或user id。

案例：

class ContactListView(APIView):
    throttle_scope = 'contacts'
    ...
class ContactDetailView(APIView):
    throttle_scope = 'contacts'
    ...
class UploadView(APIView):
    throttle_scope = 'uploads'
    ...
REST_FRAMEWORK = {
    'DEFAULT_THROTTLE_CLASSES': (
        'rest_framework.throttling.ScopedRateThrottle',
    ),
    'DEFAULT_THROTTLE_RATES': {
        'contacts': '1000/day',
        'uploads': '20/day'
    }
}

使用：

可以在配置文件中，使用DEFAULT_THROTTLE_CLASSES 和 DEFAULT_THROTTLE_RATES进行全局配置，

REST_FRAMEWORK = {
    'DEFAULT_THROTTLE_CLASSES': ( # 启用的限制类
        'rest_framework.throttling.AnonRateThrottle',
        'rest_framework.throttling.UserRateThrottle'
    ),
    'DEFAULT_THROTTLE_RATES': {   # 限制频率
        'anon': '100/day',
        'user': '1000/day'
    }
}

DEFAULT_THROTTLE_RATES 可以使用 second, minute, hour 或day来指明周期。

也可以在具体视图中通过throttle_classess属性来配置，如

from rest_framework.throttling import UserRateThrottle
from rest_framework.views import APIView
class ExampleView(APIView):
    throttle_classes = (UserRateThrottle,)