DRF入门¶

add_circle2025-03-05update2025-03-05

1. Web应用模式¶

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

前后端不分离[客户端看到的内容和所有界面效果都是由服务端提供出来的。

前后端分离【把前端的界面效果(html，css，js分离到另一个服务端或另一个目录下，python服务端只需要返回数据即可)】

前端形成一个独立的网站/独立的地址，服务端构成一个独立的网站

2. api接口¶

应用程序编程接口（Application Programming Interface，API接口），就是服务端应用程序对外界提供了一个操作数据的入口，这个入口可以是一个函数或类方法，也可以是一个url地址或者一个网络地址。当客户端调用这个入口，服务端应用程序则会执行对应代码操作，给客户端完成相对应的功能。

当然，api接口在工作中是比较常见的开发内容，有时候我们会调用其他人编写的api接口，有时候，我们也需要提供api接口给其他人操作。由此就会带来一个问题，api接口往往都是一个函数、类方法、或者url或其他网络地址，不断是哪一种，当api接口编写过程中，我们都要考虑一个问题就是这个接口应该怎么编写？接口怎么写的更加容易维护和清晰，这就需要大家在调用或者编写api接口的时候要有一个明确的编写规范！

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

目前市面上大部分公司开发人员使用的接口实现规范主要有：restful、RPC。

RPC（ Remote Procedure Call ）: 翻译成中文: 远程过程调用[远程服务调用]. 从字面上理解就是访问/调用远程服务端提供的api接口。这种接口一般以服务或者过程式代码提供。

服务端提供一个唯一的访问入口地址：http://api.xxx.com/ 或 http://www.xx.com/api
客户端请求服务端的时候，所有的操作都理解为动作(action)，如果是web开发时，对应的就是HTTP请求的post请求
通过请求体或查询字符串参数表达动作具体意义，指定要调用的接口名称和接口所需的参数

http://api.xxx.com/?action=getallstudent&class=301&sex=1

http://api.xxx.com/?method=create_student&sex=1&age=22

http://api.xxx.com/?command=100&sex=1&age=22

基本上现有rpc的数据传输格式：protobuf（go语言的gRPC框架）、json、xml

RPC的优点很明显，因为是单一入口，所以容易实现一些垂直业务，类似权限，限流，同时因为rpc直接通过请求体或查询参数直接表达对服务端的操作，所以相对比较直观，一目了然，而且因为函数名都是开发者自定义的，所以非常灵活。但是rpc的缺点也很明显，当RPC接口多了，对应函数名和参数也就多了，客户端在请求服务端的api接口时就比较难找，对于年代久远的rpc服务端的代码也容易出现重复的接口。

restful: 翻译成中文: 资源状态转换(表征性状态转移)

把服务端提供的所有的数据/文件都看成资源，而资源在服务端存储过程中往往使用了不同的外观图标或不同的文件扩展名，所以这些资源的外观特征也称之为资源的表征性，那么客户端通过api接口请求服务端进行数据操作，本质上来说就是对服务端的资源的操作了，而客户端对服务端的资源操作一般都多种不同的行为，例如添加、删除或修改一个资源，这种情况对于资源来说，就是状态的转换。

restful中要求，我们把当前接口对外提供哪种资源进行操作，就把资源的名称写在url地址。资源都是名词，例如数据表名，例如文件名。

http://api.xxx.com/students/

http://api.xxx.com/avatars/

web开发中操作资源，最常见的最通用的无非就是增删查改，所以restful要求在地址栏中声明要操作的资源是什么。然后通过http请求方法来说明对该资源进行哪一种操作。

HTTP请求方法	api接口地址	描述
POST	`http://www.xxx.com/api/students/`	添加学生数据
GET	`http://www.xxx.com/api/students/`	获取所有学生数据
GET	`http://www.xxx.com/api/students/<pk>/`	获取id=pk的学生信息
DELETE	`http://www.xxx.com/api/students/`	删除所有学生
DELETE	`http://www.xxx.com/api/students/<pk>/`	删除id=pk的一个学生
PUT	`http://www.xxx.com/api/students/<pk>/`	修改id=pk的一个学生的全部信息 [id,name,sex,age,]
PATCH	`http://www.xxx.com/api/students/<pk>/`	修改id=pk的一个学生的部分信息[age]

也就是说，我们仅需要通过url地址上的资源名称结合HTTP请求动作，就可以说明当前api接口的功能是什么了。

restful是多入口的，以资源为主的api接口规范，体现在地址上就是资源就是以名词表达。

rpc则是单入口的，以动作为主的api接口规范，体现在接口名称上往往附带操作数据的动作。

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规范是一种通用的规范，不限制语言和开发框架的使用。事实上我们可以使用任何一门语言，任何一个框架都可以实现符合restful规范的API接口。

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

3.1 api接口的幂等性¶

api接口实现过程中会存在幂等性问题。所谓幂等性是指代客户端发起多次同样请求时，是否对于服务端里面的资源产生不同结果。如果多次请求，服务端结果还是一样，则属于幂等接口，如果多次请求，服务端产生结果是不一样的，则属于非幂等接口。

请求方式	是否幂等	是否安全
GET	幂等	安全
POST	不幂等	不安全
PUT/PATCH	幂等	不安全
DELETE	幂等	不安全

针对幂等不安全的接口，要进行参数的校验。针对不幂等不安全的接口，要做幂等性校验。

如果做幂等性校验呢？所以幂等性校验就是为了避免对于同一个接口反复提交。

增加唯一判断，给提交的数据字段，设置唯一索引
给提交的数据增加一个随机数（uuid），如果两次提交的数据随机数是一样的，则表示重复提交。
限流，或强制刷新

4. 序列化¶

api接口开发，最核心最常见的一个代码编写过程就是序列化，所谓序列化就是把数据转换格式。

序列化可以分两个阶段：

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

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

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

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

def get(request):
    # 获取过滤参数[反序列化]
    # 读取数据
    # 转换数据格式 [序列化]
    # 返回结果

def post(request):
    # 接受客户端提交数据[反序列化]
    # 校验数据[反序列化]
    # 数据库操作
    # 转换数据格式 [序列化]
    # 返回操作结果

常见的序列化方式：

json，pickle，base64，struct，….

5. Django Rest_Framework¶

核心思想: 大量缩减编写api接口的代码

Django REST framework是一个建立在Django基础之上的Web 应用开发子框架，可以快速的开发REST API接口应用。在REST framework中，提供了序列化器Serialzier的定义，可以帮助我们简化序列化与反序列化的过程，不仅如此，还提供丰富的类视图、扩展类、视图集来简化视图的编写工作。REST framework还提供了认证、权限、限流、过滤、分页、接口文档等功能支持。REST framework还提供了一个调试API接口的Web可视化界面来方便查看测试接口。

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

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

5.1 特点¶

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

6. 环境安装与配置¶

DRF需要以下依赖：

Python 3.6+
Django 3.0+

DRF是以Django子应用的方式提供的，所以我们必须先创建Django项目才能使用DRF。

6.1 安装DRF¶

创建虚拟环境，安装django等相关模块

conda create -n drfdemo python=3.10

conda activate drfdemo

pip install django  -i https://pypi.tuna.tsinghua.edu.cn/simple 
pip install djangorestframework -i https://pypi.tuna.tsinghua.edu.cn/simple 

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

6.1.1 创建django项目¶

cd ~/Desktop
django-admin startproject drfdemo

使用pycharm打开项目，设置虚拟环境的解析器

6.2 添加rest_framework应用¶

在settings.py的INSTALLED_APPS中添加'rest_framework'。

INSTALLED_APPS = [
    ...
    'rest_framework',
]

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

将请求的数据（如JSON格式）转换为模型类对象
操作数据库
将模型类对象转换为响应的数据（如JSON格式）

接下来，我们快速体验下几天后我们学习完成drf以后的开发代码。接下来代码如下。

6.3 体验drf完全简写代码的过程¶

5个接口：
    添加1条数据
    获取所有数据
    获取1条数据
    更新1条数据
    删除1条数据

# 终端下执行：
django-admin startapp stuapi    # 提供原生的django代码实现的API接口
django-admin startapp students  # 提供drf代码实现的API接口

把新建的子应用先统一注册到settings.py，代码：

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

    'rest_framework',

    'stuapi',    # 不使用drf编写api接口
    'students',  # 使用了drf编写api接口
]

6.3.1. 创建模型操作类¶

stuapi/models.py，代码：

from django.db import models


class Student(models.Model):
    STATUS = (
        (0, "正常入学"),
        (1, "正常毕业"),
        (2, "已经辍学"),
    )
    name = models.CharField(max_length=15, verbose_name="学生名字")
    age = models.SmallIntegerField(verbose_name="年龄")
    sex = models.BooleanField(default=True, verbose_name="性别")
    classmate = models.CharField(db_column="class", max_length=50, verbose_name="班级")
    mobile = models.CharField(max_length=20, unique=True, verbose_name="下载地址")
    description = models.TextField(null=True, verbose_name="个性签名")
    status = models.SmallIntegerField(null=True, verbose_name="状态码")
    created_time = models.DateTimeField(auto_now_add=True)
    updated_time = models.DateTimeField(auto_now=True)

    class Meta:
        db_table = "student"
        verbose_name = "学生信息"
        verbose_name_plural = verbose_name

    def __str__(self):
        return f"{self.name}"

6.3.1.1 配置数据库¶

主引用中__init__.py设置使用pymysql作为数据库驱动

import pymysql
pymysql.install_as_MySQLdb()

settings.py配置文件中设置mysql的账号密码

# Database
# https://docs.djangoproject.com/en/4.0/ref/settings/#databases

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

这里我们先使用原生的Django代码提供5个基本API接口，stuapi/views.py，代码：

import json
from django.views import View
from django.http.response import JsonResponse
from . import models

# Create your views here.
"""
POST /students/   添加一个学生信息
GET  /students/   获取所有学生信息

GET /students/<pk>/  获取一个学生信息
PUT /students/<pk>/  更新一个学生信息
DELETE /students/<pk>/  删除一个学生信息

一个路由对应一个视图类，所以我们可以把5个API分成2个类来完成
"""


class StudentListAPIView(View):
    def get(self, request):
        """获取所有学生列表信息"""
        student_list = list( models.Student.objects.values())
        return JsonResponse(student_list, safe=False)

    def post(self, request):
        """添加一个学生信息"""
        # 接收客户端提交的数据
        data = json.loads(request.body)
        # 校验数据
        # 数据库操作
        student = models.Student.objects.create(**data)
        # 返回操作结果
        return JsonResponse({
            "id": student.id,
            "name": student.name,
            "sex": student.sex,
            "age": student.age,
            "classmate": student.classmate,
            "mobile": student.mobile,
            "status": student.status,
            "description": student.description,
        }, status=201)


class StudentInfoAPIView(View):
    def get(self, request, pk):
        """获取一个学生信息"""
        try:
            student = models.Student.objects.get(pk=pk)
        except models.Student.DoesNotExist:
            return JsonResponse({}, status=404)

        return JsonResponse({
            "id": student.id,
            "name": student.name,
            "sex": student.sex,
            "age": student.age,
            "classmate": student.classmate,
            "mobile": student.mobile,
            "status": student.status,
            "description": student.description,
        })

    def put(self, request, pk):
        """更新一个学生信息"""
        # 校验ID是否存在
        try:
            student = models.Student.objects.get(pk=pk)
        except models.Student.DoesNotExist:
            return JsonResponse({}, status=404)

        # 接收客户端数据
        data = json.loads(request.body)

        # 校验数据

        # 数据库操作
        # models.Student.objects.filter(id=student.id).update(**data)
        # student= models.Student.objects.get(pk=student.id)
        if data.get('name'):
            student.name = data.get('name')
        if data.get('sex'):
            student.sex = data.get('sex')
        if data.get('age'):
            student.age = data.get('age')
        if data.get('mobile'):
            student.mobile = data.get('mobile')
        if data.get('description'):
            student.description = data.get('description')
        if data.get('status'):
            student.status = data.get('status')
        student.save()

        # 返回操作结果
        return JsonResponse({
            "id": student.id,
            "name": student.name,
            "sex": student.sex,
            "age": student.age,
            "classmate": student.classmate,
            "mobile": student.mobile,
            "status": student.status,
            "description": student.description,
        }, status=201)

    def delete(self, request, pk):
        """删除一个学生信息"""
        models.Student.objects.filter(pk=pk).delete()
        return JsonResponse({}, status=204)

子应用下创建urls.py，代码：

from django.urls import path, re_path
from . import views

urlpatterns = [
    path("student/", views.StudentListAPIView.as_view()),
    re_path(r"^student/(?P<pk>\d+)/$", views.StudentInfoAPIView.as_view()),
]

在settings.py，关闭CSRF中间件：

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    # 'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

总路由，urls.py，代码：

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

urlpatterns = [
    path("admin/", admin.site.urls),
    path("stuapi/", include("stuapi.urls")),
]

访问效果：

GET  http://127.0.0.1:8000/stuapi/student/

POST http://127.0.0.1:8000/stuapi/student/
Content-Type: application/json

{
    "name": "xiaohua",
    "age": 10,
    "sex": true,
    "mobile": "18356788765",
    "classmate": "404",
    "description": "行不改名坐不改姓，我就是小花",
    "status": 0
}


GET  http://127.0.0.1:8000/stuapi/student/126/

PUT  http://127.0.0.1:8000/stuapi/student/126/
Content-Type: application/json

{
    "name": "xiaohua",
    "age": 27,
    "sex": true,
    "mobile": "18356788765",
    "classmate": "404",
    "description": "行不改名坐不改姓，我就是小花",
    "status": 0
}

DELETE http://127.0.0.1:8000/stuapi/student/126/

接下来，我们可以采用django_restframework来完成上面的5个API接口。具体代码编写到另一个子应用students。

6.3.2. 创建序列化器¶

因为上面的django原生代码编写的API接口中，已经编写了一个学生信息的模型，所以直接采用之前命名的模型即可。

在students子应用目录下，新建serializers.py用于模型转换数据的序列化器。

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

from rest_framework import serializers
from stuapi import models


class StudentSerializer(serializers.ModelSerializer):
    """学生信息的序列化器"""
    class Meta:
        model = models.Student
        fields = "__all__" # 转换模型的所有字段

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

6.3.3. 编写视图¶

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

from rest_framework.viewsets import ModelViewSet
from stuapi import models
from . import serializers


class StudentModelViewSet(ModelViewSet):
    queryset = models.Student.objects.all()
    serializer_class = serializers.StudentSerializer

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

6.3.4. 定义路由¶

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

from . import views
from rest_framework import routers

router = routers.DefaultRouter()
router.register("student", views.StudentModelViewSet, basename="student")

urlpatterns = [

] + router.urls

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

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

urlpatterns = [
    path("admin/", admin.site.urls),
    path("stuapi/", include("stuapi.urls")),
    path("drfapi/", include("students.urls")),
]

6.3.5. 运行测试¶

运行当前程序（与运行Django一样）

python manage.py runserver

在浏览器中输入网址http://127.0.0.1:8000/drfapi/，可以看到DRF提供的API Web浏览页面：

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

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

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

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

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

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

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

返回，如下页面：

7. 序列化器-Serializer¶

作用：

1. 序列化：
    序列化器会把模型对象转换成字典，经过视图中response对象以后变成json字符串
2. 反序列化：
    视图中request会把客户端发送过来的数据转换成字典，序列化器可以把字典转成模型
    把客户端发送过来的数据进行校验

7.1 定义序列化器¶

DRF中的序列化器的类声明，与模型的声明高度相似，我们之前学习过的模型声明方式，可以进行参考。

Django REST framework中的Serializer使用类来定义，必须直接或间接继承于rest_framework.serializers.Serializer。

接下来，为了方便演示序列化器的使用，我们先创建一个新的子应用sers

python manage.py startapp sers

序列化器注册到项目中。

settings.py，代码：

INSTALLED_APPS = [
    "django.contrib.admin",
    "django.contrib.auth",
    "django.contrib.contenttypes",
    "django.contrib.sessions",
    "django.contrib.messages",
    "django.contrib.staticfiles",

    "rest_framework",

    "stuapi",
    "students",
    "sers",  # 序列化阶段
]

总路由，urls.py，代码：

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

urlpatterns = [
    path("admin/", admin.site.urls),
    path("stuapi/", include("stuapi.urls")),
    path("drfapi/", include("students.urls")),
    path("sers/", include("sers.urls")),
]

我们已有了一个数据库模型类stuapi/Student，我们想为这个Student模型类提供一个序列化器类，可以定义如下，sers/serializers.py，代码：

from rest_framework import serializers
from stuapi import models

"""
drf中所有的序列化器必须直接或间接继承于 serializers.Serializer
serializers.Serializer 序列化器基类
serializers.ModelSerializer 序列化器模型类，是序列化器基类的子类，提供了关于模型的自动操作
在工作中，除了Serializer基类以外，最常用的序列化器类基类
"""


class StudentSerializer(serializers.Serializer):
    """学生数据的序列化器"""
    """字段类型声明，用于声明转换给客户端的数据格式"""
    # 字段名 = serializers.字段类型()
    id = serializers.IntegerField()
    name = serializers.CharField()
    age = serializers.IntegerField()
    sex = serializers.BooleanField()
    description = serializers.CharField()
    mobile = serializers.CharField()
    status = serializers.IntegerField()
    created_time = serializers.DateTimeField()
    updated_time = serializers.DateTimeField()

    """元数据"""
    # class Meta:
    #     model = "模型类名"
    #     fields = ["字段1","字段12", ...,]
    #     fields = "__all__"

    """校验数据"""
    # def validate(self, attrs): # 全部数据的校验,attrs等价于 request.body
    #     # 校验数据的代码
    #     return attrs # 必须有返回值
    #
    # def validated_<字段名>(self, data): # 校验单个指定字段的数据
    #     return data # 必须有返回值

    """模型操作"""
    # def create(self, validated_data): # validated_data 就是校验数据后的返回结果
    #     # 模型操作代码
    #     return 模型对象

    # def update(self, instance, validated_data): # instance 表示要修改的模型对象，validated_data 就是校验数据的返回结果
    #     # 模型操作代码
    #     return 模型对象

views.py，视图调用序列化器，代码：

from django.views import View
from django.http.response import JsonResponse
from stuapi import models
from . import serializers


# Create your views here.
class StudentView(View):
    def get1(self, request):
        """使用序列化器之前"""
        # 模型读取数据
        student_objs = models.Student.objects.all()
        # 序列化转换数据
        student_list = []
        # for student in student_objs:
        #     student_list.append({
        #         "id": student.id,
        #         "name": student.name,
        #         "sex": student.sex,
        #         "age": student.age,
        #         "mobile": student.mobile,
        #         "description": student.description,
        #         "status": student.status,
        #     })
        # 响应数据
        return JsonResponse(student_list, safe=False)

    def get(self, request):
        """使用序列化器之后"""
        # 模型读取数据
        student_objs = models.Student.objects.all()
        # 序列化转换数据
        serializer = serializers.StudentSerializer(instance=student_objs, many=True) # many=True 表示instance参数是一个列表，序列化器内部会根据many的值判断是否需要for循环
        student_list = serializer.data  # 数据格式转换后的结果
        # 响应数据
        return JsonResponse(student_list, safe=False)

子应用路由，sers/urls.py，代码：

from django.urls import path, re_path
from . import views

urlpatterns = [
    path("student/", views.StudentView.as_view()),
]

访问地址：http://127.0.0.1:8000/sers/student/，效果：

7.1.1 常用字段类型¶

serailziers类中的字段声明是提供给客户端的，所以常用字段类型：

序列化器字段	字段选项	模型字段
BooleanField	BooleanField()	BooleanField
CharField	CharField( maxlength=最大长度, minlength=最小长度, allowblank=False, 表示是否允许客户端提交空字符串，False表示不允许 trimwhitespace=True，表示是否移除字符串两边的空白字符，True表示移除 )	CharField TextField等
EmailField	EmailField(maxlength=None, minlength=None, allow_blank=False)	EmailField
RegexField	RegexField(regex=正则表达式, maxlength=None, minlength=None, allow_blank=False)	CharField
SlugField	SlugField(maxlength=50, minlength=None, allow_blank=False) 正则字段，验证正则模式 [a-zA-Z0-9*-]+	SlugField
URLField	URLField(maxlength=200, minlength=None, allow_blank=False)	URLField
UUIDField	UUIDField(format='hexverbose') format: 设置UUID格式，一般默认使用hexverbose `'hex_verbose'` 如`"5ce0e9a5-5ffa-654b-cee0-1238041fb31a"` `'hex'` 如 `"5ce0e9a55ffa654bcee01238041fb31a"` `'int'` - 如: `"123456789012312313134124512351145145114"` `'urn'` 如: `"urn:uuid:5ce0e9a5-5ffa-654b-cee0-1238041fb31a"`	UUIDField
IPAddressField	IPAddressField(protocol='both', unpack_ipv4=False, **options)	IPAddressField
IntegerField	IntegerField(maxvalue=最大值, minvalue=最小值)	SmallIntegerFiled IntegerField BigIntegerField
FloatField	FloatField(maxvalue=None, minvalue=None)	FloatField
DecimalField	DecimalField( maxdigits=数值的数字总个数, decimalplaces=小数位个数, coercetostring=None, maxvalue=None, minvalue=None)	DecimalField
DateTimeField	DateTimeField( format=apisettings.DATETIMEFORMAT, 表示日期格式 input_formats=None)	DateTimeField
DateField	DateField(format=apisettings.DATEFORMAT, input_formats=None)	DateField
TimeField	TimeField(format=apisettings.TIMEFORMAT, input_formats=None)	TimeField
DurationField	DurationField()	DurationField
ChoiceField	ChoiceField(choices=元组选项) choices与Django的用法相同	对应整型或字符串中的choices=属性选项
MultipleChoiceField	MultipleChoiceField(choices=元组选项) choices与Django的用法相同	对应整型或字符串中的choices=属性选项
FileField	FileField(maxlength=None, allowemptyfile=False, useurl=UPLOADEDFILESUSE_URL)	FileField
ImageField	ImageField(maxlength=None, allowemptyfile=False, useurl=UPLOADEDFILESUSE_URL)	ImageField
ListField	ListField(child=模型列表, minlength=None, maxlength=None)	python里面的List
DictField	DictField(child=模型对象)	python里面的Dict

字段的选项参数：

参数名称	作用
max_length	最大长度
min_lenght	最小长度
allow_blank	是否允许为空字符串
trim_whitespace	是否移除字符串两边的空白字符
max_value	最小数值
min_value	最大数值

字段的通用选项参数：

参数名称	说明
read_only	表明该字段仅用于序列化输出，默认False，例如：id，createdtime，updatedtime
write_only	表明该字段仅用于反序列化输入，默认False，例如：password，
required	表明该字段在反序列化时必须输入，默认True
default	反序列化时使用的默认值
allow_null	表明反序列化时该字段是否允许传入None，默认False
validators	表明反序列化时该字段使用的验证器函数（是定义在序列化器类外部的校验函数）
error_messages	表明反序列化时如果验证出错了，返回错误错误信息的字典
label	用于HTML展示API页面时，显示的字段名称。如果不写，则默认采用模型的verbose_name，但是前提是当前序列化器继承ModelSerializer
help_text	用于HTML展示API页面时，显示的字段帮助提示信息如果不写，则默认采用模型的help_text，但是前提是当前序列化器继承ModelSerializer

7.2 创建Serializer对象¶

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

Serializer的构造方法为：

serializer = 序列化器类(instance=None, data=empty, many=False, context=None, **kwargs)

说明：

1）用于序列化时实例化，则需要将模型类对象传入instance参数

2）用于反序列化时实例化，将要被反序列化的数据传入data参数

3）用于序列化时实例化，当instance的值是一个QuerySet类型，则需要声明many=True

4）除了以上参数外，在创建Serializer对象时，还可通过context参数【字典类型】额外添加数据传入到序列化器中。

常见的写法：

# 序列化单个模型对象，当instance是模型对象
serializer = StudentSerializer(instance=student) 
serializer = StudentSerializer(student) # 等价于上面一句代码，instance是一个参数，所以也可以不使用命名参数

# 序列化多个模型对象，当instance是QuerySet对象
serializer = StudentSerializer(instance=student_list, many=True)

serializer = StudentSerializer(其他参数..., context={'request': request}) # 如果传递数据到序列化器中，可以使用context

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

使用序列化器的时候一定要注意，序列化器声明了以后，不会自动执行，需要我们在视图中导入并进行调用才可以。
序列化器无法直接接收数据，需要我们在视图中实例化序列化器对象时把使用的数据通过instance传递过来。
序列化器的字段声明类似于我们前面使用过的模型，所以实际上将来如果要序列化的是模型数据，序列化器的字段声明是可以省略的。
开发restful api时，序列化器会帮我们把模型对象转换成字典或列表

注意：

serializer不是只能对模型类转换数据格式，也可以为非数据库模型类的转换数据格式。

serializer是独立于数据库之外的存在，并不是和模型绑定的，具体要看视图实现的业务逻辑来决定。

7.3 序列化器的使用¶

序列化器的使用分两个阶段：

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

7.3.1 序列化¶

7.3.1.1 序列化单个模型对象¶

views.py，视图代码：

from django.views import View
from django.http.response import JsonResponse
from stuapi import models
from . import serializers


# Create your views here.
class Student1View(View):
    """序列化单个模型对象"""
    def get1(self, request):
        """使用序列化器之前"""
        # 模型读取数据
        student = models.Student.objects.first()
        # 序列化
        student_dict = {
            "id": student.id,
            "name": student.name,
            "sex": student.sex,
            "age": student.age,
            "mobile": student.mobile,
            "description": student.description,
            "status": student.status,
        }
        # 响应数据
        return JsonResponse(student_dict, safe=False)

    def get(self,request):
        """使用序列化器之后"""
        # 模型读取数据
        student = models.Student.objects.first()
        # 序列化
        serializer = serializers.StudentSerializer(instance=student)  # 序列化单个模型，不需要声明many属性
        student_dict = serializer.data # 提取序列化的结果
        # 响应数据
        return JsonResponse(student_dict, safe=False)

urls.py，路由代码：

from django.urls import path, re_path
from . import views

urlpatterns = [
    path("student/", views.StudentView.as_view()),
    path("s1/", views.Student1View.as_view()),
]

访问地址：http://127.0.0.1:8000/sers/s1/，效果：

7.3.1.2 序列化多个模型对象¶

如果要被序列化的是包含多条数据的查询集QuerySet，可以通过添加many=True参数补充说明

class StudentView(View):
    def get1(self, request):
        """使用序列化器之前"""
        # 模型读取数据
        student_objs = models.Student.objects.all()
        # 序列化转换数据
        student_list = []
        # for student in student_objs:
        #     student_list.append({
        #         "id": student.id,
        #         "name": student.name,
        #         "sex": student.sex,
        #         "age": student.age,
        #         "mobile": student.mobile,
        #         "description": student.description,
        #         "status": student.status,
        #     })
        # 响应数据
        return JsonResponse(student_list, safe=False)

    def get(self, request):
        """使用序列化器之后"""
        # 模型读取数据
        student_objs = models.Student.objects.all()
        # 序列化转换数据
        serializer = serializers.StudentSerializer(instance=student_objs, many=True) # many=True 表示instance参数是一个列表，序列化器内部会根据many的值判断是否需要for循环
        student_list = serializer.data  # 数据格式转换后的结果
        # 响应数据
        return JsonResponse(student_list, safe=False)

访问效果：

7.3.2 反序列化¶

7.3.2.1 数据验证¶

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

在获取反序列化的数据前，必须调用is_valid()方法进行验证，验证成功返回True，否则返回False。

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

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

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

序列化器中，提供了三种方式给开发者编写校验字段代码：字段选项、以validate开头的对象方法，外部校验函数。

serialziers.py，代码：

from rest_framework import serializers
from stuapi import models

"""
drf中所有的序列化器必须直接或间接继承于 serializers.Serializer
serializers.Serializer 序列化器基类
serializers.ModelSerializer 序列化器模型类，是序列化器基类的子类，提供了关于模型的自动操作
在工作中，除了Serializer基类以外，最常用的序列化器类基类
"""


class StudentSerializer(serializers.Serializer):
    """学生数据的序列化器"""
    """字段类型声明，用于声明转换给客户端的数据格式"""
    # 字段名 = serializers.字段类型()
    id = serializers.IntegerField(read_only=True) # read_only=True 限制当前字段只能在序列化阶段（用户读取数据时）
    name = serializers.CharField(required=True, error_messages={"required": "姓名不能为空!"})  # required=True 表示当前字段必填
    age = serializers.IntegerField(required=True,max_value=99, min_value=1, error_messages={"max_value": "请填写真实年龄！", "min_value": "请填写真实年龄！"})
    sex = serializers.BooleanField()
    description = serializers.CharField()
    classmate = serializers.CharField(required=True)
    mobile = serializers.CharField(required=True)
    status = serializers.IntegerField(required=True)
    created_time = serializers.DateTimeField(read_only=True)
    updated_time = serializers.DateTimeField(read_only=True)

    def validate_mobile(self, data):
        """
        validate_<字段名>  # 针对指定字段进行验证
        # validate_mobile 表示 针对mobile字段进行单独的校验，mobile也可以换成其他字段。
        """
        print("data=", data)
        ret = models.Student.objects.filter(mobile=data).first()
        if ret:
            raise serializers.ValidationError(code="mobile", detail="当前手机号已经被注册！")

        return data  # 必须把数据返回，否则后续操作中序列化器无法获取校验后的结果

通过构造序列化器对象，并将要反序列化的数据传递给data构造参数，进而进行验证

views.py，代码：

import json
from django.views import View
from django.http.response import JsonResponse
from stuapi import models
from . import serializers


class Student2View(View):
    """在添加/更新数据时，使用反序列化"""
    def post1(self, request):
        """使用序列化器之前"""
        # 接收数据
        data = json.loads(request.body)
        # 校验数据
        # 判断是否存在字段为空的情况，name，mobile，age，status，classmate
        if not data.get("name"):
            return JsonResponse({"name": "name", "errors": "姓名不能为空！"}, status=400)
        if not data.get("mobile"):
            return JsonResponse({"name": "mobile", "errors": "手机号不能为空！"}, status=400)
        if not data.get("age"):
            return JsonResponse({"name": "age", "errors": "年龄不能为空！"}, status=400)
        if data.get("status") == "":
            return JsonResponse({"name": "status", "errors": "状态不能为空！"}, status=400)
        if not data.get("classmate"):
            return JsonResponse({"name": "classmate", "errors": "班级不能为空！"}, status=400)

        # 判断age是否在合理区间
        if not (0 < data.get("age") < 100):
            return JsonResponse({"name": "age", "errors": "年龄必须真实填写！"}, status=400)

        # 验证手机号是否重复注册
        ret = models.Student.objects.filter(mobile=data.get("mobile")).first()
        if ret:
            return JsonResponse({"name": "mobile", "errors": "当前手机号已经被注册！"}, status=400)

        # 模型操作
        student = models.Student.objects.create(
            name=data.get("name"),
            mobile=data.get("mobile"),
            age=data.get("age"),
            status=data.get("status"),
            classmate=data.get("classmate"),
            description=data.get("description"),
        )

        # 序列化
        serializer = serializers.StudentSerializer(student)
        # 返回结果
        instance = serializer.data
        return JsonResponse(instance, status=201)

    def post(self, request):
        """使用序列化器之后"""
        # 接收数据
        data = json.loads(request.body)
        # 校验数据
        # 判断是否存在字段为空的情况，name，mobile，age，status，classmate
        # if not data.get("name"):
        #     return JsonResponse({"name": "name", "errors": "姓名不能为空！"}, status=400)
        # if not data.get("mobile"):
        #     return JsonResponse({"name": "mobile", "errors": "手机号不能为空！"}, status=400)
        # if not data.get("age"):
        #     return JsonResponse({"name": "age", "errors": "年龄不能为空！"}, status=400)
        # if data.get("status") == "":
        #     return JsonResponse({"name": "status", "errors": "状态不能为空！"}, status=400)
        # if not data.get("classmate"):
        #     return JsonResponse({"name": "classmate", "errors": "班级不能为空！"}, status=400)

        # # 判断age是否在合理区间
        # if not (0 < data.get("age") < 100):
        #     return JsonResponse({"name": "age", "errors": "年龄必须真实填写！"}, status=400)
        #
        # # 验证手机号是否重复注册
        # ret = models.Student.objects.filter(mobile=data.get("mobile")).first()
        # if ret:
        #     return JsonResponse({"name": "mobile", "errors": "当前手机号已经被注册！"}, status=400)


        # 实例化序列化器，用于反序列化必须填写data参数
        serializer = serializers.StudentSerializer(data=data)
        # 调用序列化器的校验流程
        if not serializer.is_valid():
            print(serializer.errors)  # 获取校验失败后的错误提示信息
            return JsonResponse(serializer.errors, status=400)

        # 模型操作
        student = models.Student.objects.create(
            name=data.get("name"),
            mobile=data.get("mobile"),
            age=data.get("age"),
            status=data.get("status"),
            classmate=data.get("classmate"),
            description=data.get("description"),
        )

        # 序列化
        serializer = serializers.StudentSerializer(student)
        # 返回结果
        instance = serializer.data
        return JsonResponse(instance, status=201)

urls.py，代码：

from django.urls import path, re_path
from . import views

urlpatterns = [
    path("student/", views.StudentView.as_view()),
    path("s1/", views.Student1View.as_view()),
    path("s2/", views.Student2View.as_view()),
]

因为添加视图使用了post方法，所以使用postman请求如下：

is_valid()方法还可以在验证失败时抛出异常serializers.ValidationError，可以通过传递raise_exception=True参数开启，REST framework接收到此异常，会向前端返回HTTP 400 Bad Request响应。

views.py，代码：

import json
from django.views import View
from django.http.response import JsonResponse
from stuapi import models
from . import serializers


class Student2View(View):
    """在添加/更新数据时，使用反序列化"""
    def post1(self, request):
        """使用序列化器之前"""
        # 接收数据
        data = json.loads(request.body)
        # 校验数据
        # 判断是否存在字段为空的情况，name，mobile，age，status，classmate
        if not data.get("name"):
            return JsonResponse({"name": "name", "errors": "姓名不能为空！"}, status=400)
        if not data.get("mobile"):
            return JsonResponse({"name": "mobile", "errors": "手机号不能为空！"}, status=400)
        if not data.get("age"):
            return JsonResponse({"name": "age", "errors": "年龄不能为空！"}, status=400)
        if data.get("status") == "":
            return JsonResponse({"name": "status", "errors": "状态不能为空！"}, status=400)
        if not data.get("classmate"):
            return JsonResponse({"name": "classmate", "errors": "班级不能为空！"}, status=400)

        # 判断age是否在合理区间
        if not (0 < data.get("age") < 100):
            return JsonResponse({"name": "age", "errors": "年龄必须真实填写！"}, status=400)

        # 验证手机号是否重复注册
        ret = models.Student.objects.filter(mobile=data.get("mobile")).first()
        if ret:
            return JsonResponse({"name": "mobile", "errors": "当前手机号已经被注册！"}, status=400)

        # 模型操作
        student = models.Student.objects.create(
            name=data.get("name"),
            mobile=data.get("mobile"),
            age=data.get("age"),
            status=data.get("status"),
            classmate=data.get("classmate"),
            description=data.get("description"),
        )

        # 序列化
        serializer = serializers.StudentSerializer(student)
        # 返回结果
        instance = serializer.data
        return JsonResponse(instance, status=201)

    def post(self, request):
        """使用序列化器之后"""
        # 接收数据
        data = json.loads(request.body)
        # 实例化序列化器，用于反序列化必须填写data参数
        serializer = serializers.StudentSerializer(data=data)
        # 调用序列化器的校验流程
        # 除了自己接受is_valid的结果进行判断，手动返回错误信息以外，还可以由drf帮我们返回错误信息
        serializer.is_valid(raise_exception=True) # raise_exception=True 表示校验失败时，让drf自行返回错误给客户端

        # 模型操作
        student = models.Student.objects.create(
            name=data.get("name"),
            mobile=data.get("mobile"),
            age=data.get("age"),
            status=data.get("status"),
            classmate=data.get("classmate"),
            description=data.get("description"),
        )

        # 序列化
        serializer = serializers.StudentSerializer(student)
        # 返回结果
        instance = serializer.data
        return JsonResponse(instance, status=201)

如果觉得这些还不够，需要再补充定义验证行为，可以使用以下三种方法：

1) validate_字段名¶

对指定字段进行验证，如

from rest_framework import serializers
from stuapi import models

"""
drf中所有的序列化器必须直接或间接继承于 serializers.Serializer
serializers.Serializer 序列化器基类
serializers.ModelSerializer 序列化器模型类，是序列化器基类的子类，提供了关于模型的自动操作
在工作中，除了Serializer基类以外，最常用的序列化器类基类
"""


class StudentSerializer(serializers.Serializer):
    """学生数据的序列化器"""
    """字段类型声明，用于声明转换给客户端的数据格式"""
    # 字段名 = serializers.字段类型()
    id = serializers.IntegerField(read_only=True) # read_only=True 限制当前字段只能在序列化阶段（用户读取数据时）
    name = serializers.CharField(required=True, error_messages={"required": "姓名不能为空!"})  # required=True 表示当前字段必填
    age = serializers.IntegerField(required=True,max_value=99, min_value=1, error_messages={"max_value": "请填写真实年龄！", "min_value": "请填写真实年龄！"})
    sex = serializers.BooleanField()
    description = serializers.CharField()
    classmate = serializers.CharField(required=True)
    mobile = serializers.CharField(required=True)
    status = serializers.IntegerField(required=True)
    created_time = serializers.DateTimeField(read_only=True)
    updated_time = serializers.DateTimeField(read_only=True)

    def validate_mobile(self, data):
        """
        validate_<字段名>  # 针对指定字段进行验证
        # validate_mobile 表示 针对mobile字段进行单独的校验，mobile也可以换成其他字段。
        """
        print("data=", data)
        ret = models.Student.objects.filter(mobile=data).first()
        if ret:
            raise serializers.ValidationError(code="mobile", detail="当前手机号已经被注册！")

        return data  # 必须把数据返回，否则后续操作中序列化器无法获取校验后的结果

视图代码，测试

import json
from django.views import View
from django.http.response import JsonResponse
from stuapi import models
from . import serializers

# Create your views here.

class Student2View(View):
    """在添加/更新数据时，使用反序列化"""
    def post1(self, request):
        """使用序列化器之前"""
        # 接收数据
        data = json.loads(request.body)
        # 校验数据
        # 判断是否存在字段为空的情况，name，mobile，age，status，classmate
        if not data.get("name"):
            return JsonResponse({"name": "name", "errors": "姓名不能为空！"}, status=400)
        if not data.get("mobile"):
            return JsonResponse({"name": "mobile", "errors": "手机号不能为空！"}, status=400)
        if not data.get("age"):
            return JsonResponse({"name": "age", "errors": "年龄不能为空！"}, status=400)
        if data.get("status") == "":
            return JsonResponse({"name": "status", "errors": "状态不能为空！"}, status=400)
        if not data.get("classmate"):
            return JsonResponse({"name": "classmate", "errors": "班级不能为空！"}, status=400)

        # 判断age是否在合理区间
        if not (0 < data.get("age") < 100):
            return JsonResponse({"name": "age", "errors": "年龄必须真实填写！"}, status=400)

        # 验证手机号是否重复注册
        ret = models.Student.objects.filter(mobile=data.get("mobile")).first()
        if ret:
            return JsonResponse({"name": "mobile", "errors": "当前手机号已经被注册！"}, status=400)

        # 模型操作
        student = models.Student.objects.create(
            name=data.get("name"),
            mobile=data.get("mobile"),
            age=data.get("age"),
            status=data.get("status"),
            classmate=data.get("classmate"),
            description=data.get("description"),
        )

        # 序列化
        serializer = serializers.StudentSerializer(student)
        # 返回结果
        instance = serializer.data
        return JsonResponse(instance, status=201)

    def post(self, request):
        """使用序列化器之后"""
        # 接收数据
        data = json.loads(request.body)
        # 实例化序列化器，用于反序列化必须填写data参数
        serializer = serializers.StudentSerializer(data=data)
        # 调用序列化器的校验流程
        # 除了自己接受is_valid的结果进行判断，手动返回错误信息以外，还可以由drf帮我们返回错误信息
        serializer.is_valid(raise_exception=True) # raise_exception=True 表示校验失败时，让drf自行返回错误给客户端

        # 模型操作
        student = models.Student.objects.create(
            name=data.get("name"),
            mobile=data.get("mobile"),
            age=data.get("age"),
            status=data.get("status"),
            classmate=data.get("classmate"),
            description=data.get("description"),
        )

        # 序列化
        serializer = serializers.StudentSerializer(student)
        # 返回结果
        instance = serializer.data
        return JsonResponse(instance, status=201)

2) validate¶

在序列化器中需要同时对多个字段进行比较验证时，可以定义validate方法来验证，如

from rest_framework import serializers
from stuapi import models

"""
drf中所有的序列化器必须直接或间接继承于 serializers.Serializer
serializers.Serializer 序列化器基类
serializers.ModelSerializer 序列化器模型类，是序列化器基类的子类，提供了关于模型的自动操作
在工作中，除了Serializer基类以外，最常用的序列化器类基类
"""


class StudentSerializer(serializers.Serializer):
    """学生数据的序列化器"""
    """字段类型声明，用于声明转换给客户端的数据格式"""
    # 字段名 = serializers.字段类型()
    id = serializers.IntegerField(read_only=True) # read_only=True 限制当前字段只能在序列化阶段（用户读取数据时）
    name = serializers.CharField(required=True, error_messages={"required": "姓名不能为空!"})  # required=True 表示当前字段必填
    age = serializers.IntegerField(required=True,max_value=99, min_value=1, error_messages={"max_value": "请填写真实年龄！", "min_value": "请填写真实年龄！"})
    sex = serializers.BooleanField()
    description = serializers.CharField()
    classmate = serializers.CharField(required=True)
    mobile = serializers.CharField(required=True)
    status = serializers.IntegerField(required=True)
    created_time = serializers.DateTimeField(read_only=True)
    updated_time = serializers.DateTimeField(read_only=True)

    # def validate_mobile(self, data):
    #     """
    #     validate_<字段名>  # 针对指定字段进行验证
    #     # validate_mobile 表示 针对mobile字段进行单独的校验，mobile也可以换成其他字段。
    #     """
    #     print("data=", data)
    #     ret = models.Student.objects.filter(mobile=data).first()
    #     if ret:
    #         raise serializers.ValidationError(code="mobile", detail="当前手机号已经被注册！")
    #
    #     return data  # 必须把数据返回，否则后续操作中序列化器无法获取校验后的结果

    def validate(self, data):
        """
        validate  # 针对客户端提交的所有字段进行验证
        # validate_mobile 表示 针对mobile字段进行单独的校验，mobile也可以换成其他字段。
        """
        print("data=", data)
        ret = models.Student.objects.filter(mobile=data.get("mobile")).first()
        if ret:
            raise serializers.ValidationError(code="mobile", detail="当前手机号已经被注册！")

        return data  # 必须把数据返回，否则后续操作中序列化器无法获取校验后的结果

视图代码，测试

import json
from django.views import View
from django.http.response import JsonResponse
from stuapi import models
from . import serializers

# Create your views here.

class Student2View(View):
    """在添加/更新数据时，使用反序列化"""
    def post1(self, request):
        """使用序列化器之前"""
        # 接收数据
        data = json.loads(request.body)
        # 校验数据
        # 判断是否存在字段为空的情况，name，mobile，age，status，classmate
        if not data.get("name"):
            return JsonResponse({"name": "name", "errors": "姓名不能为空！"}, status=400)
        if not data.get("mobile"):
            return JsonResponse({"name": "mobile", "errors": "手机号不能为空！"}, status=400)
        if not data.get("age"):
            return JsonResponse({"name": "age", "errors": "年龄不能为空！"}, status=400)
        if data.get("status") == "":
            return JsonResponse({"name": "status", "errors": "状态不能为空！"}, status=400)
        if not data.get("classmate"):
            return JsonResponse({"name": "classmate", "errors": "班级不能为空！"}, status=400)

        # 判断age是否在合理区间
        if not (0 < data.get("age") < 100):
            return JsonResponse({"name": "age", "errors": "年龄必须真实填写！"}, status=400)

        # 验证手机号是否重复注册
        ret = models.Student.objects.filter(mobile=data.get("mobile")).first()
        if ret:
            return JsonResponse({"name": "mobile", "errors": "当前手机号已经被注册！"}, status=400)

        # 模型操作
        student = models.Student.objects.create(
            name=data.get("name"),
            mobile=data.get("mobile"),
            age=data.get("age"),
            status=data.get("status"),
            classmate=data.get("classmate"),
            description=data.get("description"),
        )

        # 序列化
        serializer = serializers.StudentSerializer(student)
        # 返回结果
        instance = serializer.data
        return JsonResponse(instance, status=201)

    def post(self, request):
        """使用序列化器之后"""
        # 接收数据
        data = json.loads(request.body)
        # 实例化序列化器，用于反序列化必须填写data参数
        serializer = serializers.StudentSerializer(data=data)
        # 调用序列化器的校验流程
        # 除了自己接受is_valid的结果进行判断，手动返回错误信息以外，还可以由drf帮我们返回错误信息
        serializer.is_valid(raise_exception=True) # raise_exception=True 表示校验失败时，让drf自行返回错误给客户端

        # 模型操作
        student = models.Student.objects.create(
            name=data.get("name"),
            mobile=data.get("mobile"),
            age=data.get("age"),
            status=data.get("status"),
            classmate=data.get("classmate"),
            description=data.get("description"),
        )

        # 序列化
        serializer = serializers.StudentSerializer(student)
        # 返回结果
        instance = serializer.data
        return JsonResponse(instance, status=201)

3) validators¶

在字段中添加validators选项参数，也可以补充验证行为，如

from rest_framework import serializers
from stuapi import models

"""
drf中所有的序列化器必须直接或间接继承于 serializers.Serializer
serializers.Serializer 序列化器基类
serializers.ModelSerializer 序列化器模型类，是序列化器基类的子类，提供了关于模型的自动操作
在工作中，除了Serializer基类以外，最常用的序列化器类基类
"""


def check_mobile(data):
    """定义在序列化器类外部的校验函数"""
    print("check_mobile, data=", data)
    ret = models.Student.objects.filter(mobile=data).first()
    if ret:
        raise serializers.ValidationError(code="mobile", detail="当前手机号已经被注册！")
    return data  # 必须把数据返回，否则后续操作中序列化器无法获取校验后的结果


class StudentSerializer(serializers.Serializer):
    """学生数据的序列化器"""
    """字段类型声明，用于声明转换给客户端的数据格式"""
    # 字段名 = serializers.字段类型()
    id = serializers.IntegerField(read_only=True) # read_only=True 限制当前字段只能在序列化阶段（用户读取数据时）
    name = serializers.CharField(required=True, error_messages={"required": "姓名不能为空!"})  # required=True 表示当前字段必填
    age = serializers.IntegerField(required=True,max_value=99, min_value=1, error_messages={"max_value": "请填写真实年龄！", "min_value": "请填写真实年龄！"})
    sex = serializers.BooleanField()
    description = serializers.CharField()
    classmate = serializers.CharField(required=True)
    mobile = serializers.CharField(required=True, validators=[check_mobile])
    status = serializers.IntegerField(required=True)
    created_time = serializers.DateTimeField(read_only=True)
    updated_time = serializers.DateTimeField(read_only=True)

    # def validate_mobile(self, data):
    #     """
    #     validate_<字段名>  # 针对指定字段进行验证
    #     # validate_mobile 表示 针对mobile字段进行单独的校验，mobile也可以换成其他字段。
    #     """
    #     print("data=", data)
    #     ret = models.Student.objects.filter(mobile=data).first()
    #     if ret:
    #         raise serializers.ValidationError(code="mobile", detail="当前手机号已经被注册！")
    #
    #     return data  # 必须把数据返回，否则后续操作中序列化器无法获取校验后的结果

    # def validate(self, data):
    #     """
    #     validate  # 针对客户端提交的所有字段进行验证
    #     # validate_mobile 表示 针对mobile字段进行单独的校验，mobile也可以换成其他字段。
    #     """
    #     print("data=", data)
    #     ret = models.Student.objects.filter(mobile=data.get("mobile")).first()
    #     if ret:
    #         raise serializers.ValidationError(code="mobile", detail="当前手机号已经被注册！")
    #
    #     return data  # 必须把数据返回，否则后续操作中序列化器无法获取校验后的结果

视图代码，测试：

import json
from django.views import View
from django.http.response import JsonResponse
from stuapi import models
from . import serializers

# Create your views here.

class Student2View(View):
    """在添加/更新数据时，使用反序列化"""
    def post1(self, request):
        """使用序列化器之前"""
        # 接收数据
        data = json.loads(request.body)
        # 校验数据
        # 判断是否存在字段为空的情况，name，mobile，age，status，classmate
        if not data.get("name"):
            return JsonResponse({"name": "name", "errors": "姓名不能为空！"}, status=400)
        if not data.get("mobile"):
            return JsonResponse({"name": "mobile", "errors": "手机号不能为空！"}, status=400)
        if not data.get("age"):
            return JsonResponse({"name": "age", "errors": "年龄不能为空！"}, status=400)
        if data.get("status") == "":
            return JsonResponse({"name": "status", "errors": "状态不能为空！"}, status=400)
        if not data.get("classmate"):
            return JsonResponse({"name": "classmate", "errors": "班级不能为空！"}, status=400)

        # 判断age是否在合理区间
        if not (0 < data.get("age") < 100):
            return JsonResponse({"name": "age", "errors": "年龄必须真实填写！"}, status=400)

        # 验证手机号是否重复注册
        ret = models.Student.objects.filter(mobile=data.get("mobile")).first()
        if ret:
            return JsonResponse({"name": "mobile", "errors": "当前手机号已经被注册！"}, status=400)

        # 模型操作
        student = models.Student.objects.create(
            name=data.get("name"),
            mobile=data.get("mobile"),
            age=data.get("age"),
            status=data.get("status"),
            classmate=data.get("classmate"),
            description=data.get("description"),
        )

        # 序列化
        serializer = serializers.StudentSerializer(student)
        # 返回结果
        instance = serializer.data
        return JsonResponse(instance, status=201)

    def post(self, request):
        """使用序列化器之后"""
        # 接收数据
        data = json.loads(request.body)
        # 实例化序列化器，用于反序列化必须填写data参数
        serializer = serializers.StudentSerializer(data=data)
        # 调用序列化器的校验流程
        # 除了自己接受is_valid的结果进行判断，手动返回错误信息以外，还可以由drf帮我们返回错误信息
        serializer.is_valid(raise_exception=True) # raise_exception=True 表示校验失败时，让drf自行返回错误给客户端

        # 模型操作
        student = models.Student.objects.create(
            name=data.get("name"),
            mobile=data.get("mobile"),
            age=data.get("age"),
            status=data.get("status"),
            classmate=data.get("classmate"),
            description=data.get("description"),
        )

        # 序列化
        serializer = serializers.StudentSerializer(student)
        # 返回结果
        instance = serializer.data
        return JsonResponse(instance, status=201)

7.3.2.2 模型操作¶

前面的验证数据成功后,我们可以使用序列化器来完成数据反序列化的过程.这个过程可以把数据转成模型类对象.

可以通过实现create()和update()两个方法来实现。

from rest_framework import serializers
from stuapi import models

"""
drf中所有的序列化器必须直接或间接继承于 serializers.Serializer
serializers.Serializer 序列化器基类
serializers.ModelSerializer 序列化器模型类，是序列化器基类的子类，提供了关于模型的自动操作
在工作中，除了Serializer基类以外，最常用的序列化器类基类
"""


# def check_mobile(data):
#     """定义在序列化器类外部的校验函数"""
#     # print("check_mobile, data=", data)
#     ret = models.Student.objects.filter(mobile=data).first()
#     if ret:
#         raise serializers.ValidationError(code="mobile", detail="当前手机号已经被注册！")
#     return data  # 必须把数据返回，否则后续操作中序列化器无法获取校验后的结果


class StudentSerializer(serializers.Serializer):
    """学生数据的序列化器"""
    """字段类型声明，用于声明转换给客户端的数据格式"""
    # 字段名 = serializers.字段类型()
    id = serializers.IntegerField(read_only=True) # read_only=True 限制当前字段只能在序列化阶段（用户读取数据时）
    name = serializers.CharField(required=True, error_messages={"required": "姓名不能为空!"})  # required=True 表示当前字段必填
    age = serializers.IntegerField(required=True,max_value=99, min_value=1, error_messages={"max_value": "请填写真实年龄！", "min_value": "请填写真实年龄！"})
    sex = serializers.BooleanField()
    description = serializers.CharField()
    classmate = serializers.CharField(required=True)
    # mobile = serializers.CharField(required=True, validators=[check_mobile])
    mobile = serializers.CharField(required=True)
    status = serializers.IntegerField(required=True)
    created_time = serializers.DateTimeField(read_only=True)
    updated_time = serializers.DateTimeField(read_only=True)

    # def validate_mobile(self, data):
    #     """
    #     validate_<字段名>  # 针对指定字段进行验证
    #     # validate_mobile 表示 针对mobile字段进行单独的校验，mobile也可以换成其他字段。
    #     """
    #     print("data=", data)
    #     ret = models.Student.objects.filter(mobile=data).first()
    #     if ret:
    #         raise serializers.ValidationError(code="mobile", detail="当前手机号已经被注册！")
    #
    #     return data  # 必须把数据返回，否则后续操作中序列化器无法获取校验后的结果

    def validate(self, data):
        """
        validate  # 针对客户端提交的所有字段进行验证
        # validate_mobile 表示 针对mobile字段进行单独的校验，mobile也可以换成其他字段。
        """
        # print("data=", data)
        if not self.instance:
            ret = models.Student.objects.filter(mobile=data.get("mobile")).first()
        else:
            ret = models.Student.objects.exclude(id=self.instance.id).filter(mobile=data.get("mobile")).first()
        if ret:
            raise serializers.ValidationError(code="mobile", detail="当前手机号已经被注册！")

        return data  # 必须把数据返回，否则后续操作中序列化器无法获取校验后的结果

    def create(self, validated_data):
        """
        添加模型操作
        :validated_data 校验后的客户端数据，字典格式
        视图中使用序列化器对象的save方法会自动调用这个方法
        """
        student = models.Student.objects.create(**validated_data)
        return student

    def update(self, instance, validated_data):
        """
        更新模型操作
        :instance 当前本次要修改的模型对象
        :validated_data 校验后的客户端数据，字典格式
        """
        for field, value in validated_data.items():
            setattr(instance, field, value)

        # 模型的save方法，是ORM提供的。
        instance.save()
        return instance

实现了上述两个方法后，在反序列化数据的时候，就可以通过save()方法返回一个数据对象实例了

instance = serializer.save()

如果创建序列化器对象时没有设置instance参数，则序列化器的create()被调用，反之，如果设置instance参数，则序列化器的update()被调用。

rest_framework/serializers.py，save的源码如下：

views.py，视图代码，

import json
from django.views import View
from django.http.response import JsonResponse
from stuapi import models
from . import serializers


class Student2View(View):
    """在添加/更新数据时，使用反序列化"""
    def post1(self, request):
        """使用序列化器之前"""
        # 接收数据
        data = json.loads(request.body)
        # 校验数据
        # 判断是否存在字段为空的情况，name，mobile，age，status，classmate
        if not data.get("name"):
            return JsonResponse({"name": "name", "errors": "姓名不能为空！"}, status=400)
        if not data.get("mobile"):
            return JsonResponse({"name": "mobile", "errors": "手机号不能为空！"}, status=400)
        if not data.get("age"):
            return JsonResponse({"name": "age", "errors": "年龄不能为空！"}, status=400)
        if data.get("status") == "":
            return JsonResponse({"name": "status", "errors": "状态不能为空！"}, status=400)
        if not data.get("classmate"):
            return JsonResponse({"name": "classmate", "errors": "班级不能为空！"}, status=400)

        # 判断age是否在合理区间
        if not (0 < data.get("age") < 100):
            return JsonResponse({"name": "age", "errors": "年龄必须真实填写！"}, status=400)

        # 验证手机号是否重复注册
        ret = models.Student.objects.filter(mobile=data.get("mobile")).first()
        if ret:
            return JsonResponse({"name": "mobile", "errors": "当前手机号已经被注册！"}, status=400)

        # 模型操作
        student = models.Student.objects.create(
            name=data.get("name"),
            mobile=data.get("mobile"),
            age=data.get("age"),
            status=data.get("status"),
            classmate=data.get("classmate"),
            description=data.get("description"),
        )

        # 序列化
        serializer = serializers.StudentSerializer(student)
        # 返回结果
        instance = serializer.data
        return JsonResponse(instance, status=201)

    def post2(self, request):
        """使用序列化器之后"""
        # 接收数据
        data = json.loads(request.body)
        # 实例化序列化器，用于反序列化必须填写data参数
        serializer = serializers.StudentSerializer(data=data)
        # # 调用序列化器的校验流程
        # if not serializer.is_valid():
        #     print(serializer.errors)  # 获取校验失败后的错误提示信息
        #     return JsonResponse(serializer.errors, status=400)
        # 除了自己接受is_valid的结果进行判断，手动返回错误信息以外，还可以由drf帮我们返回错误信息
        serializer.is_valid(raise_exception=True) # raise_exception=True 表示校验失败时，让drf自行返回错误给客户端

        # 模型操作
        student = models.Student.objects.create(
            name=data.get("name"),
            mobile=data.get("mobile"),
            age=data.get("age"),
            status=data.get("status"),
            classmate=data.get("classmate"),
            description=data.get("description"),
        )

        # 序列化
        serializer = serializers.StudentSerializer(student)
        # 返回结果
        instance = serializer.data
        return JsonResponse(instance, status=201)

    def post3(self, request):
        """添加数据操作，使用序列化器之后"""
        # 接收数据
        data = json.loads(request.body)
        # 实例化序列化器，用于反序列化必须填写data参数
        serializer = serializers.StudentSerializer(data=data)
        # 校验数据
        serializer.is_valid(raise_exception=True)
        # 模型操作
        serializer.save() # 因为上面实例化序列化器时没有传递instance参数，所以save自动调用模型类中的create方法
        # 返回结果
        instance = serializer.data
        return JsonResponse(instance, status=201)

    def put(self, request):
        """更新数据操作，使用序列化器之后"""
        # 此处为了方便演示，让客户端通过查询字符串传递id，指定要修改的模型对象
        id = request.GET.get("id")
        try:
            student = models.Student.objects.get(id=id)
        except models.Student.DoesNotExist:
            return JsonResponse({}, status=400)

        # 接收数据
        data = json.loads(request.body)
        # 实例化序列化器，用于反序列化必须填写data参数
        serializer = serializers.StudentSerializer(instance=student, data=data)
        # 校验数据
        serializer.is_valid(raise_exception=True)
        # 模型操作
        serializer.save()  # 因为上面实例化序列化器时有传递instance参数，所以save自动调用模型类中的update方法
        # 返回结果
        instance = serializer.data
        return JsonResponse(instance, status=201)

7.3.2.3 部分字段跳过验证阶段的方式说明¶

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

serializer.save(request=request) # 可以在save中，传递1個或多個不需要验证的数据到模型里面

2）默认序列化器必须传递所有required的字段，否则会抛出验证异常。但是我们可以使用partial参数来允许部分字段更新

# 在开发中往往有些功能，只提供某一个字段的修改操作时，可能只需要验证当前被修改的字段，而不想验证其他的字段时，可以设置partial=True。
# 这种情况有很多，例如，手机号更新绑定，修改密码或头像等等。
# 例如，当前学生模型中，我们只修改mobile字段，但是不提供其他的字段修改。则代码如下：
serializer = StudentSerializer(student, data={'mobile': '13000000000'}, partial=True)

7.3.3 模型类序列化器¶

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

ModelSerializer模型类序列化器与Serializer序列化器基类声明方式与调用方式一致，但ModelSerializer额外提供了：

基于模型类自动生成一系列字段声明
基于模型类自动为Serializer生成unique、validators、等校验规则。
默认提供了create()和update()的实现

7.3.3.1 定义¶

比如我们创建一个StudentModelSerializer

from rest_framework import serializers
from stuapi import models

"""
drf中所有的序列化器必须直接或间接继承于 serializers.Serializer
serializers.Serializer 序列化器基类
serializers.ModelSerializer 序列化器模型类，是序列化器基类的子类，提供了关于模型的自动操作
在工作中，除了Serializer基类以外，最常用的序列化器类基类
"""


class Student1Serializer(serializers.Serializer):
    """学生数据的序列化器"""
    """字段类型声明，用于声明转换给客户端的数据格式"""
    # 字段名 = serializers.字段类型()
    id = serializers.IntegerField()
    name = serializers.CharField()
    age = serializers.IntegerField()
    sex = serializers.BooleanField()
    description = serializers.CharField()
    mobile = serializers.CharField()
    status = serializers.IntegerField()
    created_time = serializers.DateTimeField()
    updated_time = serializers.DateTimeField()

    """元数据"""
    # class Meta:
    #     model = "模型类名"
    #     fields = ["字段1","字段12", ...,]
    #     fields = "__all__"

    """校验数据"""
    # def validate(self, attrs): # 全部数据的校验,attrs等价于 request.body
    #     # 校验数据的代码
    #     return attrs # 必须有返回值
    #
    # def validated_<字段名>(self, data): # 校验单个指定字段的数据
    #     return data # 必须有返回值

    """模型操作"""
    # def create(self, validated_data): # validated_data 就是校验数据后的返回结果
    #     # 模型操作代码
    #     return 模型对象

    # def update(self, instance, validated_data): # instance 表示要修改的模型对象，validated_data 就是校验数据的返回结果
    #     # 模型操作代码
    #     return 模型对象


# def check_mobile(data):
#     """定义在序列化器类外部的校验函数"""
#     # print("check_mobile, data=", data)
#     ret = models.Student.objects.filter(mobile=data).first()
#     if ret:
#         raise serializers.ValidationError(code="mobile", detail="当前手机号已经被注册！")
#     return data  # 必须把数据返回，否则后续操作中序列化器无法获取校验后的结果


class StudentSerializer(serializers.Serializer):
    """学生数据的序列化器"""
    """字段类型声明，用于声明转换给客户端的数据格式"""
    # 字段名 = serializers.字段类型()
    id = serializers.IntegerField(read_only=True) # read_only=True 限制当前字段只能在序列化阶段（用户读取数据时）
    name = serializers.CharField(required=True, error_messages={"required": "姓名不能为空!"})  # required=True 表示当前字段必填
    age = serializers.IntegerField(required=True,max_value=99, min_value=1, error_messages={"max_value": "请填写真实年龄！", "min_value": "请填写真实年龄！"})
    sex = serializers.BooleanField()
    description = serializers.CharField()
    classmate = serializers.CharField(required=True)
    # mobile = serializers.CharField(required=True, validators=[check_mobile])
    mobile = serializers.CharField(required=True)
    status = serializers.IntegerField(required=True)
    created_time = serializers.DateTimeField(read_only=True)
    updated_time = serializers.DateTimeField(read_only=True)

    # def validate_mobile(self, data):
    #     """
    #     validate_<字段名>  # 针对指定字段进行验证
    #     # validate_mobile 表示 针对mobile字段进行单独的校验，mobile也可以换成其他字段。
    #     """
    #     print("data=", data)
    #     ret = models.Student.objects.filter(mobile=data).first()
    #     if ret:
    #         raise serializers.ValidationError(code="mobile", detail="当前手机号已经被注册！")
    #
    #     return data  # 必须把数据返回，否则后续操作中序列化器无法获取校验后的结果

    def validate(self, data):
        """
        validate  # 针对客户端提交的所有字段进行验证
        # validate_mobile 表示 针对mobile字段进行单独的校验，mobile也可以换成其他字段。
        """
        # print("data=", data)
        if not self.instance:
            ret = models.Student.objects.filter(mobile=data.get("mobile")).first()
        else:
            ret = models.Student.objects.exclude(id=self.instance.id).filter(mobile=data.get("mobile")).first()

        if ret:
            raise serializers.ValidationError(code="mobile", detail="当前手机号已经被注册！")
        return data  # 必须把数据返回，否则后续操作中序列化器无法获取校验后的结果

    def create(self, validated_data):
        """
        添加模型操作
        :validated_data 校验后的客户端数据，字典格式
        视图中使用序列化器对象的save方法会自动调用这个方法
        """
        instance = models.Student.objects.create(**validated_data)
        return instance

    def update(self, instance, validated_data):
        """
        更新模型操作
        :instance 当前本次要修改的模型对象
        :validated_data 校验后的客户端数据，字典格式
        """
        # request = validated_data.pop("request")
        # print(request.META.get('REMOTE_ADDR'))
        for field, value in validated_data.items():
            setattr(instance, field, value)

        # 模型的save方法，是ORM提供的。
        instance.save()
        return instance


class StudentModelSerializer(serializers.ModelSerializer):
    # 字段声明

    # 元数据
    class Meta:
        model = models.Student
        # fields = ["id", "name", "age", "sex", "description", "classmate", "mobile", "status", "created_time", "updated_time"]
        fields = "__all__"
        # read_only_fields = ["id", "created_time", "updated_time"]  # 选填，只读字段列表，表示设置这里的字段只会在序列化阶段采用
        extra_kwargs = {
            # "字段名": {
            #     "选项": 值,
            #     "选项": 值,
            #      ...
            # },
            "name": {
                "error_messages": {"required": "姓名不能为空!"}
            },
            "age": {
                "max_value": 99,
                "min_value": 1,
            }
        }

Meta类里面必须声明2个属性：

model 指明参照哪个模型类
fields 指明为模型类的哪些字段生成

视图代码，测试：

import json
from django.views import View
from django.http.response import JsonResponse
from stuapi import models
from . import serializers


class Student3View(View):
    def get1(self,request):
        """基于模型类序列化器序列化单个模型数据"""
        # 模型读取数据
        student = models.Student.objects.first()
        # 序列化
        serializer = serializers.StudentModelSerializer(instance=student)  # 序列化单个模型，不需要声明many属性
        student_dict = serializer.data
        # 响应数据
        return JsonResponse(student_dict, safe=False)

    def get(self,request):
        """基于模型类序列化器序列化QuerySet"""
        # 模型读取数据
        student_objs = models.Student.objects.all()
        # 序列化
        serializer = serializers.StudentModelSerializer(instance=student_objs, many=True)
        student_list = serializer.data
        # 响应数据
        return JsonResponse(student_list, safe=False)

    def post(self,request):
        """基于模型类序列化器实现添加数据的校验与保存"""
        # 接收数据
        data = json.loads(request.body)
        # 实例化序列化器，用于反序列化必须填写data参数
        serializer = serializers.StudentModelSerializer(data=data)
        # 校验数据
        serializer.is_valid(raise_exception=True)
        # 模型操作
        serializer.save()  # 因为上面实例化序列化器时没有传递instance参数，所以save自动调用模型类中的create方法
        # 返回结果
        instance = serializer.data
        return JsonResponse(instance, status=201)

    def put(self,request):
        """基于模型类序列化器实现更新数据的校验与保存"""
        # 此处为了方便演示，让客户端通过查询字符串传递id，指定要修改的模型对象
        id = request.GET.get("id")
        try:
            student = models.Student.objects.get(id=id)
        except models.Student.DoesNotExist:
            return JsonResponse({"errors": "当前数据不存在！"}, status=400)

        # 接收数据
        data = json.loads(request.body)
        # 实例化序列化器
        serializer = serializers.StudentModelSerializer(instance=student, data=data)
        print(serializer)
        # 校验数据
        serializer.is_valid(raise_exception=True)
        # 模型操作
        serializer.save()  # 因为上面实例化序列化器时有传递instance参数，所以save自动调用模型类中的update方法
        # 返回结果
        instance = serializer.data
        return JsonResponse(instance, status=201)

路由代码：

from django.urls import path, re_path
from . import views

urlpatterns = [
    path("student/", views.StudentView.as_view()),
    path("s1/", views.Student1View.as_view()),
    path("s2/", views.Student2View.as_view()),
    path("s3/", views.Student3View.as_view()),
]

7.3.3.2 指定字段¶

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

class StudentModelSerializer(serializers.ModelSerializer):
    """学生信息序列化器"""
    # 1. 转换的字段声明
    # 字段名 = 字段类型(选项=选项值)
    nickname = serializers.CharField(read_only=True)

    # 2. 如果当前序列化器继承的是ModelSerializer，则需要声明调用的模型信息
    # 必须给Meta声明2个属性
    class Meta:
        model = Student        # 必填
        fields = "__all__"     # 必填，可以是字符串和列表/元组，字符串的值只能是"__all__"表示返回所有字段

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

class StudentModelSerializer(serializers.ModelSerializer):
    """学生信息序列化器"""
    # 1. 转换的字段声明
    # 字段名 = 字段类型(选项=选项值)
    nickname = serializers.CharField(read_only=True)

    # 2. 如果当前序列化器继承的是ModelSerializer，则需要声明调用的模型信息
    # 必须给Meta声明2个属性
    class Meta:
        model = Student                                       # 必填
        exclude = ['description']                             # 排除，少用，与fields互斥的。

3) 显示指明字段，如：

class StudentModelSerializer(serializers.ModelSerializer):
    """学生信息序列化器"""
    # 1. 转换的字段声明
    # 字段名 = 字段类型(选项=选项值)
    nickname = serializers.CharField(read_only=True)

    # 2. 如果当前序列化器继承的是ModelSerializer，则需要声明调用的模型信息
    # 必须给Meta声明2个属性
    class Meta:
        model = Student                                       # 必填
        fields = ["id", "name", "age", "sex","nickname"]      # 必填，可以是字符串和列表/元组

4) 指明只读字段

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

class StudentModelSerializer(serializers.ModelSerializer):
    """学生信息序列化器"""
    # 1. 转换的字段声明
    # 字段名 = 字段类型(选项=选项值)
    nickname = serializers.CharField(read_only=True)

    # 2. 如果当前序列化器继承的是ModelSerializer，则需要声明调用的模型信息
    # 必须给Meta声明2个属性
    class Meta:
        model = Student                                       # 必填
        fields = ["id", "name", "age", "sex","nickname"]      # 必填，可以是字符串和列表/元组，字符串的值只能是"__all__"表示返回所有字段
        read_only_fields = ["id","sex"]  # 选填，只读字段列表，表示设置这里的字段只会在序列化阶段采用

7.3.3.3 添加额外参数¶

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

class StudentModelSerializer(serializers.ModelSerializer):
    """学生信息序列化器"""
    # 1. 转换的字段声明
    # 字段名 = 字段类型(选项=选项值)
    nickname = serializers.CharField(read_only=True)

    # 2. 如果当前序列化器继承的是ModelSerializer，则需要声明调用的模型信息
    # 必须给Meta声明2个属性
    class Meta:
        model = Student                                       # 必填
        fields = ["id", "name", "age", "sex","nickname"]      # 必填，可以是字符串和列表/元组，字符串的值只能是"__all__"表示返回所有字段
        read_only_fields = ["id","sex"]  # 选填，只读字段列表，表示设置这里的字段只会在序列化阶段采用
        extra_kwargs = {  # 选填，字段额外选项声明
            "age": {
                "min_value": 5,
                "max_value": 20,
                "error_messages": {
                    "min_value": "年龄的最小值必须大于等于5",
                    "max_value": "年龄的最大值必须小于等于20",
                }
            },
        }