序列化组件
知识点:Serializer(偏底层)、ModelSerializer(重点)、ListModelSerializer(辅助群改)
序列化与反序列化
序列化: 将对象序列化成字符串用户传输 反序列化: 将字符串反序列化成对象用于使用
drf的序列化与反序列化
序列化: 将Model类对象序列化成字符串用户传输 反序列化: 将字符串反序列化成Model对象用于使用
Serializer
序列化准备:
- 模型层: models.py
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‘) ? class Meta: # 自定义创建的表名 db_table = ‘user‘ # admin界面中显示的表面与表名复数形式 verbose_name = ‘用户‘ verbose_name_plural = verbose_name ? def __str__(self): return self.name
- 配置层: settings.py
# 注册rest_framework INSTALLED_APPS = [ # ... ‘rest_framework‘, ] ? # 配置数据库 DATABASES = { ‘default‘: { ‘ENGINE‘: ‘django.db.backends.mysql‘, ‘NAME‘: ‘db‘, ‘USER‘: ‘root‘, ‘PASSWORD‘: ‘root‘ } } ? # 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
- 主路由:
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(‘^media/(?P<path>.*)‘, serve, {‘document_root‘:settings.MEDIA_ROOT}) ]
- 子路由:
urlpatterns = [ url(r‘^users/$‘, views.User.as_view()), url(r‘^users/(?P<pk>.*)/$‘, views.User.as_view()), ]
Serializer 序列化使用:
# 序列化提供给前台的字段个数由后台决定,可以少提供, # 但是提供的数据库对应的字段,名字一定要与数据库字段相同 # 设置方法字段,字段名可以随意,字段值有 get_字段名 提供,来完成一些需要处理在返回的数据 # 序列化组件 - 为每一个model类通过一套序列化工具类 # 序列化组件的工作方式与django froms组件非常相似
- 应用下创建serializers.py
from rest_framework import serializers, exceptions from django.conf import settings ? from . import models ? class UserSerializer(serializers.Serializer): name = serializers.CharField() phone = serializers.CharField() # 序列化提供给前台的字段个数由后台决定,可以少提供, # 但是提供的数据库对应的字段,名字一定要与数据库字段相同 # sex = serializers.IntegerField() # icon = serializers.ImageField() ? # 自定义序列化属性 # 属性名随意,值由固定的命名规范方法提供: # get_属性名(self, 参与序列化的model对象) # 返回值就是自定义序列化属性的值 gender = serializers.SerializerMethodField() def get_gender(self, obj): # obj是对应表中的一条记录(即:对象) # choice类型的解释型值 get_字段_display() 来访问 return obj.get_sex_display() ? ? icon = serializers.SerializerMethodField() def get_icon(self, obj): # settings.MEDIA_URL: 自己配置的 /media/,给后面高级序列化与视图类准备的 # obj.icon不能直接作为数据返回,因为内容虽然是字符串,但是类型是ImageFieldFile类型 return ‘%s%s%s‘ % (r‘http://127.0.0.1:8000‘, settings.MEDIA_URL, str(obj.icon))
- 视图层
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) 注意: many会遍历user_obj_list,触发是一个具体对象,否则就需要制定many=True 3)序列化 对象.data 就是可以返回给前台的序列化数据 return Response({ ‘status‘: 0, ‘msg‘: 0, ‘results‘: user_ser.data })
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) # print(user_ser.data) # {‘name‘: ‘xiongda‘, ‘phone‘: ‘110‘} 序列化后的字段 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 })
Serializers 反序列化使用:
1)设置必填与选填序列化字段,设置校验规则 2)为需要额外校验的字段提供局部钩子函数,如果该字段不入库,且不参与全局钩子校验,可以将值取出校验 3)为有联合关系的字段们提供全局钩子函数,如果某些字段不入库,可以将值取出校验 4)重写create方法,完成校验通过的数据入库工作,得到新增的对象
-
serializers.py文件中:
from rest_framework import serializers, exceptions 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) # required = False 该字段可以不传值 sex = serializers.IntegerField(required=False) ? # 自定义有校验规则的反序列化字段 re_pwd = serializers.CharField(required=True) ? # 小结: # name,pwd,re_pwd为必填字段 # phone,sex为选填字段 # 五个字段都必须提供完成的校验规则 ? ? # 局部钩子:validate_要校验的字段名(self, 当前要校验字段的值) # 校验规则:校验通过返回原值,校验失败,抛出异常 def validate_name(self, value): print(value) # name字段的值 if ‘g‘ in value.lower(): # 名字中不能出现g raise exceptions.ValidationError(‘名字非法,是个鸡贼!‘) return value ? # 全局钩子:validate(self, 系统与局部钩子校验通过的所有数据) # 校验规则:校验通过返回原值,校验失败,抛出异常 def validate(self, attrs): print(attrs) # OrderedDict([(‘name‘, ‘haha‘), (‘pwd‘, ‘123‘), (‘phone‘, ‘120‘), (‘re_pwd‘, ‘123‘)]) 可以当做是字典 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): print(validated_data) # {‘name‘: ‘haha‘, ‘pwd‘: ‘123‘, ‘phone‘: ‘120‘} # 尽量在所有校验规则完毕之后,数据可以直接入库 return models.User.objects.create(**validated_data)
# 总结: # 1)设置必填与选填序列化字段,设置校验规则 # 2)为需要额外校验的字段提供局部钩子函数,如果该字段不入库,且不参与全局钩子校验,可以将值取出校验 # 3)为有联合关系的字段们提供全局钩子函数,如果某些字段不入库,可以将值取出校验 # 4)重写create方法,完成校验通过的数据入库工作,得到新增的对象
-
视图层
1)book_ser = serializers.UserDeserializer(data=request_data) # 数据必须赋值data 2)book_ser.is_valid() # 结果为 通过(True) | 不通过(Fales) 3)不通过返回调用:book_ser.errors 给前台, 4) 通过调用:book_ser.save() 得到新增的对象,再正常返回
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) ? # 序列化对象调用is_valid()完成校验,校验失败的失败信息都会被存储在 序列化对象.errors if book_ser.is_valid(): # 校验通过,完成新增 book_obj = book_ser.save() return Response({ ‘status‘: 0, ‘msg‘: ‘ok‘, ‘results‘: serializers.UserSerializer(book_obj).data }) else: # 校验失败 return Response({ ‘status‘: 1, ‘msg‘: book_ser.errors, # 将错误字段的信息返回给前台 })
原文地址:https://www.cnblogs.com/waller/p/11686856.html
时间: 2024-11-05 20:35:32