1.解析模块
2.异常处理模块
3.响应模块
4.序列化用户表设计
5.序列化组件基本使用
6.自定义序列化属性
7.反序列化组件基本使用
8.反序列化字段校验与入库
一.解析模块
为什么要配置解析模块：
1. drf给我们通过了多种解析数据包方式的解析类 2. 我们可以通过配置来控制前台提交的哪些格式的数据后台在解析，哪些数据不再解析 3. 全局配置就是针对每一个视图类，局部配置就是针对指定的视图，然后让他们可以按照配置规则选择性解析数据
源码入口：
# APIView类的dispatch方法中 request = self.initialize_request(request, *args, **kwargs) # 点进去 # 获取解析类 parsers=self.get_parsers(), # 点进去 # 去类属性(局部配置) 或 配置文件(全局配置) 拿 parser_classes return [parser() for parser in self.parser_classes]
全局配置：项目settings.py文件
REST_FRAMEWORK = { # 全局解析类配置 'DEFAULT_PARSER_CLASSES': [ 'rest_framework.parsers.JSONParser', # json数据包 'rest_framework.parsers.FormParser', # urlencoding数据包 'rest_framework.parsers.MultiPartParser' # form-date数据包 ], }
局部配置：应用views.py的具体视图类
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.parsers import JSONParser
class Book(APIView):
# 局部解析配置
parser_classes = [JSONParser] 意思就是只解析JSON格式数据 **********
def get(self,request,*args,**kwargs):
return Response('get ok')
def post(self, request, *args, **kwargs):
# url拼接参数:只有一种传参方式就是拼接参数
print(request.query_params)
# 有三种传参方式：form-data,urlencoding,json
print(request.data)
return Response('post ok')
二.异常处理模块
为什么要自定义异常模块：
""" 1）所有经过drf的APIView视图类产生的异常，都可以提供异常处理方案 2）drf默认提供了异常处理方案(rest_framework.views.exception_handler)，但是处理范围有限 3）drf提供的处理方案两种，处理了返回异常现象，没处理返回None(后续就是服务器抛异常给前台) 4）自定义异常的目的就是解决drf没有处理的异常，让前台得到合理的异常信息返回，后台记录异常具体信息 """
源码分析：
# 异常模块：APIView类的dispatch方法中 response = self.handle_exception(exc) # 点进去 # 获取处理异常的句柄(方法) # 一层层看源码，走的是配置文件，拿到的是rest_framework.views的exception_handler
# 自定义：直接写exception_handler函数，在自己的配置文件配置EXCEPTION_HANDLER指向自己的 exception_handler = self.get_exception_handler() # 异常处理的结果 # 自定义异常就是提供exception_handler异常处理函数，处理的目的就是让response一定有值 response = exception_handler(exc, context)
如何使用：自定义exception_handler函数如何书写实现体
# 修改自己的配置文件setting.py REST_FRAMEWORK = { # 全局配置异常模块 'EXCEPTION_HANDLER': 'api.exception.exception_handler', }
先在api里面创建一个exception模块
# 1）先将异常处理交给rest_framework.views的exception_handler去处理 # 2）判断处理的结果(返回值)response，有值代表drf已经处理了，None代表需要自己处理 # 自定义异常处理文件exception，在文件中书写exception_handler函数 from rest_framework.views import exception_handler as drf_exception_handler from rest_framework.views import Response from rest_framework import status # exc 异常 context 异常内容 def exception_handler(exc,context): # 因为本来有一堆处理的逻辑，我不想处理了，直接丢给他处理 # drf的exception_handler做基础处理 response = drf_exception_handler(exc,context) # 做判断,如果为空就自定义二次处理 if response is None: # 这个可以在后台打印1.那个api下面的类，2.请求的方式，3.暴露的异常 print('%s-%s-%s'%(context['view'],context['request'].method,exc)) return Response({ 'detail':'服务器错误' # 这样写只是更加规范，也可以直接写500 },status=status.HTTP_500_INTERNAL_SERVER_ERROR, exception=True) return response
三.响应模块
响应类构造器：
def __init__(self, data=None, status=None, template_name=None, headers=None, exception=False, content_type=None): """ :param data: 响应数据 :param status: http响应状态码 :param template_name: drf也可以渲染页面，渲染的页面模板地址（不用了解） :param headers: 响应头 :param exception: 是否异常了 :param content_type: 响应的数据格式（一般不用处理，响应头中带了，且默认是json） """ pass
使用：常规实例化响应对象
# status就是解释一堆 数字 网络状态码的模块 from rest_framework import status就是解释一堆 数字 网络状态码的模块 # 一般情况下只需要返回数据，status和headers都有默认值 return Response(data={数据}, status=status.HTTP_200_OK, headers={设置的响应头})
四.序列化组件之 - 序列化用户表设计
序列化准备：
模型层：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') class Meta: db_table = 'old_boy_user' # 修改表名 verbose_name = '用户' # 改为中文 verbose_name_plural = verbose_name # 不写的话，admin后台数据书籍后面会加个s def __str__(self): return '<%s>' % self.name
后台管理层：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
urlpatterns = [ # ... url(r'^api/', include('api.urls')), url(r'^media/(?P<path>.*)', serve, {'document_root': settings.MEDIA_ROOT}), ]
子路由：应用下urls.py
urlpatterns = [ url(r'^users/$', views.User.as_view()), url(r'^users/(?P<pk>.*)/$', views.User.as_view()), ]
五.序列化组件基本使用
序列化层：api/serializers.py
自定义序列化属性
注意点：
""" 1）设置需要返回给前台 那些model类有对应的 字段，不需要返回的就不用设置了 2）设置方法字段，字段名可以随意，字段值有 get_字段名 提供，来完成一些需要处理在返回的数据 """
1 # 序列化组件 - 为每一个model类通过一套序列化工具类 2 # 序列化组件的工作方式与django froms组件非常相似 3 from rest_framework import serializers, exceptions 4 from django.conf import settings 5 6 from . import models 7 8 class UserSerializer(serializers.Serializer): 9 name = serializers.CharField() 10 phone = serializers.CharField() 11 # 序列化提供给前台的字段个数由后台决定，可以少提供， 12 # 但是提供的数据库对应的字段，名字一定要与数据库字段相同 13 # sex = serializers.IntegerField() 14 # icon = serializers.ImageField() 15 16 # 自定义序列化属性 17 # 属性名随意，值由固定的命名规范方法提供: 18 # get_属性名(self, 参与序列化的model对象) 19 # 返回值就是自定义序列化属性的值 20 gender = serializers.SerializerMethodField() 21 def get_gender(self, obj): 22 # choice类型的解释型值 get_字段_display() 来访问 23 return obj.get_sex_display() 24 25 26 icon = serializers.SerializerMethodField() 27 def get_icon(self, obj): 28 # settings.MEDIA_URL: 自己配置的 /media/，给后面高级序列化与视图类准备的 29 # obj.icon不能直接作为数据返回，因为内容虽然是字符串，但是类型是ImageFieldFile类型 30 return '%s%s%s' % (r'http://127.0.0.1:8000', settings.MEDIA_URL, str(obj.icon))
视图层：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 }) """
1 from rest_framework.views import APIView 2 from rest_framework.response import Response 3 from rest_framework.parsers import JSONParser 4 from . import models,serializers 5 6 class User(APIView): 7 def get(self,request,*args,**kwargs): 8 pk = kwargs.get('pk') 9 # 单查 10 if pk: 11 try: 12 # 用户对象不能直接作为数据返回给前台 13 user_obj = models.User.objects.get(pk=pk) 14 # 序列化一下用户对象 15 user_ser =serializers.UserSerializer(user_obj) 16 return Response({ 17 'status':0, 18 'msg':0, 19 'results':{ 20 'name':user_obj.name 21 } 22 }) 23 except: 24 return Response({ 25 'status': 2, 26 'msg': '用户不存在', 27 }) 28 # 群查 29 else: 30 # 用户对象列表(queryset)也不能直接作为数据返回给前台 31 user_obj_list = models.User.objects.all() 32 # 序列化一下用户对象 #如果有多个数据就需要写many=True 33 user_ser_data = serializers.UserSerializer(user_obj_list,many=True).data 34 return Response({ 35 'status': 0, 36 'msg': 0, 37 'results':user_ser_data 38 })
七.反序列化组件基本使用 和 反序列化字段校验与入库
反序列化层：api/serializers.py
注意点： """ 1）设置必填与选填序列化字段，设置校验规则 2）为需要额外校验的字段提供局部钩子函数，如果该字段不入库，且不参与全局钩子校验，可以将值取出校验 3）为有联合关系的字段们提供全局钩子函数，如果某些字段不入库，可以将值取出校验 4）重写create方法，完成校验通过的数据入库工作，得到新增的对象 """
1 from rest_framework import serializers, exceptions 2 from django.conf import settings 3 from . import models 4 5 class UserDeserializer(serializers.Serializer): 6 # 1) 哪些自动必须反序列化 7 # 2) 字段都有哪些安全校验 8 # 3) 哪些字段需要额外提供校验 9 # 4) 哪些字段间存在联合校验 10 # 注：反序列化字段都是用来入库的，不会出现自定义方法属性，会出现可以设置校验规则的自定义属性(re_pwd) 11 name = serializers.CharField( 12 max_length=64, 13 min_length=3, 14 error_messages={ 15 'max_length': '太长', 16 'min_length': '太短' 17 } 18 ) 19 pwd = serializers.CharField() 20 phone = serializers.CharField(required=False) 21 sex = serializers.IntegerField(required=False) 22 23 # 自定义有校验规则的反序列化字段 24 re_pwd = serializers.CharField(required=True) 25 26 # 小结： 27 # name，pwd，re_pwd为必填字段 28 # phone，sex为选填字段 29 # 五个字段都必须提供完成的校验规则 30 31 32 # 局部钩子：validate_要校验的字段名(self, 当前要校验字段的值) 33 # 校验规则：校验通过返回原值，校验失败，抛出异常 34 def validate_name(self, value): 35 if 'g' in value.lower(): # 名字中不能出现g 36 raise exceptions.ValidationError('名字非法，是个鸡贼！') 37 return value 38 39 # 全局钩子：validate(self, 系统与局部钩子校验通过的所有数据) 40 # 校验规则：校验通过返回原值，校验失败，抛出异常 41 def validate(self, attrs): 42 pwd = attrs.get('pwd') 43 re_pwd = attrs.pop('re_pwd') 44 if pwd != re_pwd: 45 raise exceptions.ValidationError({'pwd&re_pwd': '两次密码不一致'}) 46 return attrs 47 48 # 要完成新增，需要自己重写 create 方法 49 def create(self, validated_data): 50 # 尽量在所有校验规则完毕之后，数据可以直接入库 51 return models.User.objects.create(**validated_data)
视图层 views.py：
注意点： """ 1）book_ser = serializers.UserDeserializer(data=request_data) # 数据必须赋值data 2）book_ser.is_valid() # 结果为 通过 | 不通过 3）不通过返回 book_ser.errors 给前台，通过 book_ser.save() 得到新增的对象，再正常返回 """
1 class User(APIView): 2 # 只考虑单增 3 def post(self, request, *args, **kwargs): 4 # 请求数据 5 request_data = request.data 6 # 数据是否合法（增加对象需要一个字典数据） 7 if not isinstance(request_data, dict) or request_data == {}: 8 return Response({ 9 'status': 1, 10 'msg': '数据有误', 11 }) 12 # 数据类型合法，但数据内容不一定合法，需要校验数据，校验(参与反序列化)的数据需要赋值给data 13 book_ser = serializers.UserDeserializer(data=request_data) 14 15 # 序列化对象调用is_valid()完成校验，校验失败的失败信息都会被存储在 序列化对象.errors 16 if book_ser.is_valid(): 17 # 校验通过，完成新增 18 book_obj = book_ser.save() 19 return Response({ 20 'status': 0, 21 'msg': 'ok', 22 'results': serializers.UserSerializer(book_obj).data 23 }) 24 else: 25 # 校验失败 26 return Response({ 27 'status': 1, 28 'msg': book_ser.errors, 29 })