Django 之restfromwork 源码---APIView 分析

Posted 2022-03-06 qianzhengkai

Django 之 djangorestframework的APIView分析

APIView 类中的as_view() 方法

首先 我们从视图函数入手,在urls.py 中的 URLconfig中添加一条路由

url(r'^books/',views.Book.as_view()),

此时，我们的BookView已经不是继承自django.views中View了，而是restframework.views中的APIView

from django.shortcuts import render,HttpResponse
#导入APIView
from rest_framework.views import APIView

#继承自APIView
class Book(APIView):
    # 这里的request 是被封装后的request，原生的request在request._request
    # 如果想用原生request中的属性， 还是原来的用法，因为Request重写了__getattr__方法。
    # 原生django只能处理 urlencoded 和formdata编码。
    # 如果是json格式，原生django是不能处理的，需要自己从body中取出来自行处理。
    # request.data  不管前端传数据的格式是  urlencoded 和formdata编码 还是json 都从里面取值。
    # request.query_params  里面存的是原生Django 中 GET 方法提供的值
    
    # self.FILES  就是上传的文件
    def get(self,request):
        data = request.data
        
        print(data)
        return HttpResponse('get....')

    def post(self,request):
        return HttpResponse('post....')

as_view():由于BookView没有实现as_view()方法，django启动时，调用的as_view()是APIView中的as_view()

as_view() 方法

# APIView 类中的 as_view() 方法

@classmethod
    def as_view(cls, **initkwargs):
        """
        Store the original class on the view function.
        将原始的类存储在视图函数中
        This allows us to discover information about the view when we do URL reverse lookups.  
        这允许我们在进行URL反向查找时发现关于视图的信息
        Used for breadcrumb generation.
        """
        if isinstance(getattr(cls, 'queryset', None), models.query.QuerySet):
            def force_evaluation():
                raise RuntimeError(
                    'Do not evaluate the `.queryset` attribute directly, '
                    'as the result will be cached and reused between requests. '
                    'Use `.all()` or call `.get_queryset()` instead.'
                )
            cls.queryset._fetch_all = force_evaluation
        # APIView 是继承自django.views中的View,因此这里的 as_view() 也是调用父类的as_view()
        view = super(APIView, cls).as_view(**initkwargs)
        view.cls = cls
        view.initkwargs = initkwargs

        # Note: session based authentication is explicitly CSRF validated,
        # all other authentication is CSRF exempt.
        return csrf_exempt(view)

源码分析：

? 继承了APIView之后：

• ? 所有的请求都没有csrf的认证了
• ? 在APIView中 as_view本质还是调用父类(View)中的as_view()
• ? as_view 中调用dispatch ————> 这个dispatch 是 APIView的dispatch

dispatch() 方法

• 对原生的request对象做了一层包装（面向对象的封装），以后再用的request 对象都是新的的request对象
• 在 APIView 中 self.initial(request,*args,**kwargs) 里面有频率控制，权限控制和认证相关
• 根据请求方法执行咱们写的视图类中的相应方法：
  • 视图类中方法的request对象，已经变成 了封装后的request
  • 在Request类中：
    • 原生的request是self._request
    • 取以post形式提交数据，从reuqest.data中取
    • query_params 就是原生request 的GET 数据
    • 上传文件时从FILES中取
    • （重要）其他的属性，自己request.属性名（因为重写了__getattr__方法）

# dispatch
def dispatch(self, request, *args, **kwargs):
        """
        `.dispatch()` is pretty much the same as Django's regular dispatch,  该方法很想Django 原先的dispatch方法
        but with extra hooks for startup, finalize, and exception handling. 但是它扩展了一些用于启动，结束，异常处理的钩子
        """
        self.args = args  # 这里的self 对于上述的Book类而言是一个Book类的对象
        self.kwargs = kwargs
        # 将原先的request 封装后返回
        request = self.initialize_request(request, *args, **kwargs)
        self.request = request  # 将 上面返回的值在request接收后，又放在self对象的自己的request中去
        self.headers = self.default_response_headers  # deprecate?

        try:
            # 该处用的request 就是被封装过后的request，原先的request 在 rerquest._request中
            self.initial(request, *args, **kwargs)
            
            # Get the appropriate handler method
            # 如果request请求方法在在 http_method_names列表中的方法中
            if request.method.lower() in self.http_method_names:
                # getattr 反射去获取该方法的内存地址
                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

initialize_request() 方法

 def initialize_request(self, request, *args, **kwargs):
        """
        Returns the initial request object.
        返回一个初始化的request对象
        """
        parser_context = self.get_parser_context(request)
        # 这个 return 的Request 类不是Django自己的request了， 是drf框架里面自己定义的Request
        # 把原生django的request对象封装到该Request对象中，并且叫 _reuqest
        return Request(
            request,
            parsers=self.get_parsers(),
            authenticators=self.get_authenticators(),
            negotiator=self.get_content_negotiator(),
            parser_context=parser_context
        )

initial()方法

    def initial(self, request, *args, **kwargs):
        """
        Runs anything that needs to occur prior to calling the method handler.
        """
        self.format_kwarg = self.get_format_suffix(**kwargs)

        # Perform content negotiation and store the accepted info on the request
        neg = self.perform_content_negotiation(request)
        request.accepted_renderer, request.accepted_media_type = neg

        # Determine the API version, if versioning is in use.
        version, scheme = self.determine_version(request, *args, **kwargs)
        request.version, request.versioning_scheme = version, scheme

        # Ensure that the incoming request is permitted
        self.perform_authentication(request)  # 认证
        self.check_permissions(request)  # 权限
        self.check_throttles(request)  # 频率

Reuqest类

class Request(object):

    def __init__(self, request, parsers=None, authenticators=None,
                 negotiator=None, parser_context=None):
        ...
        #将原始的WSGIReqeust对象复制给_request
        self._request = request

        ....

    #调用旧的request.GET
    @property
    def query_params(self):return self._request.GET
    
    #调用旧的request.POST
    @property
    def POST(self):return QueryDict('', encoding=self._request._encoding)  

注：之后使用的request，都是restfromwork封装的Request对象

执行流程

"""
1.views.Book.as_view()
2.Book类中没有 as_view方法，去其父类APIView中找
3.在APIView中的as_view 方法中 执行了这样一句代码
    view = super(APIView, cls).as_view(**initkwargs)
    因此最终的as_view 还是从View 中的as_view来
4. 执行View里面的as_view()方法，返回view函数
5. url和视图函数之间建立绑定关系完毕，等待用户请求
6. 接收到用户请求，执行 Book--as_view(此处的as_view出处已再说上面，再次不再赘述)--View.as_view
7.执行self.dispatch()的时候，执行结果是什么就返回什么
8.开始找dispatch方法，self里面没有，Book类中也没有，在 APIView 中
9.开始执行APIView 中的 dispatch方法
10.最后找到http方法（get，post，put，delete）
11. 开始执行找到的方法(GET)，self.get(),此时的self代表Book的实例化对象
12. 假设 请求为POST 请求，
    request.data  --->获取POST请求前端发送过来的数据
    request.FILES ----> 获取POST请求前端发送过来的文件
13. 开始执行reqeust.data
      @property
        def data(self):
            if not _hasattr(self, '_full_data'):
                self._load_data_and_files()
            return self._full_data
14. 执行该函数里面的  self._load_data_files()
15. 执行 self._load  self.files=self.parse()
16. 执行 parser = self.negotiator.select_parser(self, self.parsers)
17. 查找：self.parsers
18. 执行 并向上返回结果
"""