解析模塊
為什么要配置解析模塊
1）drf給我們提供了多種解析數據包方式的解析類 form-data/urlencoded/json 2）我們可以通過配置來控制前台提交的哪些格式的數據后台在解析，哪些數據不解析 3）全局配置就是針對每一個視圖類，局部配置就是針對指定的視圖來，讓它們可以按照配置規則選擇性解析數據
源碼入口
# APIView類的dispatch方法中 request = self.initialize_request(request, *args, **kwargs) # 點進去
#准備要解析的數據
parser_context=self.get_parser_context(request) #不是重點
# 解析模塊，獲取解析類 parsers=self.get_parsers() # 點進去 # 去類屬性(局部配置) 或 配置文件(全局配置) 拿 parser_classes return [parser() for parser in self.parser_classes]
解析模塊源碼：rest_framework/parsers.py
自定義全局配置：項目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.parsers import JSONParser class Book(APIView): # 局部解析類配置，只要json類型的數據包才能被解析 parser_classes = [JSONParser] pass
代碼示例
在局部設置只能解析json格式數據，在postman其他格式傳遞的數據都不顯示
url拼接的參數，通過request.query_params獲取參數。數據包傳參通過request.data獲取
from . import models from rest_framework.views import APIView from rest_framework.response import Response from rest_framework.parsers import JSONParser #用作解析類 class Book(APIView): # 局部解析類配置,post提交數據只能解析json格式數據 parser_classes = [JSONParser] #如果[]為空，那么就相當於沒有設置解析類型 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) # 點進去
#自定義異常就是提供異常處理函數exception_handler,處理的目的就是讓response一定有值 #自定義：自己寫exception_handler函數，在自己的配置文件配置EXCEPTION_HANDLER指向自己的處理異常函數 exception_handler = self.get_exception_handler() #點進去 #獲取處理異常的方法，也可以自定義異常處理方法，在settings文件中配置
#settings中獲取異常處理的方式
return self.settings.EXCEPTION_HANDLER
#異常處理的結果 # 自定義異常就是提供exception_handler異常處理函數，處理的目的就是讓response一定有值 response = exception_handler(exc, context) #最后發現在views中的exception_handler就是處理異常的方法
如何使用：自定義exception_handler函數如何書寫實現體
# 修改自己的配置文件setting.py REST_FRAMEWORK = { # 全局配置異常模塊 'EXCEPTION_HANDLER': 'api.exception.exception_handler', #設置自定義異常文件路徑，在api應用下創建exception文件，exception_handler函數 }
api應用下創建處理異常文件exception.py
1）先將異常處理交給rest_framework.views的exception_handler去處理 （******）
2）判斷處理的結果(返回值)response，有值代表drf已經處理了，None代表drf處理不了的異常，需要自定義去處理 （******） # 自定義異常處理文件exception，重寫exception_handler函數 from rest_framework.views import exception_handler as drf_exception_handler #drf原生處理異常函數取別名 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) # 為空，就是drf框架處理不了的異常 if response is None: #處理之后為空，再進行自定義的二次處理 # print(exc) #錯誤原因 還可以做更詳細的原因，通過判斷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 #處理之后有值，就直接返回結果
異常模塊的大致流程：從dispatch中的handle_exception進入，get_exception_handler()獲得處理異常方法exception_handler()，在這里也可以自定義異常方法。執行exception_handler()獲取異常處理的結果。
響應模塊
響應類構造器：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
使用：常規實例化相應對象
# status就是解釋一堆 數字 網絡狀態碼的模塊 from rest_framework import status就是解釋一堆 數字 網絡狀態碼的模塊 # 一般情況下只需要返回數據，status和headers都有默認值 return Response(data={數據}, status=status.HTTP_200_OK, headers={設置的響應頭})
序列化組件（下面都是講關於Serializer）
1.定義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='old_boy_user' verbose_name='用戶' verbose_name_plural=verbose_name def __str__(self): return '%s' %self.name
自定義序列化類（自定義serializer類）：
from rest_framework import serializers
class User(serializers.Serializer): id = serializers.IntergetField() #序列化括號里面不用加條件
name = serializer.CharField()
.
.
.
- 配置層：settings.py
# 注冊rest_framework INSTALLED_APPS = [ # ... 'rest_framework', ]
2.分析源碼創建Serializer對象中參數
源碼分析 BaseSerializer
def __init__(self, instance=None, data=empty, **kwargs):
定義好Serialzier類后，就可以創建Serializer對象了。
Serializer的構造方法為：
Serializer(instance=None,data=empty,**kwargs)
說明：
1.用於序列化時，將模型類對象傳入instance參數
2.用於反序列化時，將要被反序列化的數據傳入data參數
3.除了instance和data參數外，在構造Serializer對象時，還可以通過context參數額外添加數據 通過context參數附加的數據，可以通過Serializer對象的context屬性獲取
serializer = AccountSerializer(account,context={'request':request})
總結注意：（******）
1.使用序列化器的時候一定要注意，序列化器聲明了以后，不會自動執行，需要我們在視圖中進行調用才可以 2.序列化器無法直接接收數據，需要我們在視圖中創建序列化器對象時把使用的數據傳遞過來。（data,instance傳參） 序列化是：數據對象從數據庫中查出，通過instance傳入序列化器中，必須通過data屬性才能將序列化后的數據傳給前端，不能直接傳序列化對象 反序列化是：數據是通過request.data從前端獲取到數據，通過data傳入序列化器中進行校驗，保存到數據庫中 3.序列化器的字段聲明類似於我們前面使用過的表單系統 4.開發restful api時，序列化器會幫我們把模型數據轉換成字典。 5.drf提供的視圖會幫我們把字典轉換成json，或者把客戶端發過來的數據轉換成字典
3.序列化器的使用
序列化器的使用分兩個階段：
1.在客戶端請求時：使用序列化器可以完成對數據的反序列化（就是前段往后端傳遞數據，反序列化之后保存數據）
2.在服務器響應時，使用序列化器可以完成對數據的序列化（服務器取出數據，序列化之后往前段發送展示）
序列化使用流程：
基本使用：
1.先查詢出一個用戶對象
from models import user user = User.object.get(id=2)
2.構造序列化器對象
from user.serializers import UserSerializer user_obj = Userserializer(user) #放入查詢出的user對象
3.獲取序列化對象 通過data屬性可以獲取序列化后的數據
上面查出來的user_ser是一個serializer對象，需要取出具體的數據傳給前端，所有要用到 user_ser.data取出具體數據
user_ser = Userserializer(user).data
4.如果要被序列化的數據是包含多條數據的（也可以說被[ ]嵌套的，queryset類型數據，不管是多條還是單條）,需要添加many=True參數
user = models.User.objects.all() user_ser = Userserialzier(user,many=True)
5.自定義序列化屬性(重點******) 下面有代碼示例具體操作
serializers.SerializerMethodField()
反序列化使用流程：
數據驗證：
1.使用序列化器進行反序列化時，需要對數據進行驗證后，才能獲取驗證成功的數據或保存成模型類對象。
2.在獲取反序列化的數據前，必須調用is_valid()方法進行驗證，驗證成功返回True，否則返回False。
3.驗證失敗，可以通過序列化對象的errors屬性獲取錯誤信息，返回字典，包含了字段和字段的錯誤。
4.驗證通過，可以通過序列化器對象的validated_data屬性獲取數據
保存數據：
序列化類中必須重寫create方法用於新增，重寫update方法是修改
視圖中使用create()和save()方法
從源碼可知save()方法內部調用的是序列化類中的create方法，所以新增必須要在序列化類中重寫create方法
4.代碼示例序列化和反序列化在Serialzier組件中使用
序列化使用（展示給前台的數據）
- 序列化層：api/serializers.py (api應用下創建serializers.py文件)
1）設置需要返回給前台數據樣式 那些model類有對應的字段，不需要返回的就不用設置了 2）設置方法字段，字段名可以隨意，字段值由 get_字段名 提供，來完成一些需要處理在返回的數據,類似於forms組件
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): # choice類型的解釋型值 get_字段_display() 來訪問 return obj.get_sex_display() #自定義序列化屬性icon 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) 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) return Response({ 'status': 0, 'msg': 0, 'results': user_ser.data #如果你在序列化的時候沒有.data,那么在傳給前端的時候必須要.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 })
反序列化使用 （把數據存入數據庫）
- 反序列層：api/serializers.py
1）設置必填與選填序列化字段，設置校驗規則 2）為需要額外校驗的字段提供局部鈎子函數，如果該字段不入庫，且不參與全局鈎子校驗，可以將值取出校驗 pop 3）為有聯合關系的字段們提供全局鈎子函數，如果某些字段不入庫，可以將值取出校驗 4）必須重寫create方法，完成校驗通過的數據入庫工作，得到新增的對象
class UserDeserializer(serializers.Serializer): # 1) 哪些字段必須反序列化 # 2) 字段都有哪些安全校驗 # 3) 哪些字段需要額外提供校驗 鈎子函數 # 4) 哪些字段間存在聯合校驗 # 注：反序列化字段都是用來入庫的，不會出現自定義方法屬性，會出現可以設置校驗規則的自定義屬性,不入數據庫的 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 re_pwd = serializers.CharField(required=True) # 小結： # name，pwd，re_pwd為必填字段 # phone，sex為選填字段 # 五個字段都必須提供完成的校驗規則 # 局部鈎子：validate_要校驗的字段名(self, 當前要校驗字段的值) # 校驗規則：校驗通過返回原值，校驗失敗，拋出異常 def validate_name(self, value): if 'g' in value.lower(): # 名字中不能出現g raise exceptions.ValidationError('名字非法，是個雞賊！') return value # 全局鈎子：validate(self, 通過系統與局部鈎子校驗之后的所有數據) # 校驗規則：校驗通過返回原值，校驗失敗，拋出異常 def validate(self, attrs): #attrs是字典格式 pwd = attrs.get('pwd') re_pwd = attrs.pop('re_pwd') #因為re_pwd不需要入數據庫，所以在全局鈎子校驗中刪除掉這個字段 if pwd != re_pwd: raise exceptions.ValidationError({'pwd&re_pwd': '兩次密碼不一致'}) return attrs # 要完成新增，必須自己重寫 create 方法，validated_data是校驗的數據 def create(self, validated_data): # 盡量在所有校驗規則完畢之后，數據可以直接入庫 return models.User.objects.create(**validated_data)
- 視圖層:views.py
反序列化視圖層三步：
1）book_ser = serializers.UserDeserializer(data=request_data) # 反序列化數據必須賦值data,結果就是得到一個serializer對象 2）book_ser.is_valid() # 把數據放到自定義serializer中校驗，數據校驗成功返回True,失敗返回False 3）不通過返回 book_ser.errors 給前台，通過 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, })