4）drf序列化组件 Serializer(偏底层)、ModelSerializer(重点)、ListModelSerializer(辅助群改)
知识点：Serializer(偏底层)、ModelSerializer(重点)、ListModelSerializer(辅助群改)
一、Serializer 偏底层 一般不用 理解原理
1.序列化准备：
-
模型层：models.py
from django.db import models class User(models.Model): SEX_CHOICES = [ [0, '男'], [1, '女'], ] name = models.CharField(max_length=64) pwd = models.CharField(max_length=32) phone = models.CharField(max_length=11, null=True, default=None) sex = models.IntegerField(choices=SEX_CHOICES, default=0) icon = models.ImageField(upload_to='icon', default='icon/default.jpg') #图像，在BASE_DIR通常是根目录下建立media——》icon用来存放图像 class Meta: db_table = 'old_boy_user' # 配置自定义用户表名 verbose_name = '用户' # 给后台管理user表起别名，不然admin界面显示英文表名users verbose_name_plural = verbose_name # 后台可视化界面，名字结尾不加s，显示‘用户s’ def __str__(self): return '%s' % self.name #后台管理默认显示所有用户名都是User object ，有了这个就可以显示自己的名字，例如tank，jason #完事之后执行数据库迁移命令，所有环境准备完毕创建超级用户，启动django项目去后台管理录入数据
-
后台管理层：admin.py
from django.contrib import admin from . import models admin.site.register(models.User)
-
配置层：settings.py
# 注册rest_framework INSTALLED_APPS = [ # ... 'rest_framework', ] # 配置数据库 DATABASES = { 'default': { 'ENGINE': 'django.db.backends.mysql', 'NAME': 'day70', 'USER': 'root', 'PASSWORD': '123' } } #以后基本不会使用静态资源配置了，因为静态资源是后端渲染的页面访问后端资源才需要 # media资源 MEDIA_URL = '/media/' # 后期高级序列化类与视图类，会使用该配置 MEDIA_ROOT = os.path.join(BASE_DIR, 'media') # media资源路径 # 国际化配置，也可不配置，默认英语 LANGUAGE_CODE = 'zh-hans' TIME_ZONE = 'Asia/Shanghai' USE_I18N = True USE_L10N = True USE_TZ = False
-
主路由：项目下urls.py
from django.conf.urls import url, include from django.contrib import admin from django.views.static import serve from django.conf import settings urlpatterns = [ url(r'^admin/', admin.site.urls), # 路由分发 url(r'^api/', include('api.urls')), url(r'^media/(?P<path>.*)', serve, {'document_root': settings.MEDIA_ROOT}), ]
-
子路由：应用下urls.py
from django.conf.urls import url from . import views urlpatterns = [ url(r'^users/$', views.User.as_view()), url(r'^users/(?P<pk>.*)/$', views.User.as_view()), ]
2.序列化使用
-
自定义序列化：api/serializers.py
""" 1）设置需要返回给前台 那些model类有对应的 字段，不需要返回的就不用设置了 2）设置方法字段，字段名可以随意，字段值有 get_字段名 提供，来完成一些需要处理再返回的数据 """ # 序列化组件 - 为每一个model类提供一套序列化工具类 # 序列化组件的工作方式与django froms组件非常相似 from rest_framework import serializers, exceptions #导入的是drf序列化的文件夹 from django.conf import settings from . import models class UserSerializer(serializers.Serializer): #继承drf的序列化方法 name = serializers.CharField() phone = serializers.CharField() # 序列化提供给前台的字段个数由后台决定，可以少提供，比如只返回名字其他都不返回 # 但是提供的数据库对应的字段，名字一定要与数据库字段相同，因为要用字段名去数据库反射拿值 # sex = serializers.IntegerField() # icon = serializers.ImageField() # 自定义序列化属性++++++++++++++++++不常用，后期有高级的+++++++++++++++++++++++++++ #（如果像上面直接写sex和icon，就会直接返回数据库里面的东西，0、1而不是男女，返回图像的文件夹路径而不是可访问的连接，所以针对这些字段我们需要自定义属性，处理后返回正确格式） # 属性名随意，值由固定的命名规范方法提供: # get_属性名(self, 参与序列化的model对象) # 返回值就是自定义序列化属性的值 gender = serializers.SerializerMethodField() def get_gender(self, obj): return obj.get_sex_display() # choice类型的解释型值 get_字段_display() 来访问，取出男女等真实信息 icon = serializers.SerializerMethodField() def get_icon(self, obj): return '%s%s%s' % (r'http://127.0.0.1:8000', settings.MEDIA_URL, str(obj.icon)) # settings.MEDIA_URL: 配置中自己配置的，就是 /media/，给后面高级序列化与视图类准备的 # obj.icon不能直接作为数据返回，因为内容虽然是字符串，但是类型是ImageFieldFile类型，需要转化为字符串
-
视图层 api: views.py
""" 1）从数据库中将要序列化给前台的model对象，或是多个model对象查询出来 user_obj = models.User.objects.get(pk=pk) 或者 user_obj_list = models.User.objects.all() 2）将对象交给序列化处理，产生序列化对象，如果序列化的是多个数据，要设置many=True user_ser = serializers.UserSerializer(user_obj) 或者 user_ser = serializers.UserSerializer(user_obj_list, many=True) 3）序列化 对象.data 就是可以返回给前台的序列化数据 return Response({ 'status': 0, 'msg': 0, 'results': user_ser.data }) """
from rest_framework.views import APIView from rest_framework.response import Response from rest_framework.parsers import JSONParser from . import models, serializers class User(APIView): def get(self, request, *args, **kwargs): pk = kwargs.get('pk') if pk: #单查+++++++++++++++++++++++++++++++++++++++++++ try: # 用户对象不能直接作为数据返回给前台 user_obj = models.User.objects.get(pk=pk) # 使用自定义的序列化方法，序列化一下用户对象 user_ser = serializers.UserSerializer(user_obj) # print(user_ser, type(user_ser)) return Response({ 'status': 0, 'msg': 0, 'results': user_ser.data }) except: return Response({ 'status': 2, 'msg': '用户不存在', }) else: # 群查++++++++++++++++++++++++++++++++++++++++++++++ # 用户对象列表(queryset)不能直接作为数据返回给前台 user_obj_list = models.User.objects.all() # 序列化一下用户对象 user_ser_data = serializers.UserSerializer(user_obj_list, many=True).data return Response({ 'status': 0, 'msg': 0, 'results': user_ser_data })
3.反序列化使用
""" 1）设置必填与选填序列化字段，设置校验规则 2）为需要额外校验的字段提供局部钩子函数，如果该字段不入库，且不参与全局钩子校验，可以将值取出校验 3）为有联合关系的字段们提供全局钩子函数，如果某些字段不入库，可以将值取出校验 4）重写create方法，完成校验通过的数据入库工作，得到新增的对象 """ from rest_framework import serializers, exceptions #导入的是drf序列化的文件夹 from django.conf import settings from . import models class UserDeserializer(serializers.Serializer): # 1) 哪些自动必须反序列化 # 2) 字段都有哪些安全校验 # 3) 哪些字段需要额外提供校验 # 4) 哪些字段间存在联合校验 # 注：反序列化字段都是用来入库的，不会像序列化一样出现自定义方法属性，但会出现可以设置校验规则的自定义属性(比如确认密码字段re_pwd) name = serializers.CharField( max_length=64, min_length=3, error_messages={ 'max_length': '太长', 'min_length': '太短' } ) pwd = serializers.CharField() phone = serializers.CharField(required=False) #不是必填 sex = serializers.IntegerField(required=False) # 自定义有校验规则的反序列化字段，不入库，只做校验用 re_pwd = serializers.CharField(required=True) # 小结： # name，pwd，re_pwd为必填字段 # phone，sex为选填字段 # 五个字段都必须提供完整的校验规则，不然用户瞎传，电话号给你传个110可咋整 # 局部钩子：固定语法 validate_要校验的字段名(self, 当前要校验字段的值) # 校验规则：校验通过返回原值，校验失败，抛出异常 def validate_name(self, value): if 'g' in value.lower(): # 名字中不能出现g，这个随意规定规则 raise exceptions.ValidationError('名字非法，是个鸡贼！') return value # 全局钩子：validate(self, 系统与局部钩子校验通过的所有数据)
#为有联合关系的字段们提供全局钩子函数，如果某些字段不入库，可以将值弹出用于校验
# 校验规则：校验通过返回原值，校验失败，抛出异常 def validate(self, attrs): pwd = attrs.get('pwd') re_pwd = attrs.pop('re_pwd') # 这个自定义的不需要入库，直接弹出，弹出的东西可以被接收 if pwd != re_pwd: raise exceptions.ValidationError({'pwd&re_pwd': '两次密码不一致'}) return attrs # 要完成新增，需要自己重写 create 方法 def create(self, validated_data): # 尽量在所有校验规则完毕之后，数据可以直接入库 return models.User.objects.create(**validated_data) # book_obj = models.Book.objects.create(title='三国',price=19.99)
-
视图层 api/views.py
""" 1）book_ser = serializers.UserDeserializer(data=request_data) # 数据必须赋值data 2）book_ser.is_valid() # 结果为 通过 | 不通过 3）不通过返回 book_ser.errors 给前台，通过 book_ser.save() 得到新增的对象，再正常返回 """ from rest_framework.views import APIView from rest_framework.response import Response from . import models, serializers class User(APIView): # 只考虑单增 def post(self, request, *args, **kwargs): # 请求数据 request_data = request.data # 数据是否合法（增加对象需要一个字典数据） if not isinstance(request_data, dict) or request_data == {}: return Response({ 'status': 1, 'msg': '数据有误', }) # 数据类型合法，但数据内容不一定合法，需要校验数据，校验(参与反序列化)的数据需要赋值给data book_ser = serializers.UserDeserializer(data=request_data) #点进源码发现去序列化的数据需要赋值给data，所以这里不能直接传request_data # 序列化对象调用is_valid()完成校验，可以点进去看源码，一大堆断言assert之后return not bool(self._errors)，当数据有错返回Faulse，当数据合法返回True #校验失败的失败信息都会被存储在 序列化对象.errors， if book_ser.is_valid(): # 表示校验通过，内部数据没有错误，完成新增，save的时候会报错说必须写create方法，因为下面的save源码内部其实是走了create或者updata方法，
#这两个方法点进去其实什么处理也没有直接返回那种，用到哪个我们需要自己去写哪个，报错提示必须写create说明走了这个，我们到api/serializers.py中去重写create book_obj = book_ser.save() return Response({ 'status': 0, 'msg': 'ok', 'results': serializers.UserSerializer(book_obj).data }) #results传给前端需要反序列化 else: # 内部数据有错，校验失败 return Response({ 'status': 1, 'msg': book_ser.errors, })
