Title(EN): Django REST Framework Learning Notes (8): the ModelSerializer class in serialziers module
Author: dog2

基本信息

源码：rest_framework.serializers
官方文档
- API Guide - Serializers
- API Guide - Serializer fields
- API Guide - Serializer relations
本文demo代码Github

DRF常用序列化类主要有

rest_framework.serialziers.Serializer
rest_framework.serialziers.ModelSerializer
rest_framework.serialziers.ListSerializer

本篇介绍rest_framework.serialziers.ModelSerializer ，将结合图书管理系统实例说明。

序列化以外的其他配置

`settings.py`

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

LANGUAGE_CODE = 'zh-hans'
TIME_ZONE = 'Asia/Shanghai'
USE_I18N = True
USE_L10N = True
USE_TZ = False

MEDIA_URL = '/media/'
MEDIA_ROOT = os.path.join(BASE_DIR, 'media')

全局`url.py`

from django.contrib import admin
from django.urls import path, include
from django.conf import settings
from django.conf.urls.static import static

urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/', include('api.urls')),
] + static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)

数据库表

表一览

BaseModel基表：is_delete、create_time

下面四表继承基表，可以继承两个字段

Book表：name、price、img、authors、publish、is_delete、create_time
Publish表：name、address、is_delete、create_time
Author表：name、age、is_delete、create_time
AuthorDetail表：mobile, author、is_delete、create_time

基表代码

models.py

class BaseModel(models.Model):
    is_delete = models.BooleanField(default=False)
    create_time = models.DateTimeField(auto_now_add=True)

    # 设置 abstract = True 来声明基表，作为基表的Model不能在数据库中形成对应的表
    class Meta:
        abstract = True

断关联多表关系（重点）

外键位置：

一对多：外键放多的一方
一对一：从逻辑正反向考虑，如作者表与作者详情表，作者删除级联作者详情也删除，详情删除作者依旧存在，所以建议外键在详情表中（和之前的一对一关系外键放置不一样，之前都是把外键放在查询频率高的表）
多对多：外键在关系表中

ORM正向方向连表查找：(注：依赖代码见下方)
- 正向：通过外键字段 eg: author_detial_obj.author，外键设置在作者详情表，在作者详情表中查询作者直接.author就可以
- 反向：通过设置反向查询related_name的值 eg：author_obj.detail，外键没有设置在作者表中，在作者表中通过设置反向查询.detail查询作者详情
连表操作关系：（注：拿作者与作者详情表举例，外键建在作者详情表中）
- 作者删除，详情级联
  1
  on_delete=models.CASCADE #跟着一起删除
- 作者删除，详情置空
  1
  null=True, on_delete=models.SET_NULL #外键字段清空
- 作者删除，详情重置
  1
  default=0, on_delete=models.SET_DEFAULT
- 作者删除，详情不动
  1
  on_delete=models.DO_NOTHING

外键关联字段的参数：如何实现断关联、目前表间操作关系、方向查询字段

作者详情表中的（外键设置在作者详情表中）

author = models.OneToOneField(
    to='Author',       #和作者表关联
    related_name='detail',   #反查询，作者表直接查作者详情表的电话号码，可以直接author_obj.detail.mobile
    db_constraint=False,     #断关联
    on_delete=models.CASCADE  #级联删除
)

图书表中的

publish = models.ForeignKey(
    to='Publish',
    related_name='books',
    db_constraint=False,
    on_delete=models.DO_NOTHING,
)
authors = models.ManyToManyField(
    to='Author'
    related_name='books',
    db_constraint=False,
)

注意：

ManyToManyField不能设置on_delete
OneToOneField、ForeignKey必须设置on_delete（django1.x系统默认级联，但是django2.x必须手动明确）

各表代码

models.py

from django.db import models

# 基类
class BaseModel(models.Model):
    is_delete = models.BooleanField(default=False)  # 默认不是删除，数据库中是0/1
    create_time = models.DateTimeField(auto_now_add=True)

    # 设置 abstract = True 来声明基表，作为基表的Model不能在数据库中形成对应的表
    class Meta:
        abstract = True  # 声明该表只是一个抽象表不出现在数据库中

# 书籍表
class Book(BaseModel):
    name = models.CharField(max_length=64)
    price = models.DecimalField(max_digits=5, decimal_places=2)
    img = models.ImageField(upload_to='img', default='default.jpg')
    # 关联出版社表
    publish = models.ForeignKey(
        to='Publish',  # 关联publish表
        db_constraint=False,  # 断关联（断开Book表和Publish表的关联,方便删数据,虽然断开了关联但是还能正常使用）
        related_name='books',  # 反向查询字段：publish_obj.books就能查出当前出版社出版的的所有书籍
        on_delete=models.DO_NOTHING,  # 设置连表操作关系
    )
    # 关联作者表
    authors = models.ManyToManyField(
        to='Author',
        db_constraint=False,  # 断开关联
        related_name='books',  # 反向查询字段
    )

    # 序列化插拔式属性 - 完成自定义字段名完成连表查询
    @property
    def publish_name(self):  # 自定义查询出版社名字
        return self.publish.name

    @property
    def author_list(self):
        return self.authors.values('name', 'age', 'detail__mobile').all()

    class Meta:
        db_table = 'book'
        verbose_name = '书籍'
        verbose_name_plural = verbose_name

        unique_together = ('name', 'publish')

    def __str__(self):
        return self.name

# 出版社表
class Publish(BaseModel):
    """name、address、is_delete、create_time"""
    name = models.CharField(max_length=64)
    address = models.CharField(max_length=64)

    class Meta:
        db_table = 'publish'
        verbose_name = '出版社'
        verbose_name_plural = verbose_name

    def __str__(self):
        return self.name

# 作者表
class Author(BaseModel):
    """name、age、is_delete、create_time"""
    name = models.CharField(max_length=64)
    age = models.IntegerField()

    class Meta:
        db_table = 'author'
        verbose_name = '作者'
        verbose_name_plural = verbose_name

    def __str__(self):
        return self.name

# 作者详情
class AuthorDetail(BaseModel):
    """mobile, author、is_delete、create_time"""
    mobile = models.CharField(max_length=11)
    author = models.OneToOneField(
        to='Author',
        db_constraint=False,
        related_name='detail',
        on_delete=models.CASCADE
    )

    class Meta:
        db_table = 'author_detail'
        verbose_name = '作者详情'
        verbose_name_plural = verbose_name

    def __str__(self):
        return self.author.name

serializers.ModelSerializer

序列化 & 反序列化

序列化

ModelSerializer模型类序列化器与常规的Serializer相同，但提供了：

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

序列化层 `api/serializers.py`

Source Code

from rest_framework.serializers import ModelSerializer, SerializerMethodField
from rest_framework.exceptions import ValidationError
from . import models

# 可以单独作为Publish接口的序列化类，也可以作为Book序列化外键publish辅助的序列化组件
class PublishModelSerializer(ModelSerializer):
    class Meta:
        model = models.Publish
        fields = ('name', 'address')

# Book接口序列化
class BookModelSerializer(ModelSerializer):
    # 了解: 1.还可以自定义设置序列化字段，但是必须在fields中声明，在fields中写publish_address
    # publish_address = SerializerMethodField()
    # def get_publish_address(self, obj):
    #     return obj.publish.address

    # 2. 自定义连表深度-子序列化方式-该方式不能参与反序列化，使用在序列化和反序列化共存时，不能书写
    publish = PublishModelSerializer()

    class Meta:
        # 序列化类关联的model类
        model = models.Book
        # 参与序列化的字段
        fields = ('name', 'price', 'img', 'author_list', 'publish')

        # 了解知识点
        # 所有字段
        # fields = '__all__'
        # 与fields不共存，exclude排除哪些字段
        # exclude = ('id', 'is_delete', 'create_time')
        # 自动连表深度
        # depth = 1

视图层 `views.py`

Source Code

from rest_framework.views import APIView
from rest_framework.response import Response
from . import models,serializers

class Book(APIView):
    def get(self, request, *args, **kwargs):
        pk = kwargs.get('pk')
        # 单查
        if pk:
            try:
                book_obj = models.Book.objects.get(pk=pk, is_delete=False)
                book_data = serializers.BookModelSerializer(
                    book_obj).data  # 单条数据序列化
            except Exception as err:
                return Response({
                    'status': 1,
                    'msg': '数据不存在'
                })
        # 群查
        else:
            book_query = models.Book.objects.filter(
                is_delete=False).all()  # 先筛选查询,再查所有
            book_data = serializers.BookModelSerializer(
                book_query, many=True).data  # 不管是一条还是多条，只要数据是被[]嵌套，都要写many=True
        # 返回前端数据
        return Response({
            'status': 0,
            'msg': 'ok',
            'results': book_data
        })

子路由层 `api/urls.py`

urlpatterns = [
    path('v1/books/', views.Book.as_view()),
    path('v1/books/<pk>/', views.Book.as_view()),
]

反序列化

序列化层 `api/serializers.py`

Source Code

class BookModelDeserializer(ModelSerializer):
    # 一些只参与反序列化的字段，但是不是与数据库关联的，自定义不入库的反序列化的字段
    # 自定义字段的 read_only属性必须定义在CharField，不能写在下方的extra_kwargs中，否则会被传入models.Book进行反序列化而报错
    re_name = CharField(read_only=True)

    class Meta:
        model = models.Book
        exclude = ['is_delete', 'create_time', 'img']
        # fields = ('name', 'price', 'publish', 'authors','re_name')  #没有默认值的字段必须序列化，为其传值
        # extra_kwargs 用来完成反序列化字段的 系统校验规则
        extra_kwargs = {
            'name': {
                'required': True,  # 设置name字段必填
                'min_length': 1,
                'error_messages': {
                    'required': '必填项',
                    'min_length': '太短',
                },
            },
        }

    # 局部钩子校验单个字段  validate_字段名
    def validate_name(self, value):  # value是字段name的值
        # 书名不能包含 g 字符
        if 'g' in value.lower():
            raise ValidationError('该g书不能出版')
        return value
    # 全局钩子

    def validate(self, attrs):
        publish = attrs.get('publish')  # publish如果是外键字段，这个就是publish对象
        name = attrs.get('name')
        if models.Book.objects.filter(name=name, publish=publish):
            raise ValidationError({'book': '该书已存在'})
        return attrs

    # 注意：ModelSerializer类已经帮我们实现了 create 与 update 方法,不需要写create就能创建

视图层 `views.py`

class Book(APIView):
    def post(self, request, *args, **kwargs):
        request_data = request.data
        book_ser = serializers.BookModelDeserializer(data=request_data)
        # raise_exception=True：当校验失败，马上终止当前视图方法，抛异常返回给前台
        book_ser.is_valid(raise_exception=True)
        book_obj = book_ser.save()
        return Response({
            'status': 0,
            'msg': 'ok',
            'results': serializers.BookModelSerializer(book_obj).data
        })

子路由层 `api/urls.py`

urlpatterns = [
    path('v1/books/', views.Book.as_view()),
    path('v1/books/<pk>/', views.Book.as_view()),
]

注意点

反序列化层：
- 在设置fields，没有默认值的字段都必须设置反序列化保存到数据库中
- 使用extra_kwargs 来设置系统校验规则
- 设置局部钩子和全局钩子
- ModelSerializer类已经帮我们实现了 create 与 update 方法，不需要再写
视图层：
- POST请求通过request.data拿到数据包
- 传给反序列化 ,通过data=request_data传入需要反序列化的数据
- is_valid判断校验是否合格，raise_exception=True必须要写的
- 通过.save()保存到数据库中

序列化与反序列化整合

序列化层 `api/serializers.py`

Source Code

class V2BookModelSerializer(ModelSerializer):
    # 一些只参与反序列化的字段，但是不是与数据库关联的，自定义不入库的反序列化的字段
    re_name = CharField(read_only=True)

    class Meta:
        model = models.Book
        fields = ('name', 'price', 'img', 'author_list',
                  'publish_name', 'publish', 'authors', 're_name')
        extra_kwargs = {
            'name': {
                'required': True,
                'min_length': 1,
                'error_messages': {
                    'required': '必填项',
                    'min_length': '太短',
                }
            },
            'publish': {
                'write_only': True
            },
            'authors': {
                'write_only': True
            },
            'img': {
                'read_only': True,
            },
            'author_list': {
                'read_only': True,
            },
            'publish_name': {
                'read_only': True,
            }
        }

    def validate_name(self, value):
        # 书名不能包含 g 字符
        if 'g' in value.lower():
            raise ValidationError('该g书不能出版')
        return value

    def validate(self, attrs):
        publish = attrs.get('publish')
        name = attrs.get('name')
        # 视频里使用这种验证方式，实际是不合理的，因为会导致针对价格修改的PUT请求失败(name&publish已存在)
        # 因此在这里将其注释掉 ，正确的方式是在models.Book中对这两个字段的共同唯一性作约束
        # 而本函数通常作为对不同attr的对比验证，如两次输入密码是否一致等
        # if models.Book.objects.filter(name=name, publish=publish):
        #     raise ValidationError({'book': '该书已存在'})
        return attrs

注意点

fields中设置所有序列化与反序列化字段
extra_kwargs划分只序列化或只反序列化字段（一般我们把需要存入到数据库中的使用write_only（反序列化）,只需要展示的就read_only(序列化)，看需求设计）
- write_only：只反序列化
- read_only：只序列化
- 自定义字段默认只序列化(read_only)
- 如果字段没设置write_only或者read_only，那么该字段可以序列化和反序列化
设置反序列化所需的系统、局部钩子、全局钩子等校验规则

视图层 `views.py`

Source Code

class V2Book(APIView):
    def get(self, request, *args, **kwargs):
        pk = kwargs.get('pk')
        # 单查
        if pk:
            try:
                book_obj = models.Book.objects.get(pk=pk, is_delete=False)
                book_data = serializers.V2BookModelSerializer(
                    book_obj).data  # 序列化
            except:
                return Response({
                    'status': 1,
                    'msg': '参数有误'
                })
        # 群查
        else:
            book_query = models.Book.objects.filter(is_delete=False).all()
            book_data = serializers.V2BookModelSerializer(
                book_query, many=True).data  # 序列化

        return Response({
            'status': 0,
            'msg': 'ok',
            'results': book_data
        })

    def post(self, request, *args, **kwargs):
        # 单增:传的数据是与model对应的一个字典
        # 群增：设计传递的是多个model对应的字典列表,在postman中通过列表嵌套字典传值
        request_data = request.data
        if isinstance(request_data, dict):  # 判断获取的数据是否是dict
            many = False
        elif isinstance(request_data, list):  # 判断获取的数据是否是list
            many = True
        else:
            return Response({
                'status': 1,
                'msg': '数据错误'
            })
        book_ser = serializers.V2BookModelSerializer(
            data=request_data, many=many)  # 反序列化
        book_ser.is_valid(raise_exception=True)
        # book_result是对象<class 'app01.models.Book'>，群增就是列表套一个个对象
        book_result = book_ser.save()

        return Response({
            'status': 0,
            'msg': 'ok',
            'results': serializers.V2BookModelSerializer(book_result, many=many).data
        })

    # 单删: 有pk   #在postman中通过路径传参
    # 群删：有pks   {"pks": [1, 2, 3]}   #通过json传参
    def delete(self, request, *args, **kwargs):
        pk = kwargs.get('pk')
        if pk:
            pks = [pk]
        else:
            pks = request.data.get('pks')
        if models.Book.objects.filter(pk__in=pks, is_delete=False).update(is_delete=True):
            return Response({
                'status': 0,
                'msg': '删除成功'
            })
        return Response({
            'status': 1,
            'msg': '删除失败'
        })

注意点

序列化数据最后必须要.data （因为要传给前端）
反序列化通过data传参，序列化通过instance传参（当你只传一个参数时，默认是instance的参数）
反序列化与序列化都能使用many=True，序列化和反序列化数据只要被[]嵌套都要写many=True

子路由层 `api/urls.py`

urlpatterns = [
    path('v2/books/', views.V2Book.as_view()),
    path('v2/books/<pk>/', views.V2Book.as_view()),
]

使用场景总结

序列化类初始化时，instance/data/many/partial 是影响序列化对象行为的四个关键参数。

序列化角度

序列化

如果没有data参数，只有instance，那么就不存在反序列化校验一说，只有序列化对象instance。

1 2	# 序列化get （给前端传递参数） #查询 ser_obj = ModelSerializer(model_obj) #只传递一个参数，默认是instance的参数，查询数据

反序列化

如果有data，没有instance，则需要调用is_valid方法校验data，然后将data进行反序列化，得到validated_data，此时再通过序列化对象获取data，这个data和初始化提供的data不同，是序列化validated_data后的data，比起初始化data，可能减少了无效的字段（序列化没有定义的字段）。

1 2	# 反序列化post save() => create()（数据保存到数据库中） #添加 ser_obj = ModelSerializer(data=model_data) #传递data参数，保存数据

数据操作角度（增删改查）

修改场景

如果同时提供了instance及data, 那么只要有data或者部分data，data都要进行验证才能进行下面的save等操作，如果不经过is_valid过程，那么后面的获取序列化数据或者反序列化数据都会无效。
要用instance指明要修改的对象partial用于部分更新，之所以要伴随instance，是因为要指明给save用，在save操作时给那个instance部分更新。逻辑这回走到下面源码中的get_initial()获取要进行更新instance的字段数据。

单改

单整体改，说明前台要提供修改的数据，修改之后保存的数据需要校验，校验的数据应该在实例化“序列化类对象”时，赋值给data
修改，就必须明确被修改的模型类对象，并在实例化“序列化类对象”时，赋值给instance，必须赋值给instance
整体修改，所有校验规则有required=True的字段，都必须提供，因为在实例化“序列化类对象”时，参数partial默认为False

整体改(`PUT`)

V2BookModelSerializer(
    instance=model_obj, # 要被更新的对象
    data=model_data, # 用来更新的数据
    partial=False, # 默认False，必须的字段全部参与校验
)

局部改(`PATCH`)

V2BookModelSerializer(
    instance=model_obj, # 要被更新的对象, 
    data=model_data, # 用来更新的数据,
    partial=True, # 设置True，必须的字段都变为选填字段
)
    # 注：partial设置True的本质就是使字段 required=True 校验规则失效

群改 `ListSerializer`

many参数将直接影响序列化类的类型，如果是many=False，那么直接使用当前序列化类。如果many=True，将实例化一个ListSerializer类来序列化或者反序列化类。

在前面的代码中，我们在V2BookModelSerializer类中并没有做对多对象序列化的特殊处理，但V2版本的api仍然支持群增和群删操作。究其原因，是由于BaseSerializer.__new__方法）或者class Meta:中定义了list_serializer_class指定的多对象序列化类。

关于 ListSerializer的详细介绍请看下一篇。

给序列化类传入自定义数据

视图类views.py使用context传递参数给序列化类serializers.py

方法

在视图类中实例化序列化对象时，可以设置context内容
在序列化类中的局部钩子、全局钩子、create、update方法中，都可以用self.context访问视图类传递过来的内容。

使用场景

例如有类似如下需求时：

在视图类views中，可以通过request得到登陆用户request.user
在序列化类中，要完成数据库数据的校验与入库操作，可能会需要知道当前的登陆用户，但序列化类默认无法访问request

因此在视图类中实例化序列化对象时，将request对象传递进去

示例代码

视图层 `views.py`

class Book(APIView):
    def post(self, request, *args, **kwargs):
        book_ser = serializers.BookModelSerializer(data=request_data,context={'request':request})   #视图层context传递参数
        book_ser.is_valid(raise_exception=True)
        book_result = book_ser.save()
        return Response({
            'status': 0,
            'msg': 'ok',
            'results': serializers.BookModelSerializer(book_result).data
        })

序列化层 `serializers.py`

class BookModelSerializer(ModelSerializer):
    class Meta:
        model = models.Book
        fields = ('name', 'price')
    def validate_name(self, value):
        print(self.context.get('request').method)  #序列化层接收参数
        return value

扩展阅读

django rest framework serializers小结

基本信息

序列化以外的其他配置

settings.py

全局url.py

数据库表

表一览

基表代码

断关联多表关系（重点）

各表代码

serializers.ModelSerializer

序列化 & 反序列化

序列化

序列化层 api/serializers.py

视图层 views.py

子路由层 api/urls.py

反序列化

序列化层 api/serializers.py

视图层 views.py

子路由层 api/urls.py

注意点

序列化与反序列化整合

序列化层 api/serializers.py

注意点

视图层 views.py

注意点

子路由层 api/urls.py

使用场景总结

序列化角度

序列化

反序列化

数据操作角度（增删改查）

修改场景

单改

整体改(PUT)

局部改(PATCH)

群改 ListSerializer

给序列化类传入自定义数据

方法

使用场景

示例代码

视图层 views.py

序列化层 serializers.py

扩展阅读

`settings.py`

全局`url.py`

序列化层 `api/serializers.py`

视图层 `views.py`

子路由层 `api/urls.py`

序列化层 `api/serializers.py`

视图层 `views.py`

子路由层 `api/urls.py`

序列化层 `api/serializers.py`

视图层 `views.py`

子路由层 `api/urls.py`

整体改(`PUT`)

局部改(`PATCH`)

群改 `ListSerializer`

视图层 `views.py`

序列化层 `serializers.py`