目录
drf框架 - 请求模块 | 渲染模块 解析模块 | 异常模块 | 响应模块
Postman接口工具
get请求，携带参数采用Params
post等请求，提交数据包可以采用三种方式：form-date、urlencoding、json
所有请求都可以携带请求头
drf框架
>: pip3 install djangorestframework
注册rest_framework
settings.py注册
app：INSTALLED_APPS = [
...,
'rest_framework'
]
drf框架风格
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.request import Request
from rest_framework.serializers import Serializer
from rest_framework.settings import APISettings
from rest_framework.filters import SearchFilter
from rest_framework.pagination import PageNumberPagination
from rest_framework.authentication import TokenAuthentication
from rest_framework.permissions import IsAuthenticated
from rest_framework.throttling import SimpleRateThrottle
class Test(APIView):
def get(self, request, *args, **kwargs):
return Response('drf get ok')
drf请求生命周期
"""
1) 请求走的是APIView的as_view函数
2) 在APIView的as_view调用父类(django原生)的as_view，还禁用了 csrf 认证
3) 在父类的as_view中dispatch方法请求走的又是APIView的dispatch,
4) 然后完成任务分发交给视图类的请求函数处理，得到请求的响应结果，返回给前台
"""
请求模块
请求模块：request对象
源码入口
APIView类的dispatch方法中：request = self.initialize_request(request, *args, **kwargs)
源码分析
# 将wsgiref的原生request二次封装得到def的request对象
request = self.initialize_request(request, *args, **kwargs) 点进去
# 在rest_framework.request.Request实例化方法中
self._request = request # 将原生request作为新request的_request属性
# 在rest_framework.request.Request的__getattr__方法中
try:
return getattr(self._request, attr) # 访问属性完全兼容原生request
except AttributeError:
return self.__getattribute__(attr)
重点总结
# 1) drf 对原生request做了二次封装，request._request就是原生request
# 2) 原生request对象的属性和方法都可以被drf的request对象直接访问(兼容)
# 3) drf请求的所有url拼接参数均被解析到query_params中，所有数据包数据都被解析到data中
请求生命周期: APIView（as_view）禁用csrf => View（as_view）=> APIView(dispatch) => 视图类的请求方法 => 响应
基于restful规范的drf接口
api应用的子路由: api/url.py
from django.conf.urls import url
from . import views
urlpatterns = [
# 这里的as_view是APIView类中的,作用是禁用了csrf_exempt,并返回view,调用了View类中的as_view方法
url(r'^test/$',views.Test.as_view())
]
视图层: views.py
# APIView本质是继承了View
class Test(APIView):
def get(self, request, *args, **kwargs):
# url 拼接的参数
print(request._request.GET) # 二次封装request
print(request.GET) # 兼容
print(request.query_params) # 扩展,GET请求拼接的参数这里都有
return Response('drf get ok')
def post(self, request, *args, **kwargs):
# 请求携带的数据包
print(request._request.POST) # 二次封装方式,没有json方式的数据
print(request.POST) # 兼容,没有json方式的数据
print(request.data) # 拓展，兼容性最强，三种数据方式都可以
print(request.query_params) # post拼接的数据也可以接受到
return Response('drf post ok')
总结:
# url拼接参数 : 只有一种传参方式,参数都在query_params中
# 数据包参数 : 有三种传参方式 form-data,urlencoded,json,参数都在data中
渲染模块
ps：浏览器和Postman请求结果渲染数据的方式不一样
源码入口
APIView类的dispatch方法中：self.response = self.finalize_response(request, response, *args, **kwargs)
源码分析
# 最后解析reponse对象数据
self.response = self.finalize_response(request, response, *args, **kwargs) 点进去
# 拿到运行的解析类的对象们
neg = self.perform_content_negotiation(request, force=True) 点进去
# 获得解析类对象
renderers = self.get_renderers() 点进去
# 从视图类中得到renderer_classes请求类，如何实例化一个个对象形参解析类对象列表
return [renderer() for renderer in self.renderer_classes]
重点
self.renderer_classes获取renderer_classes的顺序
# 自己视图类的类属性(局部配置) =>
# APIView类的类属性设置 =>
# 自己配置文件的DEFAULT_RENDERER_CLASSES(全局配置) =>
# drf配置文件的DEFAULT_RENDERER_CLASSES
使用
全局配置：所有视图类统一处理，在项目的settings.py中
REST_FRAMEWORK = {
# drf提供的渲染类
'DEFAULT_RENDERER_CLASSES': [
'rest_framework.renderers.JSONRenderer',
'rest_framework.renderers.BrowsableAPIRenderer',
],
}
局部配置：某一个或一些实体类单独处理，在views.py视图类中提供对应的类属性
class Test(APIView):
def get(self, request, *args, **kwargs):
return Response('drf get ok')
def post(self, request, *args, **kwargs):
return Response('drf post ok')
# 在setting.py中配置REST_FRAMEWORK，完成的是全局配置，所有接口统一处理
# 如果只有部分接口特殊化，可以完成 - 局部配置
from rest_framework.renderers import JSONRenderer
class Test2(APIView):
# 局部配置
renderer_classes = [JSONRenderer] # 所在类局部配置
def get(self, request, *args, **kwargs):
return Response('drf get ok 2')
def post(self, request, *args, **kwargs):
return Response('drf post ok 2')
解析模块
为什么要配置解析模块
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)