DRF框架
# 安装
>: pip3 install djangorestframework
# 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) 完成任务方法交给视图类的请求函数处理，得到请求的响应结果，返回给前台
"""
请求模块
源码分析:
# 1.rest_frameworkviews.py
class APIView(View):
def dispatch(self, request, *args, **kwargs):
self.args = args
self.kwargs = kwargs
# 源码入口:二次封装得到def的request对象
request = self.initialize_request(request, *args, **kwargs)
# 2.rest_frameworkviews.py
from rest_framework.request import Request
class APIView(View):
def initialize_request(self, request, *args, **kwargs):
parser_context = self.get_parser_context(request)
return Request(
request,
parsers=self.get_parsers(),
authenticators=self.get_authenticators(),
negotiator=self.get_content_negotiator(),
parser_context=parser_context
)
# 3.rest_framework
equest.py
class Request:
def __init__(self, request, parsers=None, authenticators=None,
negotiator=None, parser_context=None):
...
# 将原生的request保存为该类的属性_request.
self._request = request
...
# __getattr__方法触发条件:当在当前实例对象中未找到该属性时触发.
def __getattr__(self, attr):
try:
# 当在APIView中未获取到类属性时,便会执行__getattr__,从原生的request对象中找,使得属性完全兼容原生request
return getattr(self._request, attr)
except AttributeError:
return self.__getattribute__(attr)
请求模块总结:
"""
重点总结:
1) drf 对原生request做了二次封装，request._request就是原生request
2) 原生request对象的属性和方法都可以被drf的request对象直接访问(兼容)
3) drf请求的所有url拼接参数均被解析到query_params中，所有数据包数据都被解析到data中
"""
请求模块测试:
# request对象测试
class Test(APIView):
def get(self, request, *args, **kwargs):
# url拼接的参数
print(request._request.GET) # 二次封装方式
print(request.GET) # 兼容
print(request.query_params) # 拓展
return Response('drf get ok')
def post(self, request, *args, **kwargs):
# 所有请求方式携带的数据包
print(request._request.POST) # 二次封装方式
print(request.POST) # 兼容
print(request.data) # 拓展，兼容性最强，三种数据方式都可以
print(request.query_params)
return Response('drf post ok')
渲染模块
源码分析:
# rest_frameworkviews.py
class APIView(View):
def dispatch(self, request, *args, **kwargs):
# ...
# 三大认证之后只有该方法,所以进入.
self.response = self.finalize_response(request, response, *args, **kwargs)
# ...
def finalize_response(self, request, response, *args, **kwargs):
if isinstance(response, Response):
if not getattr(request, 'accepted_renderer', None):
# 由此进入
neg = self.perform_content_negotiation(request, force=True)
# accepted_renderer来自上句代码neg
request.accepted_renderer, request.accepted_media_type = neg
response.accepted_renderer = request.accepted_renderer
def perform_content_negotiation(self, request, force=False):
# ...
# 从此处获取渲染类们
renderers = self.get_renderers()
# 得到该熟悉的代码,可以进行全局/局部配置.
def get_renderers(self):
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', # urlencoding数据包
'rest_framework.parsers.MultiPartParser' # form-date数据包
],
}
局部配置：应用views.py的具体视图类
from rest_framework.parsers import JSONParser
class Book(APIView):
# 局部解析类配置，只要json类型的数据包才能被解析
parser_classes = [JSONParser]
pass
异常模块
"""
1）所有经过drf的APIView视图类产生的异常，都可以提供异常处理方案
2）drf默认提供了异常处理方案(rest_framework.views.exception_handler)，但是处理范围有限
3）drf提供的处理方案两种，处理了返回异常现象，没处理返回None(后续就是服务器抛异常给前台)
4）自定义异常的目的就是解决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)
如何使用：自定义exception_handler函数如何书写实现体
# 修改自己的配置文件setting.py
REST_FRAMEWORK = {
# 全局配置异常模块
'EXCEPTION_HANDLER': 'api.exception.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
响应模块
响应类构造器：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={设置的响应头})