django类视图as_view()方法解析

  使用视图函数时,django完成URL解析之后,会直接把request对象以及URL解析器捕获的参数(比如re_path中正则表达捕获的位置参数或关键字参数)丢给视图函数,但是在类视图中,这些参数不能直接丢给一个类,所以就有了as_view方法,这个方法只做一件事就是返回一个闭包,这个闭包像视图函数一样接收url解析器传送过来的参数。

先摆个例子放开头,以供参考:

# urls.py
from blog.views import IndexView

urlpatterns = [
    re_path(r"^$", IndexView.as_view(), name="index"),
]

1、首先了解path和re_path的执行逻辑

进到path或re_path的定义处,可以看到他们都是partial类的实例,所以path和re_path都是对象,而不是普通函数。

path = partial(_path, Pattern=RoutePattern)
re_path = partial(_path, Pattern=RegexPattern)

当启动django项目时,程序执行到urlpatterns时,urlpatterns列表中的各项依次得到执行,由于re_path和path都是对象,当对象像函数一样调用时,其实是调用对象中的__call__方法,执行的结果就是,每个path或re_path的调用都返回一个URLPattern类的实例对象(路径为django.urls.resolvers.URLPattern),如果打印一下re_path的执行结果,得到如下结果:

print(re_path(r"^$", IndexView.as_view(), name="index"))
执行结果:
>> <URLPattern '^$' [name='index']>  # 返回一个URLPattern对象

来看看URLPattern类的定义:

def __init__(self, pattern, callback, default_args=None, name=None):
        self.pattern = pattern
        self.callback = callback  # the view
        self.default_args = default_args or {}
        self.name = name

可以看到,URLPattern类__init__方法中的各个参数基本上就对应了传入path或re_path中的参数,其中有个callback属性,就是保存了回调函数的引用。而在path或re_path执行的时候,第二个参数传入的是as_view()(注意传入的不是as_view,而是as_view(),as_view()会立即执行),as_view()执行完成后,返回一个闭包,所以,callback保存的是这个闭包的引用。每次当请求来临时,url解析器完成url的解析,匹配到相应的回调函数,然后执行。

这里要提醒一点是,as_view只会执行一次,就是django在项目启动后,之后所有请求的处理都是由as_view返回的闭包(也就是URLPattern实例对象中的回调函数)执行。

2、再来看看上面说的闭包是什么

首先给出as_view方法的完整源码

    @classonlymethod
    def as_view(cls, **initkwargs):"""Main entry point for a request-response process."""
        for key in initkwargs:
            if key in cls.http_method_names:
                raise TypeError("You tried to pass in the %s method name as a "
                                "keyword argument to %s(). Don't do that."
                                % (key, cls.__name__))
            if not hasattr(cls, key):
                raise TypeError("%s() received an invalid keyword %r. as_view "
                                "only accepts arguments that are already "
                                "attributes of the class." % (cls.__name__, key))

        def view(request, *args, **kwargs):
            self = cls(**initkwargs)  # 实例化一个类视图对象
            if hasattr(self, 'get') and not hasattr(self, 'head'):
                self.head = self.get
            self.setup(request, *args, **kwargs)  # 初始化实例属性,保存外面传来的参数
            if not hasattr(self, 'request'):
                raise AttributeError(
                    "%s instance has no 'request' attribute. Did you override "
                    "setup() and forget to call super()?" % cls.__name__
                )
            return self.dispatch(request, *args, **kwargs)
        view.view_class = cls
        view.view_initkwargs = initkwargs

        # take name and docstring from class
        update_wrapper(view, cls, updated=())

        # and possible attributes set by decorators
        # like csrf_exempt from dispatch
        update_wrapper(view, cls.dispatch, assigned=())
        return view     # 这就是上面说的闭包

可以看到as_view的定义中又定义了一个view函数,该函数接收三个参数,第一个是request对象,第二个是url解析器捕获的url中的位置参数,第三个是url解析器捕获的url中的关键字参数。返回的view函数就是上面所说的闭包。

先不看view函数内部的执行逻辑,而只关注django接收到请求后的处理逻辑。当django项目启动,调用path或re_path返回URLPattern实例对象,同时as_view函数得到执行,并返回view函数的引用,传递给URLPattern实例对象的callback属性,此时as_view方法的使命完成,之后每次当django接受到浏览器发来的请求,url解析器解析url后,将request对象和url中捕获的参数传递给匹配到的回调函数(即view函数),由view函数执行后续操作。

3、再看view函数内部执行逻辑

        def view(request, *args, **kwargs):
            self = cls(**initkwargs)  # 实例化一个类视图对象,cls指的是我们自定义的类视图,比如开头例子中的IndexView,所以self指的就是IndexView的一个实例
            if hasattr(self, 'get') and not hasattr(self, 'head'):
                self.head = self.get
            self.setup(request, *args, **kwargs)  # 初始化实例属性
            if not hasattr(self, 'request'):
                raise AttributeError(
                    "%s instance has no 'request' attribute. Did you override "
                    "setup() and forget to call super()?" % cls.__name__
                )
            return self.dispatch(request, *args, **kwargs)

view函数主要做了两件事情,一是实例化一个类视图对象,这个容易理解,是哪个类视图对象接收了请求那就实例化哪个。二是调用dispatch方法,根据http请求方法(比如get,post)分派处理函数,dispatch方法逻辑比较简单,但是却是理解类视图执行逻辑的关键点。先看下源码:

    def dispatch(self, request, *args, **kwargs):
        # Try to dispatch to the right method; if a method doesn't exist,
        # defer to the error handler. Also defer to the error handler if the
        # request method isn't on the approved list.
        if request.method.lower() in self.http_method_names:  # 把http方法改为小写,并判断该方法是否是合法的http方法
            handler = getattr(self, request.method.lower(), self.http_method_not_allowed)  # 在类视图中找到对应的处理方法,返回该方法的引用给handler
        else:
            handler = self.http_method_not_allowed
        return handler(request, *args, **kwargs)  # 执行相应的方法

很简单了,先把http方法改为小写,然后判断该方法是否在http_method_names列表中(该列表保存了所有合法的http方法的小写名称),如果判断请求方法是合法的,就从我们自定义的类视图对象中获取到该方法,将引用传给handler,然后返回该方法执行的结果。举例:浏览器发送来一个get请求,get存在于http_method_names列表中,所以是个合法的http方法,此时通过getattr获取到自定义类视图中的get方法,并将get方法的引用传给handler(所以我们需要在自定义类视图中定义get方法,否则dispatch找不到get方法,比如开头的例子中,我们需要在IndexView类中定义get方法),最后执行get方法,并返回执行结果。

原文地址:https://www.cnblogs.com/olivertian/p/11072528.html

评论列表

暂无评论,欢迎来抢沙发!

新的评论

清空