DRF部分源码简介及序列化组件

Posted 2021-03-26 sr-program

一：解析模块

（1）作用：

　　（1）drf给我们通过了多种解析数据包方式的解析类
　　（2）我们可以通过配置来控制前台提交的哪些格式的数据后台在解析，哪些数据不解析
　　（3）全局配置就是针对每一个视图类，局部配置就是针对指定的视图来，让它们可以按照配置规则选择性解析数据

（2）源码入口

# APIView类的dispatch方法中
request = self.initialize_request(request, *args, **kwargs)  # 点进去

# 获取解析类
parsers=self.get_parsers(),  # 点进去

# 去类属性(局部配置) 或 配置文件(全局配置) 拿 parser_classes
return [parser() for parser in self.parser_classes]

（3）全局settings配置文件

REST_FRAMEWORK = {
    # 全局解析类配置
    ‘DEFAULT_PARSER_CLASSES‘: [
        ‘rest_framework.parsers.JSONParser‘,  # json数据包
        ‘rest_framework.parsers.FormParser‘,  # urlencoding数据包
        ‘rest_framework.parsers.MultiPartParser‘  # form-date数据包
    ],
}

（4）局部配置：在views.py的具体类中应用

from rest_framework.parsers import JSONParser
class Book(APIView):
    # 局部解析类配置，只要json类型的数据包才能被解析
    parser_classes = [JSONParser]
    pass

二：异常模块

（1）作用：

　　（1）所有经过drf的APIView视图类产生的异常，都可以提供异常处理方案

　　（2）drf默认提供了异常处理方案(rest_framework.views.exception_handler)，但是处理范围有限
　　（3）drf提供的处理方案两种，处理了返回异常现象，没处理返回None(后续就是服务器抛异常给前台)
　　（4）自定义异常的目的就是解决drf没有处理的异常，让前台得到合理的异常信息返回，后台记录异常具体信息

（2）源码分析:

# 异常模块：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)

（3）自定义exception_handler函数书写实现体

# 修改自己的配置文件setting.py
REST_FRAMEWORK = {
    # 全局配置异常模块
    ‘EXCEPTION_HANDLER‘: ‘api.exception.exception_handler‘,
}

（4）代码实现

# 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
def exception_handler(exc, context):
    # drf的exception_handler做基础处理
    response = drf_exception_handler(exc, context)
    # 为空，自定义二次处理
    if response is None:
        # print(exc)
        # print(context)
        print(‘%s - %s - %s‘ % (context[‘view‘], context[‘request‘].method, exc))
        return Response({
            ‘detail‘: ‘服务器错误‘
        }, status=status.HTTP_500_INTERNAL_SERVER_ERROR, exception=True)
    return response

三：响应模块

（1）响应类构造器

：rest_framework.response.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

（2）使用：常规实例化对象

# status就是解释一堆 数字 网络状态码的模块
from rest_framework import status就是解释一堆 数字 网络状态码的模块
# 一般情况下只需要返回数据，status和headers都有默认值
return Response(data={数据}, status=status.HTTP_200_OK, headers={设置的响应头})

四：序列化组件

（1）基础知识

Serializer(偏底层)、ModelSerializer(重点)、ListModelSerializer(辅助群改)

（2）模型层

from django.db import models


class User(models.Model):
    SEX_CHOICE = [
        [0, ‘男‘],
        [1, ‘女‘],
    ]
    name = models.CharField(max_length=255)
    pwd = models.CharField(max_length=255)
    sex = models.IntegerField(choices=SEX_CHOICE,default=0)
    avatar = models.ImageField(upload_to=‘img/‘, default=‘img/111.jpeg‘)

    class Meta:
        db_table = ‘user_info‘
        verbose_name = ‘用户表‘
        verbose_name_plural = verbose_name

    def __str__(self):
        return ‘%s‘ % self.name

（2）主路由层：

from django.conf.urls import url, include
from django.contrib import admin
from django.views.static import serve
from . 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}),  # 暴露给用户的文件
]

（3）子路由：

from django.conf.urls import url
from . import views

urlpatterns = [
    url(r‘^users/$‘, views.User.as_view()),
    url(r‘^users/(?P<primary_key>.*)/$‘, views.User.as_view()),
]

（4）全局settings文件配置

# 注册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

（5）序列化使用：项目文件/serializers.py

from rest_framework import serializers, exceptions  # 导入序列化组件 报错组件
from . import models
from django.conf import settings
　  # 1）设置需要返回给前台 那些model类有对应的 字段，不需要返回的就不用设置了
　  # 2）设置方法字段，字段名可以随意，字段值有 get_字段名 提供，来完成一些需要处理在返回的数据


class UserSerializers(serializers.Serializer):
    # 设置序列化组件 且字段可以少于模型表中的字段 但是字段名必须与模型表中的相同
    name = serializers.CharField()
    # pwd  = serializers.CharField()  # 密码不需要显示给前台看
    # sex = serializers.IntegerField()
    # avatar = serializers.ImageField()

    # 自定义序列化组件给前台看
    gender = serializers.SerializerMethodField()

    def get_gender(self, obj):  # 此时get_ 后面的方法必须与上述gender一致
        print(obj, type(obj))  # 辰东 <class ‘api.models.User‘> 当前被查询对象 obj当前模型表实例化对象
        data = obj.get_sex_display()  # 将模型表中的数字转换成其映射的值
        return data

    avatar_img = serializers.SerializerMethodField()

    def get_avatar_img(self, obj):
        url = r‘http://127.0.0.1:8000‘
        img_path = settings.MEDIA_URL

        avatar_img = str(obj.avatar)  # 不能直接作为数据返回，因为内容虽然是字符串，但是类型是ImageFieldFile类型

        return ‘%s%s%s‘ % (url, img_path, avatar_img)

　　  # 1) 哪些自动必须反序列化
　　  # 2) 字段都有哪些安全校验
　　  # 3) 哪些字段需要额外提供校验
　　  # 4) 哪些字段间存在联合校验
　　  # 注：反序列化字段都是用来入库的，不会出现自定义方法属性，会出现可以设置校验规则的自定义属性(re_pwd）

class UserDeSerializers(serializers.Serializer):  # 反序列化
    name = serializers.CharField(max_length=8, min_length=3, error_messages={
        ‘max_length‘: ‘最长八位‘,
        ‘min_length‘: ‘最短三位‘,
        ‘required‘: ‘不能为空‘,
    })
    pwd = serializers.CharField(max_length=8, min_length=3, error_messages={
        ‘max_length‘: ‘最长八位‘,
        ‘min_length‘: ‘最短三位‘,
        ‘required‘: ‘不能为空‘,
    })
    re_pwd = serializers.CharField(required=True)  # 自定义必须校验字段

    def validate_name(self, value):  # value 当前校验字段的值
        print(value)  # 李木子
        print(type(value))  # <class ‘str‘>
        user_obj = models.User.objects.filter(name=value)
        if user_obj:
            raise exceptions.ValidationError(‘该用户已存在 请重新输入‘)
        return value

    def validate(self, attrs):
        # print(attrs)   # {‘name‘: ‘李木子‘, ‘pwd‘: ‘123‘, ‘re_pwd‘: ‘321‘}
        # print(type(attrs))  # <class ‘collections.OrderedDict‘>
        pwd = attrs.get(‘pwd‘)
        re_pwd = attrs.pop(‘re_pwd‘)
        if not pwd == re_pwd:
            raise exceptions.ValidationError(‘两次密码不一致 请重新输入‘)
        return attrs

    def create(self, validated_data):  # save保存函数调用改方法
        return models.User.objects.create(**validated_data)


from django.test import TestCase

# Create your tests here.

（6）视图层：

from django.shortcuts import render
from rest_framework.views import APIView
from . import models, serializers
from rest_framework.response import Response


class User(APIView):
    def get(self, request, *args, **kwargs):
        primary_key = kwargs.get(‘primary_key‘)
        if not primary_key:
            user_obj_list = models.User.objects.all()
            # 序列化组件
            user_ser_data = serializers.UserSerializers(user_obj_list, many=True).data

            return Response({
                ‘status‘: 1,
                ‘msg‘: ‘ok‘,
                ‘results‘: user_ser_data

            })
        try:

            user_obj = models.User.objects.get(pk=primary_key)  # 使用get进行查询 获取用户对象

            user_ser = serializers.UserSerializers(user_obj)  # 如果使用filter获取的queryset对象 不能序列化queryset对象

            user_info_data = user_ser.data  # 获取用户序列化的数据

            return Response({
                ‘status‘: 0,
                ‘msg‘: ‘ok‘,
                ‘results‘: user_info_data
            })
        except:
            return Response({
                ‘status‘: 2,
                ‘msg‘: ‘查询无果‘,

            })

    def post(self, request, *args, **kwargs):
        request_data = request.data  # 获取前段传入数据
        # print(request_data)
        # 判断数据发现

        if not isinstance(request_data, dict) or request_data is None:
            return Response({
                ‘status‘: 2,
                ‘msg‘: ‘数据输入错误 请重新输入‘
            })

        # 将数据进行序列化
        book_ser = serializers.UserDeSerializers(data=request_data)  # 必须将数据复制给data进行反序列化 源码规定
        if not book_ser.is_valid():
            return Response({
                ‘status‘: 1,
                ‘msg‘: book_ser.errors  # 传递错误信息
            })
        # 数据校验通过进行数据保存
        book_obj = book_ser.save()
        data = serializers.UserSerializers(book_obj).data  # 将传入的数据进行序列化传给前端
        return Response({
            ‘status‘: 0,
            ‘msg‘: ‘上传成功‘,
            ‘results‘: data
        })

PS：

　　（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）设置必填与选填序列化字段，设置校验规则
　　（2）为需要额外校验的字段提供局部钩子函数，如果该字段不入库，且不参与全局钩子校验，可以将值取出校验
　　（3）为有联合关系的字段们提供全局钩子函数，如果某些字段不入库，可以将值取出校验
　　（4）重写create方法，完成校验通过的数据入库工作，得到新增的对象