DRF部分源碼簡介及序列化組件

時間  2019-11-10
標籤 drf 部分 源碼 簡介 序列 組件 简体版
原文   原文鏈接

一：解析模塊

（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視圖類產生的異常，均可以提供異常處理方案mysql

　　（2）drf默認提供了異常處理方案(rest_framework.views.exception_handler)，可是處理範圍有限
　　（3）drf提供的處理方案兩種，處理了返回異常現象，沒處理返回None(後續就是服務器拋異常給前臺)
　　（4）自定義異常的目的就是解決drf沒有處理的異常，讓前臺獲得合理的異常信息返回，後臺記錄異常具體信息sql

（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）settings文件配置

# 修改本身的配置文件setting.py
REST_FRAMEWORK = {
    # 全局配置異常模塊
    'EXCEPTION_HANDLER': 'api.exception.exception_handler',
}

（4）自定義exception_handler函數書寫實現體

# 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': '數據輸入錯誤 請從新輸入'
            })

        # 將數據進行序列化
        user_ser = serializers.UserDeSerializers(data=request_data)  # 必須將數據複製給data進行反序列化 源碼規定
        if not book_ser.is_valid():
            return Response({
                'status': 1,
                'msg': book_ser.errors  # 傳遞錯誤信息
            })
        # 數據校驗經過進行數據保存
        user_obj= user_ser.save()
        data = serializers.UserSerializers(user_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 就是能夠返回給前臺的序列化數據django

return Response({
        'status': 0,
        'msg': 0,
        'results': user_ser.data
    })　

　　（1）設置必填與選填序列化字段，設置校驗規則
　　（2）爲須要額外校驗的字段提供局部鉤子函數，若是該字段不入庫，且不參與全局鉤子校驗，能夠將值取出校驗
　　（3）爲有聯合關係的字段們提供全局鉤子函數，若是某些字段不入庫，能夠將值取出校驗
　　（4）重寫create方法，完成校驗經過的數據入庫工做，獲得新增的對象json

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程