(三) DRF 序列化

1、单表的GET和POST:

使用serializers序列化，针对每个表，须要单独写函数。通常会写在views.py里面，可是这样作，会致使整个文件代码过长。须要分离出来！

在app01(应用名)目录下，建立文件app01_serializers.py，表示自定义序列化

from app01 import models from rest_framework import serializers # 序列化评论的类 class CommentSerializer(serializers.ModelSerializer): class Meta: model = models.Comment # Comment表 fields = "__all__" # 序列化全部字段 depth = 2  # 深度为2

views.py中

from rest_framework.views import APIView from app01 import app01_serializers # 导入自定义的序列化 class Comment(APIView):
 def get(self, request): res = {"code":0} # 默认状态 all_comment = models.Comment.objects.all() # print(all_comment) # 序列化,many=True表示返回多条 ser_obj = app01_serializers.CommentSerializer(all_comment, many=True) res["data"] = ser_obj.data return JsonResponse(res)

 

2、Response

Rest framework 引入了Response对象，它是一个TemplateResponse类型，并根据客户端需求正确返回须要的类型。

使用前，须要导入模块Response

from rest_framework.response import Response

举例：

修改视图Comment中的get方法，将JsonResponse改为Response

 

from rest_framework.views import APIView
from app01 import app01_serializers  # 导入自定义的序列化
from rest_framework.response import Response

# Create your views here. class Comment(APIView): def get(self, request): res = {"code":0} # 默认状态 all_comment = models.Comment.objects.all() # print(all_comment) # 序列化,many=True表示返回多条 ser_obj = app01_serializers.CommentSerializer(all_comment, many=True) res["data"] = ser_obj.data return Response(res)

 

3、serializers校验

举例：判断空数据

修改views.py，添加post逻辑代码。注意：使用is_valid校验

from rest_framework.views import APIView from app01 import app01_serializers # 导入自定义的序列化 from rest_framework.response import Response # Create your views here. class Comment(APIView): def get(self, request): res = {"code":0} # 默认状态 all_comment = models.Comment.objects.all() # print(all_comment) # 序列化,many=True表示返回多条 ser_obj = app01_serializers.CommentSerializer(all_comment, many=True) res["data"] = ser_obj.data return Response(res) def post(self, request): res = {"code": 0} # 去提交的数据 comment_data = self.request.data # 对用户提交的数据作校验 ser_obj = app01_serializers.CommentSerializer(data=comment_data) if ser_obj.is_valid(): # 表示数据没问题，能够建立 pass else: # 表示数据有问题 res["code"] = 1 res["error"] = ser_obj.errors return Response(res)

使用postman发送一个空数据的post请求

它返回This field is required，表示次字段不能为空！

错误信息中文显示

修改app01_serializers.py，使用extra_kwargs指定错误信息

from app01 import models from rest_framework import serializers # 序列化评论的类 class CommentSerializer(serializers.ModelSerializer): class Meta: model = models.Comment # Comment表 fields = "__all__" # 序列化全部字段 depth = 2 # 深度为2 # 定义额外的参数 extra_kwargs = { "content": { "error_messages": { "required": '内容不能为空', } }, }

重启django，从新发送空的post请求

 

4、外键的GET和POST

序列化校验

上面虽然只发送了content参数，就让经过了，显然不合理！为何呢？

由于app01_comment表有2个字段，content和article。这2个字段都应该校验才对！

由于serializers默认校验时，排除了外键字段。好比article

要对外键进行校验，必须在extra_kwargs中指定外键字段

修改app01_serializers.py，注意关闭depth参数

当序列化类MATE中定义了depth时，这个序列化类中引用字段（外键）则自动变为只读，因此进行更新或者建立操做的时候不能使用此序列化类

大概意思就是，使用了depth参数，会忽略外键字段

完整代码以下：

from app01 import models from rest_framework import serializers # 序列化评论的类 class CommentSerializer(serializers.ModelSerializer): class Meta: model = models.Comment # Comment表 fields = "__all__" # 序列化全部字段 # depth = 2 # 深度为2 # 定义额外的参数 extra_kwargs = { "content": { "error_messages": { "required": '内容不能为空', } }, "article": { "error_messages": { "required": '文章不能为空' } } }

再次发送post请求，仍是只有一个参数content

查看执行结果：

发送正确的2个参数

 

查看结果

read_only=True

read_only：True表示不容许用户本身上传，只能用于api的输出。若是某个字段设置了read_only=True，那么就不须要进行数据验证，只会在返回时，将这个字段序列化后返回

 举例：容许article不校验

修改app01_serializers.py，加入一行代码

article = serializers.SerializerMethodField(read_only=True)

from app01 import models from rest_framework import serializers # 序列化评论的类 class CommentSerializer(serializers.ModelSerializer): article = serializers.SerializerMethodField(read_only=True) class Meta: model = models.Comment # Comment表 fields = "__all__" # 序列化全部字段 # depth = 2 # 深度为2 # 定义额外的参数 extra_kwargs = { "content": { "error_messages": { "required": '内容不能为空', } }, "article": { "error_messages": { "required": '文章不能为空' } } }

保存POST数据

修改views.py，在post方法中，将pass改为ser_obj.save()，完整代码以下：

from rest_framework.views import APIView from app01 import app01_serializers # 导入自定义的序列化 from rest_framework.response import Response # Create your views here. class Comment(APIView): def get(self, request): res = {"code":0} # 默认状态 all_comment = models.Comment.objects.all() # print(all_comment) # 序列化,many=True表示返回多条 ser_obj = app01_serializers.CommentSerializer(all_comment, many=True) res["data"] = ser_obj.data return Response(res) def post(self, request): res = {"code": 0} # 去提交的数据 comment_data = self.request.data # 对用户提交的数据作校验 ser_obj = app01_serializers.CommentSerializer(data=comment_data) if ser_obj.is_valid(): # 表示数据没问题，能够建立 ser_obj.save() else: # 表示数据有问题 res["code"] = 1 res["error"] = ser_obj.errors return Response(res)

修改app01_serializers.py，注释掉read_only=True

发送2个正确的参数

查看app01_comment表记录，发现多了一条记录

为何直接save，就能够保存了呢？

由于它将校验过的数据传过去了，就好像form组件中的self.cleaned_data同样

本质上仍是调用ORM的create()方法

 

5、非serializer 的验证条件

好比重置密码、修改密码都须要手机验证码。可是用户 model 里面并无验证码这个选项

须要使用validate，用于作校验的钩子函数，相似于form组件的clean_字段名

使用时，须要导入模块，用来输出错误信息

from rest_framework.validators import ValidationError

局部钩子

validate_字段名，表示局部钩子。

举例：评论的内容中，不能包含 "草"

修改app01_serializers.py，校验评论内容

from app01 import models from rest_framework import serializers from rest_framework.validators import ValidationError # 序列化评论的类 class CommentSerializer(serializers.ModelSerializer): # article = serializers.SerializerMethodField(read_only=True) # 用于作校验的钩子函数，相似于form组件的clean_字段名 def validate_content(self, value): if '草' in value: raise ValidationError('不符合社会主义核心价值观！') else: return value class Meta: model = models.Comment # Comment表 fields = "__all__" # 序列化全部字段 # depth = 2 # 深度为2 # 定义额外的参数 extra_kwargs = { "content": { "error_messages": { "required": '内容不能为空', } }, "article": { "error_messages": { "required": '文章不能为空' } } }

使用postman发送包含关键字的评论

查看返回结果：

全局钩子

validate，表示全局钩子。

好比在用户注册时，咱们须要填写验证码，这个验证码只须要验证，不须要保存到用户这个Model中：

def validate(self, attrs): del attrs["code"] return attrs

 

6、超连接的序列化

HyperlinkedModelSerializer类相似于ModelSerializer类，不一样之处在于它使用超连接来表示关联关系而不是主键。

默认状况下序列化器将包含一个url字段而不是主键字段。

url字段将使用HyperlinkedIdentityField字段来表示，模型的任何关联都将使用HyperlinkedRelatedField字段来表示。

你能够经过将主键添加到fields选项中来显式的包含，例如：

class AccountSerializer(serializers.HyperlinkedModelSerializer): class Meta: model = Account fields = ('url', 'id', 'account_name', 'users', 'created')

绝对和相对URL

当实例化一个HyperlinkedModelSerializer时，你必须在序列化器的上下文中包含当前的request值，例如：

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

这样作将确保超连接能够包含恰当的主机名，一边生成彻底限定的URL，例如：

http://api.example.com/accounts/1/

而不是相对的URL，例如：

/accounts/1/

若是你真的要使用相对URL，你应该明确的在序列化器上下文中传递一个{'request': None}。

 

需求：要求api返回结果中，school展现的是超连接

修改app01_urls.py，增长路由

urlpatterns = [ # 文章 url(r'article/', views.Article.as_view()), url(r'article/(?P<pk>\d+)', views.ArticleDetail.as_view(), name='article-detail'), # 学校 url(r'school/(?P<id>\d+)', views.SchoolDetail.as_view(), name='school-detail'), # 评论 url(r'comment/', views.Comment.as_view()), ]

指定name是为作反向连接，它能解析出绝对url

序列化

修改app01_serializers.py

from app01 import models from rest_framework import serializers from rest_framework.validators import ValidationError # 序列化评论的类 class CommentSerializer(serializers.ModelSerializer): # article = serializers.SerializerMethodField(read_only=True) # 用于作校验的钩子函数，相似于form组件的clean_字段名 def validate_content(self, value): if '草' in value: raise ValidationError('不符合社会主义核心价值观！') else: return value #全局的钩子 def validate(self, attrs): # self.validated_data # 通过校验的数据 相似于form组件中的cleaned_data # 全局钩子 pass class Meta: model = models.Comment # Comment表 fields = "__all__" # 序列化全部字段 # depth = 2 # 深度为2 # 定义额外的参数 extra_kwargs = { "content": { "error_messages": { "required": '内容不能为空', } }, "article": { "error_messages": { "required": '文章不能为空' } } } # 文章的序列化类 class ArticleModelSerializer(serializers.ModelSerializer): class Meta: model = models.Article # 绑定的ORM类是哪个 fields = "__all__"  # ["id", "title", "type"] # depth = 1 # 官方推荐不超过10层 # 文章超连接序列化 class ArticleHyperLinkedSerializer(serializers.HyperlinkedModelSerializer): school = serializers.HyperlinkedIdentityField(view_name='school-detail', lookup_url_kwarg='id') class Meta: model = models.Article # 绑定的ORM类是哪个 fields =  ["id", "title", "type", "school"] # 学校的序列化 class SchoolSerializer(serializers.ModelSerializer): class Meta: model = models.School fields = "__all__"

参数解释：

source 表示来源

lookup_field 表示查找字段，默认使用的pk, 指的是反向生成URL的时候， 路由中分组命名匹配的value

lookup_url_kwarg 表示路由查找的参数，pk表示主键， 默认使用pk,指的是反向生成URL的时候 路由中的分组命名匹配的key

view_name  它是指urls定义的name值，必定要一一对应。 默认使用 表名-detail

 

修改views.py，增长视图函数

from rest_framework.views import APIView from app01 import app01_serializers # 导入自定义的序列化 from rest_framework.response import Response # Create your views here. class Comment(APIView): def get(self, request): res = {"code":0} # 默认状态 all_comment = models.Comment.objects.all() # print(all_comment) # 序列化,many=True表示返回多条 ser_obj = app01_serializers.CommentSerializer(all_comment, many=True) res["data"] = ser_obj.data return Response(res) def post(self, request): res = {"code": 0} # 去提交的数据 comment_data = self.request.data # 对用户提交的数据作校验 ser_obj = app01_serializers.CommentSerializer(data=comment_data) if ser_obj.is_valid(): # 表示数据没问题，能够建立 ser_obj.save() else: # 表示数据有问题 res["code"] = 1 res["error"] = ser_obj.errors return Response(res) # return HttpResponse("建立新评论") def put(self, request): return HttpResponse("修改评论") def delete(self, request): return HttpResponse("删除评论") # 文章CBV class Article(APIView): def get(self, request): res = {"code": 0} all_article = models.Article.objects.all() ser_obj = app01_serializers.ArticleHyperLinkedSerializer(all_article, many=True, context={'request': request}) res["data"] = ser_obj.data return Response(res) def post(self, request): res = {"code": 0} ser_obj = app01_serializers.ArticleModelSerializer(data=self.request.data) if ser_obj.is_valid(): ser_obj.save() else: res["code"] = 1 res["error"] = ser_obj.errors return Response(res) # 文章详情CBV class ArticleDetail(APIView): def get(self, request, pk): res = {"code": 0} article_obj = models.Article.objects.filter(pk=pk).first() # 序列化 ser_obj = app01_serializers.ArticleHyperLinkedSerializer(article_obj, context={'request': request}) res["data"] = ser_obj.data return Response(res) # 学校详情CBV class SchoolDetail(APIView): def get(self, request, id): res = {"code": 0} school_obj = models.School.objects.filter(pk=id).first() ser_obj = app01_serializers.SchoolSerializer(school_obj, context={'request': request}) res["data"] = ser_obj.data return Response(res)

View Code

参数解释： 

id 表示参数，它和url的参数，是一一对应的

content 表示上下文

 

重启django项目，访问网页：

http://127.0.0.1:8000/api/article/1

效果以下：

点击第一个连接，效果以下：