drf框架 - 解析模块 | 异常模块 | 响应模块
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', # 解析urlencoded数据包 'rest_framework.parsers.MultiPartParser' # 解析from-data数据包 ], }
局部配置:应用views.py的具体视图类
from rest_framework.parsers import JSONParser,FormParser,MultiPartParser class Book(APIView): # 局部解析配置 parser_classes = [JSONParseer] # 只解析json数据包 def get(self, request, *args, **kwargs): ... def post(self, request, *args, **kwargs): # url拼接参数 : 只有一种传参方式,参数都在query_params print(request.query_params) # <QueryDict: {'pk': ['1']}> # 数据包参数 : 有三种传参方式 form-data,urlencoded,json,参数都在data print(request.data) # <QueryDict: {'title': ['ha'], 'price': ['3.33']}> return Response('post ok')
补充:
# 禁用 json 方法传输数据包时用json传输数据则报一下错误 { "detail": "Unsupported media type \"application/json\" in request." } # 禁用 urlencoded 方法传输数据包时用urlencoded传输数据则报一下错误 { "detail": "Unsupported media type \"application/x-www-form-urlencoded\" in request." } # 禁用 form-data 方法传输数据包时用form-data传输数据则报一下错误 { "detail": "Unsupported media type \"multipart/form-data; boundary=--------------------------159319842159734003915314\" in request." }
异常模块
为什么要自定义异常模块
1)所有经过drf的APIView视图类产生的异常,都可以提供异常处理方案 2)drf默认提供了异常处理方案(rest_framework.views.exception_handler),但是处理范围有限 3)drf提供的处理方案两种,处理了返回异常现象,没处理返回None(后续就是服务器抛异常给前台) 4)自定义异常的目的就是解决drf没有处理的异常,让前台得到合理的异常信息返回,后台记录异常具体信息
ps:ORM查询时的错误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)
如何使用:
全局配置: settings.py
REST_FRAMEWORK = { # 全局配置异常模块 'EXCEPTION_HANDLER': 'api.exception.exception_handler', # api为应用名 }
应用文件下创建exception.py
from rest_framework.views import exception_handler as drf_exception_handler from rest_framework.response import Response from rest_framework import status def exception_handler(exc, context): # 1.先让drf的exception_handler做基础处理,拿到返回值 # 2.若有返回值则drf处理了,若返回值为空说明drf没处理,需要我们手动处理 response = drf_exception_handler(exc, context) print(exc) # 错误内容 'NoneType' object has no attribute 'title' print(context) # {'view': <api.views.Book object at 0x000001BBBCE05B00>, 'args': (), 'kwargs': {'pk': '3'}, 'request': <rest_framework.request.Request object at 0x000001BBBCF33978>} print(response) # 返回值为空,做二次处理 if response is None: print('%s - %s - %s' % (context['view'], context['request'].method, exc)) # <api.views.Book object at 0x00000242DC316940> - GET - 'NoneType' object has no attribute 'title' return Response({ 'detail': '服务器错误' }, status=status.HTTP_500_INTERNAL_SERVER_ERROR, exception=True) return response
响应模块
响应类构造器: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={设置的响应头})
自定义响应模块
responses.py
from rest_framework.response import Response class APIResponse(Response): def __init__(self, data_status=0, data_msg='ok', results=None, http_status=None, headers=None, exception=None, **kwargs): # data的初始状态: 状态码与状态信息 data = { 'status': data_status, 'msg':data_msg } # data的响应数据体: results (其可能是False,0等数据, 这些数据某些情况下也会作为合法数据返回) if results is not None: data['results'] = results # data响应的其他内容: # if kwargs is not None: # for k, v in kwargs.items(): # setattr(data, k, v) data.update(kwargs) super().__init__(data=data, status=http_status, headers=headers, exception=exception)