1)序列化(正向查找)
from rest_framework import serializers from users.models import UserInfo class UserInfoSerializer(serializers.Serializer): name = serializers.CharField(min_length=3,max_length=20) # 显示普通字段 ut = serializers.CharField(source='ut.type_name',required=False) # 显示一对多字段名称 gp = serializers.SerializerMethodField(read_only=True) # 自定义显示(显示多对多) xxx = serializers.CharField(source='name',required=False) # 也可以自定义显示字段名称 ut_id = serializers.IntegerField(write_only=True) # 一对多关联字段定义(外键约束) '''PrimaryKeyRelatedField和StringRelatedField:可以用对 一对多 和 多对多 关联对象序列化''' # gp = serializers.PrimaryKeyRelatedField(read_only=True, many=True) # gp = serializers.StringRelatedField(read_only=True,many=True) class Meta: model = UserInfo # 自定义显示 多对多 字段 def get_gp(self,row): '''row: 传过来的正是 UserInfo表的对象''' gp_obj_list = row.gp.all().values('id','group') # 获取用户所有组 return gp_obj_list
2)序列化(反向查找)
''' 一对多序列化(反向查找)''' class UserTypeSerializer(serializers.Serializer): type_name = serializers.CharField() # 法1一对多关联对象序列化:此字段将被序列化为关联对象的主键 userinfo_set = serializers.PrimaryKeyRelatedField(read_only=True, many=True) # 法2一对多关联对象序列化:此字段将被序列化为关联对象的字符串表示方式(即__str__方法的返回值) # userinfo_set = serializers.StringRelatedField(read_only=True,many=True) # 法3一对多关联对象序列化:使用关联对象的序列化器 # userinfo_set = UserInfoSerializer(many=True)
3)视图函数中使用序列化
class UserInfoViewSet(APIView): def get(self, request, *args, **kwargs): # 一对多、多对多查询都是一样的语法 obj = users_model.UserInfo.objects.all() ser = serializers.UserInfoSerializer(instance=obj,many=True) # 关联数据多条 # ser = serializers.UserInfoSerializer(instance=obj[0]) # 关联数据一条 return Response(ser.data, status=200)
反序列化
1)使用反序列化保存数据
'''创建用户''' def post(self,request): ser = serializers.UserInfoSerializer(data=request.data) if ser.is_valid(): ser.save() return Response(data=ser.data, status=201) return Response(data=ser.errors,status=400)
2)反序列化定义创建和更新方法
# 定义创建语法 def create(self, validated_data): return UserInfo.objects.create(**validated_data) # 定义更新方法 def update(self, instance, validated_data): if validated_data.get('name'): instance.name = validated_data['name'] if validated_data.get('ut_id'): instance.ut_id = validated_data['ut_id'] instance.save() return instance # 定义单一字段验证的方法 def validate_name(self, value): if value == 'root': raise serializers.ValidationError('不能创建root管理员账号') return value # 定义多字段验证方法 def validate(self, attrs): if attrs['name'] == 'admin': raise serializers.ValidationError('不能创建admin用户') return attrs
4、序列化使用举例(serializers.ModelSerializer)
1. ModelSerializer本质是继承了Serielizer类添加了部分功能
2. 在使用上ModelSerializer可以使用 fields = '__all__' 定义要显示的字段
'''users/serializers/userinfo_serializers.py''' from rest_framework import serializers from users.models import UserInfo class UserInfoSerializer(serializers.ModelSerializer): # name = serializers.CharField() # 显示普通字段 ut = serializers.CharField(source='ut.type_name') # 显示一对多字段 gp = serializers.SerializerMethodField() # 自定义显示(显示多对多) xxx = serializers.CharField(source='name') # 也可以自定义显示字段名称 class Meta: model = UserInfo # fields = "__all__" fields = ["name",'ut','gp','xxx'] # 定义显示那些字段 def get_gp(self,row): '''row: 传过来的正是 UserInfo表的对象''' gp_obj_list = row.gp.all() # 获取用户所有组 ret = [] for item in gp_obj_list: ret.append({'id':item.id,'gp':item.group}) return ret serializers.ModelSerializer使用
5、使用serializers.ModelSerializer 进行数据验证
from rest_framework.views import APIView from users.serializers.userinfo_serializers import UserInfoSerializer from users.models import UserInfo class UserInfoViewSet(APIView): def get(self, request, *args, **kwargs): obj = UserInfo.objects.all() ser = UserInfoSerializer(instance=obj,many=True) ret = json.dumps(ser.data,ensure_ascii=False) return HttpResponse(ret) def post(self, request, *args, **kwargs): ser = UserInfoSerializer(data=request.data) # 验证,对请求发来的数据进行验证 if ser.is_valid(): print(ser.validated_data) # post请求数据字典 else: print(ser.errors) # form验证错误信息 return HttpResponse(json.dumps({'status':True}))
'''users/serializers/userinfo_serializers.py''' from rest_framework import serializers from django.core.exceptions import ValidationError from users.models import UserInfo class UserInfoSerializer(serializers.ModelSerializer): name = serializers.CharField(min_length=10, error_messages={'required': '该字段必填'}) # 显示普通字段 ut = serializers.CharField(source='ut.type_name',required=False) # 显示一对多字段 gp = serializers.SerializerMethodField(required=False) # 自定义显示(显示多对多) xxx = serializers.CharField(source='name', required=False) # 也可以自定义显示字段名称 class Meta: model = UserInfo # fields = "__all__" fields = ["name",'ut','gp','xxx'] # 定义显示那些字段 # 局部钩子: def validate_name(self, value): # value 是name字段提交的值 if value.startswith('sb'): # 不能以sb开头 raise ValidationError('不能以sb开头') else: return value # 全局钩子找到了 def validate(self, value): # value是所有校验通过数据的字典 name = value.get('name') if False: raise ValidationError('全局钩子引发异常') return value users/serializers/userinfo_serializers.py
'''1、ser.is_valid()''' # 验证post请求中数据是否合法 '''2、全局校验钩子''' def validate(self, value): # value是所有校验通过数据的字典 '''3、局部钩子''' def validate_name(self, value): # value 是name字段提交的值
1、分页中基本语法
'''1、实例化一个Paginator对象''' paginator = Paginator(objs, page_size) # paginator对象 '''2、获取总数量&总页数''' total_count = paginator.count # 总数量 total = paginator.num_pages # 总页数 '''3、使用objs对象获取指定页数内容''' objs = paginator.page(page) '''4、对分页后的数据进行序列化操作''' serializer = Serializer(objs, many=True) # 序列化操作<br><br><br><br><br>
#!/usr/bin/python # -*- coding: utf-8 -*- from django.conf import settings from rest_framework import status from django.core.paginator import EmptyPage, Paginator, PageNotAnInteger from rest_framework.views import Response def Paginators(objs, request, Serializer): """ objs : 实体对象, queryset request : 请求对象 Serializer : 对应实体对象的类 page_size : 每页显示多少条数据 page : 显示第几页数据 total_count :总共有多少条数据 total :总页数 """ try: page_size = int(request.GET.get('page_size', settings.REST_FRAMEWORK['PAGE_SIZE'])) page = int(request.GET.get('page', 1)) except (TypeError, ValueError): return Response(status=400) paginator = Paginator(objs, page_size) # paginator对象 total_count = paginator.count total = paginator.num_pages # 总页数 try: objs = paginator.page(page) except PageNotAnInteger: objs = paginator.page(1) except EmptyPage: objs = paginator.page(paginator.num_pages) serializer = Serializer(objs, many=True) # 序列化操作 return Response( data={ 'detail': serializer.data, 'page': page, 'page_size': page_size, 'total': total, 'total_count': total_count } ) common/utils/api_paginator.py 自定义分页模块
# 分页 REST_FRAMEWORK = { # 全局分页 'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination', # 关闭api root页面展示 'DEFAULT_RENDERER_CLASSES': ( 'rest_framework.renderers.JSONRenderer', ), 'UNICODE_JSON': False, # 自定义异常处理 'EXCEPTION_HANDLER': ( 'common.utils.custom_exception_handler' ), 'PAGE_SIZE': 10 } settings.py
'''users/serializers/userinfo_serializers.py''' from rest_framework import serializers from users.models import UserInfo class UserInfoSerializer(serializers.Serializer): name = serializers.CharField() # 显示普通字段 ut = serializers.CharField(source='ut.type_name') # 显示一对多字段 gp = serializers.SerializerMethodField() # 自定义显示(显示多对多) xxx = serializers.CharField(source='name') # 也可以自定义显示字段名称 class Meta: model = UserInfo def get_gp(self,row): '''row: 传过来的正是 UserInfo表的对象''' gp_obj_list = row.gp.all() # 获取用户所有组 ret = [] for item in gp_obj_list: ret.append({'id':item.id,'gp':item.group}) return ret users/serializers/userinfo_serializer.py
''' users/views.py''' from rest_framework.views import APIView from rest_framework.views import Response from users.serializers.userinfo_serializers import UserInfoSerializer from users.models import UserInfo from common.utils.api_paginator import Paginators class UserInfoViewSet(APIView): queryset = UserInfo.objects.all().order_by('id') serializer_class = UserInfoSerializer def get(self, request, *args, **kwargs): self.queryset = self.queryset.all() ret = Paginators(self.queryset, request, self.serializer_class) print(json.dumps(ret.data)) # ret.data 返回的是最终查询的json数据 return Response(ret.data) # http://127.0.0.1:8000/users/info/?page_size=1 ''' { "detail": [ { "name": "zhangsan", "ut": "学生", "gp": [ { "id": 1, "gp": "group01" }, { "id": 2, "gp": "group02" } ], "xxx": "zhangsan" } ], "page": 1, "page_size": 1, "total": 3, "total_count": 3 } ''' users/views.py