一、DRF框架
1.安装
pip3 install djangorestframework
2.drf框架规矩的封装风格
按功能封装,drf下按不同功能不同文件,使用不同功能导入不同文件
from rest_framework.views import APIView #视图,以后都继承这个,这个也是继承views后一顿操作完善了功能 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 #三大认证-token认证 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‘)
3. drf请求生命周期
1) 请求走的是APIView的as_view函数 ? 2) 在APIView的as_view调用父类(django原生)的as_view,还禁用了 csrf 认证 ? 3) 在父类的as_view中dispatch方法请求走的又是APIView的dispatch ? 4) 完成任务方法交给视图类的请求函数处理,得到请求的响应结果,返回给前台
二、请求模块:request对象
1.源码入口
APIView类的dispatch方法中:request = self.initialize_request(request, *args, **kwargs)
2.源码分析
# 二次封装得到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)
3.重点总结
# 1) drf 对原生request做了二次封装,request._request就是原生request # 2) 原生request对象的属性和方法都可以被drf的request对象直接访问(兼容) # 3) drf请求的所有url拼接参数均被解析到query_params中,所有数据包数据都被解析到data中 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‘)
三、渲染模块
浏览器和Postman请求结果渲染数据的方式不一样就是因为渲染模块
1.源码入口
APIView类的dispatch方法中:self.response = self.finalize_response(request, response, *args, **kwargs)
2.源码分析
# 最后解析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
3.全局配置:所有视图类统一处理,在项目的settings.py中
一个返回数据,一个返回页面,两种渲染方式
REST_FRAMEWORK = { # drf提供的渲染类 ‘DEFAULT_RENDERER_CLASSES‘: [ ‘rest_framework.renderers.JSONRenderer‘, ‘rest_framework.renderers.BrowsableAPIRenderer‘, ], }
4.局部配置:某一个或一些实体类单独处理,在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.为什么要配置解析模块
1)drf给我们通过了多种解析数据包方式的解析类 2)我们可以通过配置来控制前台提交的哪些格式的数据后台在解析,哪些数据不解析 3)全局配置就是针对每一个视图类,局部配置就是针对指定的视图来,让它们可以按照配置规则选择性解析数据
def post(self, request, *args, **kwargs): # url拼接参数:只有一种传参方式就是拼接参数 print(request.query_params) # 数据包参数:有三种传承方式,form-data、urlencoding、json print(request.data) return Response(‘post ok‘)
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.py文件
REST_FRAMEWORK = { # 全局解析类配置 ‘DEFAULT_PARSER_CLASSES‘: [ ‘rest_framework.parsers.JSONParser‘, # json数据包 ‘rest_framework.parsers.FormParser‘, # urlencoding数据包,不是form-date ‘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视图类产生的异常,都可以提供异常处理方案 2)drf默认提供了异常处理方案(rest_framework.views.exception_handler),但是处理范围有限 3)drf提供的处理方案两种,处理了返回异常现象(带提示异常信息那种),没处理返回None(后续就是服务器抛异常给前台,一大堆html代码那种) 4)自定义异常的目的就是解决drf没有处理的异常,让前台得到合理的异常信息返回,后台记录异常具体信息
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.如何使用:自定义exception_handler函数如何书写实现体
# 修改自己的配置文件setting.py REST_FRAMEWORK = { # 全局配置异常模块 ‘EXCEPTION_HANDLER‘: ‘api.exception.exception_handler‘, }
# 0)自定义异常的目的是解决drf没有处理的异常,让前台得到合理的异常信息返回,后台记录异常具体信息 # 1)先将异常处理交给rest_framework.views的exception_handler去处理 # 2)判断处理的结果(返回值)response,有值代表drf已经处理了,None代表需要自己处理 ? # api下自己建一个异常处理文件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={设置的响应头})
原文地址:https://www.cnblogs.com/xp1315458571/p/11682035.html
时间: 2024-10-11 21:12:29