Serializers 序列化组件——ModelSerializer详解
前面学习Serializers用法时,发现所有的序列化都与我们的模型紧密相关。
django_restframework也给我提供了跟模型紧密相关的序列化器——ModelSerializer。
它会根据模型自动生成一组字段;它简单的默认实现了.update()以及.create()方法。
一、ModelSerializer序列化
1、定义ModelSerializer序列化器
# 针对models设计和声明序列化类
from rest_framework import serializers
from .models import Book, Publisher class BookSerializer(serializers.ModelSerializer):
class Meta:
model = Book # 与Book表对应 # 这三种情况不能同时使用
# 1.取全部字段
fields = "__all__" # 2.自定义包含字段
# fields = ["id", "title", "pub_time"]
# 输出:[{"id": 1, "title": "python开发", "pub_time": "2011-08-27"},...] # 3.排除某些字段
# exclude = ["id", "category","author", "publisher"]
# 输出:[{"title": "python开发", "pub_time": "2011-08-27"},...]
需要注意的是:取全部字段、取自定义字段、排除某些字段这三种筛选不能同时使用。
2、外键关系的序列化
注意:当序列化类META定义了depth时,这个序列化类中引用字段(外键)则自动变为只读。
depth 代表找嵌套关系的第几层。
class BookSerializer(serializers.ModelSerializer):
class Meta:
model = Book # 与Book表对应
fields = "__all__"
depth = 1
添加depth前,显示效果:
添加depth后,显示效果:
由上图可知,只会查看嵌套深度一层的内容。
3、自定义字段
很多字段默认显示的是选择的key值,但要给用户展示的是value值。
因此可以声明一些字段来覆盖默认字段来进行自定制。
class BookSerializer(serializers.ModelSerializer):
category = serializers.CharField(source="get_category_display") # 找到对应中文 class Meta:
model = Book # 与Book表对应
fields = "__all__"
显示效果如下所示:
4、Meta中其他关键字参数
官方文档地址:https://www.django-rest-framework.org/api-guide/serializers/
(1)指定只读字段
希望将多个字段指定为只读。推荐使用快捷的Meta选项read_only_fields,而不是显式地使用read_only=True属性添加每个字段。示例如下所示:
class BookSerializer(serializers.ModelSerializer):
chapter = serializers.CharField(source="get_chapter_display", read_only=True) class Meta:
model = Book
fields = "__all__"
depth = 1
read_only_fields = ["id"]
模型字段有设置 editable=False, AutoField 字段默认设置为只读,不需要添加到 read_only_fields 选项。
(2)给字段添加额外参数——extra_kwargs
使用extra_kwargs参数为ModelSerializer添加或修改原有的选项参数---字典格式。
# 示例一:
class BookSerializer(serializers.ModelSerializer):
chapter = serializers.CharField(source="get_chapter_display", read_only=True) class Meta:
model = Book
fields = "__all__"
depth = 1
read_only_fields = ["id"]
extra_kwargs = {"title": {"validators": [my_validate,]}} # 示例二:
class CreateUserSerializer(serializers.ModelSerializer):
class Meta:
model = User
fields = ['email', 'username', 'password']
extra_kwargs = {'password': {'write_only': True}}
如果字段已在序列化程序类中显式声明,则该extra_kwargs
选项将被忽略。
5、post和patch请求
由于depth会让外键变成只读,所以定义一个序列化的类,其实只要去掉depth就可以了。
class BookSerializer(serializers.ModelSerializer):
chapter = serializers.CharField(source="get_chapter_display", read_only=True) class Meta:
model = Book
fields = "__all__"
# fields = ["id", "title", "pub_time"]
# exclude = ["user"]
# 分别是所有字段 包含某些字段 排除某些字段
read_only_fields = ["id"]
extra_kwargs = {"title": {"validators": [my_validate,]}}
6、SerializerMethodField
外键关联的对象有很多字段是用不到的,都传给前端会有数据冗余。需要自己去定制序列化外键对象的那些字段。
# 针对models设计和声明序列化类
from rest_framework import serializers
from .models import Book, Publisher class BookSerializer(serializers.ModelSerializer):
category = serializers.CharField(source="get_category_display") # 找到对应中文 class Meta:
model = Book # 与Book表对应
fields = "__all__"
查看页面 http://127.0.0.1:8000/books/list,显示效果如下所示:
添加 SerializerMethodField的使用,获取显示外联字段:
class BookSerializer(serializers.ModelSerializer):
category = serializers.CharField(source="get_category_display") # 找到对应中文 # SerializerMethodField的使用,获取显示外联字段
publisher = serializers.SerializerMethodField()
author= serializers.SerializerMethodField() def get_author(self, obj):
authors_query_set = obj.author.all() # 拿到所有作者信息
return [{"id": authors_obj.id, "name": authors_obj.name} for authors_obj in authors_query_set] # 列表推导式 def get_publisher(self, obj):
# obj是我们序列化的每个Book对象
publisher_obj = obj.publisher # 正向查询
return {'id': publisher_obj.id} class Meta:
model = Book # 与Book表对应
fields = "__all__"
显示效果如下所示:
二、ModelSerializer反序列化
1、ModelSerializer原生POST请求
再将 SerDemo/serializers.py 下 BookSerializer 恢复为原生状态:
class BookSerializer(serializers.ModelSerializer):
class Meta:
model = Book # 与Book表对应
fields = "__all__"
不用自定义create方法,可直接提交提交post请求如下:
数据新增成功,如下所示:
2、SerializerMethodField改写
class BookSerializer(serializers.ModelSerializer):
# SerializerMethodField的使用,获取显示外联字段
category_display = serializers.SerializerMethodField(read_only=True) # 重新定义,避免重写,影响反序列化
publisher_info = serializers.SerializerMethodField(read_only=True)
authors = serializers.SerializerMethodField(read_only=True) def get_category_display(self, obj):
return obj.get_category_display() # ORM方法获取中文 def get_authors(self, obj):
authors_query_set = obj.author.all() # 拿到所有作者信息
return [{"id": authors_obj.id, "name": authors_obj.name} for authors_obj in authors_query_set] # 列表推导式 def get_publisher_info(self, obj):
# obj是我们序列化的每个Book对象
publisher_obj = obj.publisher # 正向查询
return {'id': publisher_obj.id} class Meta:
model = Book # 与Book表对应
fields = "__all__"
显示效果如下所示:
可以从上图看到,除了显示了category_display、authors、publisher_info,也显示了category、publisher、author。
3、extra_kwargs配置字段参数
class BookSerializer(serializers.ModelSerializer):
# SerializerMethodField的使用,获取显示外联字段
category_display = serializers.SerializerMethodField(read_only=True) # 重新定义,避免重写,影响反序列化
publisher_info = serializers.SerializerMethodField(read_only=True)
authors = serializers.SerializerMethodField(read_only=True) def get_category_display(self, obj):
return obj.get_category_display() # ORM方法获取中文 def get_authors(self, obj):
authors_query_set = obj.author.all() # 拿到所有作者信息
return [{"id": authors_obj.id, "name": authors_obj.name} for authors_obj in authors_query_set] # 列表推导式 def get_publisher_info(self, obj):
# obj是我们序列化的每个Book对象
publisher_obj = obj.publisher # 正向查询
return {'id': publisher_obj.id} class Meta:
model = Book # 与Book表对应
fields = "__all__"
extra_kwargs = {
"category": {"write_only": True}, # 避免直接改写
"publisher": {"write_only": True},
"author": {"write_only": True}
}
如此就不再显示category、publisher、author了,显示效果如下所示:
三、Serializer与ModelSerializer区别
Serializers 序列化组件——ModelSerializer详解的更多相关文章
- Serializers 序列化组件
Serializers 序列化组件 为什么要用序列化组件 当我们做前后端分离的项目~~我们前后端交互一般都选择JSON数据格式,JSON是一个轻量级的数据交互格式. 那么我们给前端数据的时候都要转 ...
- Django-Rest-Framework的序列化之serializers 序列化组件
Django-Rest-Framework的序列化之serializers 序列化组件 restful framework 正常的序列化 from django.http import HttpRes ...
- [安卓基础] 009.组件Activity详解
*:first-child { margin-top: 0 !important; } body > *:last-child { margin-bottom: 0 !important; } ...
- 第15.10节 PyQt(Python+Qt)入门学习:Qt Designer可视化设计界面组件与QWidget类相关的组件属性详解
PyQt学习有阵子了,对章节的骨架基本考虑好了,准备本节就写组件的属性的,结果一是日常工作繁忙,经常晚上还要加班,二是Qt的组件属性很多,只能逐一学习.研究和整理,花的时间有点长,不过终于将可视化设计 ...
- DRF框架之 serializers 序列化组件
1. 什么是序列化,其实在python中我们就学了序列化工具json工具,就是吧信息存为类字典形式 2. DRF框架自带序列化的工具: serializers 3. DRF框架 serializers ...
- drf3 Serializers 序列化组件
为什么要用序列化组件 做前后端分离的项目,我们前后端交互一般都选择JSON数据格式,JSON是一个轻量级的数据交互格式. 给前端数据的时候都要转成json格式,那就需要对从数据库拿到的数据进行序列化. ...
- django rest_framework Serializers 序列化组件
为什么要用序列化组件 当我们做前后端分离的项目~~我们前后端交互一般都选择JSON数据格式,JSON是一个轻量级的数据交互格式. 那么我们给前端数据的时候都要转成json格式,那就需要对我们从数据库拿 ...
- 【转】Serializers 序列化组件
https://www.cnblogs.com/MayDayTime/p/9890582.html 为什么要用序列化组件 当我们做前后端分离的项目~~我们前后端交互一般都选择JSON数据格式,JSON ...
- drf框架 - 序列化组件 | ModelSerializer (查,增,删,改)
ModelSerializer 序列化准备: 配置 settings.py # 注册rest_framework框架 INSTALLED_APPS = [ ... 'rest_framework' ] ...
随机推荐
- 小程序-小菊花loading
界面----交互 wx.showLoading() 显示loading提示框.需主动调用wx.hideLoading()才能关闭提示框 参数: 属性 类型 默认值 必填 说明 title string ...
- bzoj5092 分割序列
题目链接 problem 对于一个长度为n的非负整数序列\(b_1,b_2,...,b_n\),定义这个序列的能量为:\(f(b)=\max\limits_{i=0,1,...,n}(b_1 \oti ...
- vs2010,vs2013,vs2015,vs2017, vs2019激活秘钥
vs2010============================================== YCFHQ9DWCYDKV88T2TMHG7BHP vs2013=============== ...
- 前端笔记之Vue(三)生命周期&CSS预处理&全局组件&自定义指令
一.Vue的生命周期 生命周期就是指一个对象的生老病死的过程. 用Vue框架,熟悉它的生命周期可以让开发更好的进行. 所有的生命周期钩子自动绑定 this 上下文到实例中,因此你可以访问数据,对属性和 ...
- gitlab的安装配置与简单使用
安装 gitlab,建议系统内存 6G ,不然会报错. 一.如何安装 gitlab 下载 gitlab 的 RPM 包 https://packages.gitlab.com/gitlab/gitla ...
- 解决No 'Access-Control-Allow-Origin' header is present on the requested resource.跨域问题
跨域错误 错误原因 解决方法在后台写一个过滤器过滤器来改写请求头头 CorsFilter.java public class CorsFilter implements Filter { @Overr ...
- Web前端——css
css 推荐的样式编写顺序: Positioning:定位 Box model:盒子模型.大小等 Typographic:文字系列.排印等 Visual:可视化.背景等 Misc:其它混杂模式 居中 ...
- git clone: HTTP Basic: Access denied 错误
git clone 报 HTTP Basic: Access denied 错误 解决方案: 1. 如果账号密码有变动 用这个命令 git config –-system –-unset creden ...
- Python3---常见函数---open()
前言 该文章描述了Python3函数open的作用,以及使用方法. 修改时间:20191220 天象独行 函数open(name,mode,buffering)作用是打开一个文件,并且创建一个file ...
- XHR 对象实例所有的配置、属性、方法、回调和不可变值
当我们声明了一个XMLHttpRequest对象的实例的时候,使用for-in来循环遍历一下这个实例(本文使用的是chrome45版本浏览器),我们会发现在这个实例上绑定了一些内容,我把这些内容进行了 ...