drf框架的模块分析

请求模块

请求模块是个什么鬼

'''

1、drf的request是在wsgi的request基础上再次封装

2、wsgi的request作为drf的request一个属性：_request

3、新的request对旧的request做了完全兼容

4、新的request对数据解析更规范化：所有的拼接参数都解析到query_params中，所有数据包数据都被解析到data中

    query_params和data属于QueryDict类型，可以 .dict() 转化成原生dict类型

源码入口

APIView类的dispatch方法中self.initialize_request(request, *args, **kwargs)

'''

1、drf的APIView类：重写了as_view()，但主体逻辑还是调用父类View的as_view()，局部禁用了csrf认证校验

    重点：所有继承drf的基本视图类APIView的视图类，都不在做csrf认证校验

2、drf的APIView类：重写了dispatch()，在内部对request进行了二次封装：self.initialize_request(request, *args, **kwargs)

'''

源码分析

"""

# 二次封装得到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.入口是从APIView中的dispatch方法中看源码

2. request = self.initialize_request(request, *args, **kwargs)这是request的二次封装

3. try:

            self.initial(request, *args, **kwargs) #request对象处理完之后，请求之前执行的代码，这个通过了才可以请求，没有通过就是走response

            # Get the appropriate handler method

            if request.method.lower() in self.http_method_names:#请求

                handler = getattr(self, request.method.lower(),

                                  self.http_method_not_allowed)

            else:

                handler = self.http_method_not_allowed

            response = handler(request, *args, **kwargs)

        except Exception as exc:

            response = self.handle_exception(exc)

        self.response = self.finalize_response(request, response, *args, **kwargs)

        return self.response

4.request = self.initialize_request(request, *args, **kwargs)点击initialize_request

parser_context = self.get_parser_context(request)将request传入进行解析数据

5.

#这个request是导入的from rest_framework.request import Request的类

这是在实例化

  return Request(

            request, #传入原生的request

            parsers=self.get_parsers(), #self代表视图函数中的自定义类的对象，没有重写的就到APIView中找找，解析数据

            authenticators=self.get_authenticators(),

            negotiator=self.get_content_negotiator(),

            parser_context=parser_context

        )

6.点击Request这个类，__init__先走断言，是否遵守了https协议，遵守了就到self._request = request

7.self.name这是会触发魔法方法__getattr__方法，所以找到Reuqest的__getattr__方法

8.

继承了APIView  request就不是原生django的，而是drf的request方法，request.属性就会触发（request.user）__getattr__

 def __getattr__(self, attr):

        """

        If an attribute does not exist on this instance, then we also attempt

        to proxy it to the underlying HttpRequest object.

        """

        try:

            return getattr(self._request, attr)  #而这里self._request是原生django的reqeust,在Request类实例化的时候进行赋值的，这里就是完全兼容了原功能，在此基础上再拓展新功能，先在这里面找，找不到去自己的self.__getattribute__(attr)中找

        except AttributeError:

            return self.__getattribute__(attr)

9.

views.py中的类

class Test(APIView):

    def get(self, request, *args, **kwargs):

        return Response('drf get ok')  #在这里打断点

然后postman发送GET http//127.0.0.1:8000/api/test/ 的请求数据

查看后台debug数据request展开，这里面找到下划线_request就是django原生的WSGIR协议的request

_request中可以找到GET,POST,META

在request中找不到GET，META，但是有data,POST，query_params

data是django,res_framework中三种方式提交数据包都会解析到这里来 比如PUT，POST

而GET请求的数据会解析到query_params里面

第五步：

第六步

内部核心

'''

走drf的Request初始化方法__init__：self._request = request

drf的Request的getter方法__getattr__：先从self._request反射取属性，没取到再从drf的request中取

'''

核心：request除了可以访问原wsgi协议的request所有内容，还可以访问 query_params、data

总结

# 1) drf 对原生request做了二次封装，request._request就是原生request

# 2) 原生request对象的属性和方法都可以被drf的request对象直接访问(兼容)

# 3) drf请求的所有url拼接参数均被解析到query_params中，所有数据包数据都被解析到data中

1、

#三种获取get请求数据的方法

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')

2、

postman中发送post请求，使用form_data和json和urlencoded发送新增数据

    def post(self, request, *args, **kwargs):

        # 所有请求方式携带的数据包

        print(request._request.POST)  # 二次封装方式，这里只能获取到form_data和urlencoded的数据

        print(request.POST)  # 兼容，这里也只能获取搭配form_data和urlencoded的数据

        print(request.data)  # 拓展，兼容性最强，三种数据方式都可以，这里三种请求方式的数据都可以获取的到

        print(request.query_params)

        return Response('drf post ok')

渲染模板

渲染模块是什么东东

1、可以在视图类中通过renderer_classes类属性对该视图的数据响应渲染做配置 - 局部配置

2、可以在项目的配置文件的drf配置中通过DEFAULT_RENDERER_CLASSES对该视图的数据响应渲染做配置 - 全局配置

注：如果一个视图类在有全局配置下，还进行了局部配置，优先走自己的局部配置

源码入口

APIView类的dispatch方法中：

self.response = self.finalize_response(request, response, *args, **kwargs)

源码分析

'''

1、二次处理响应对象：APIView的dispatch方法 - self.finalize_response(request, response, *args, **kwargs)

2、获取渲染类对象：进入finalize_response方法 - self.perform_content_negotiation(request, force=True)

3、从配置文件中得到渲染类对象：perform_content_negotiation -> self.get_renderers() -> [renderer() for renderer in self.renderer_classes]

'''

"""

self.response = self.finalize_response(request, response, *args, **kwargs)这里点击finalize_response进入

# 最后解析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的顺序

#   自己视图类的类属性(局部配置Renderclass就是局部) =>

#   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]  #局部禁用就是配置空List，这里只支持JSON格式的数据

    def get(self, request, *args, **kwargs):

        return Response('drf get ok 2')

    def post(self, request, *args, **kwargs):

        return Response('drf post ok 2')

核心：可以全局和局部配置视图类支持的结果渲染：默认可以json和页面渲染，学习该模块的目的是开发可以全局只配置json方式渲染

解析模块

为什么要配置解析模块

"""

1）drf给我们通过了多种解析数据包方式的解析类

2）我们可以通过配置来控制前台提交的哪些格式的数据后台在解析，哪些数据不解析

3）全局配置就是针对每一个视图类，局部配置就是针对指定的视图来，让它们可以按照配置规则选择性解析数据

"""

注：如果一个视图类在有全局配置下，还进行了局部配置，优先走自己的局部配置

源码入口

request = self.initialize_request(request, *args, **kwargs)

# APIView类的dispatch方法中

request = self.initialize_request(request, *args, **kwargs)  # 点进去

# 获取解析类

parsers=self.get_parsers(),  # 点进去

# 去类属性(局部配置) 或 配置文件(全局配置) 拿 parser_classes

return [parser() for parser in self.parser_classes]

'''

1、二次处理响应对象：APIView的dispatch方法 - self.finalize_response(request, response, *args, **kwargs)

2、获取渲染类对象：进入finalize_response方法 - self.perform_content_negotiation(request, force=True)

3、从配置文件中得到渲染类对象：perform_content_negotiation -> self.get_renderers() -> [renderer() for renderer in self.renderer_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

核心：可以全局和局部配置视图类支持的结果渲染：默认可以json和页面渲染，学习该模块的目的是开发可以全局只配置json方式渲染

异常模块

为什么要自定义异常模块

"""

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

响应模块

响应模块哈哈哈

""" 响应模块

Response类生成对象需要的参数，以及Response类的对象可以使用的属性

1、参数：Response(data=响应的数据, status=响应的网络状态码, headers=想通过响应头再携带部分信息给前端)

2、属性：response.data  response.status_code  response.status_text

源码：Response类的__init__方法,还是在dispatch那里点进去

"""

源码分析

源码入口：self.response = self.finalize_response(request, response, *args, **kwargs)

1.

self.response = self.finalize_response(request, response, *args, **kwargs)  #finalize_response点进去

2.

if isinstance(response, Response)   #点击Response点进去

3.得到：

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={设置的响应头、})

核心：知道response对象产生可以传那些信息，response对象又是如何访问这些信息的

巴特西

drf框架的模块分析

请求模块

请求模块是个什么鬼

源码入口

源码分析

内部核心

总结

渲染模板

渲染模块是什么东东

源码入口

源码分析

全局配置：所有视图类统一处理，在项目的settings.py中

局部配置：某一个或一些实体类单独处理，在views.py视图类中提供对应的类属性

解析模块

为什么要配置解析模块

源码入口

全局配置：项目settings.py文件

局部配置：应用views.py的具体视图类

异常模块

为什么要自定义异常模块

源码分析

如何使用：自定义exception_handler函数如何书写实现体

响应模块

响应模块哈哈哈

源码分析

使用：常规实例化响应对象

最新文章

热门文章