Django generic.Views 源码初步剖析

Django generic.Views 源码初步剖析

django 采用了类形式的view，方便继承，此外，内建了listView，detailView，updateView，createView等常用的view类，方便开发者进行视图的展示。而generic.views是所有view所继承的基本类，主要包括下面几个方法。

• _init_
• as_view
• dispatch
• http_method_not_allowed
• options
• _allowed_methods
• http_method_names

---

http_method_names

首先view类定义了可接受的http方法名称，包括[‘get’, ‘post’, ‘put’, ‘patch’, ‘delete’, ‘head’, ‘options’, ‘trace’]

继承view后，自定义的函数若与这几个http方法重名则意味着执行该方法，具体实现通过dispatch来进行分发。

若有方法未定义，则表示该view不接受这类http请求，返回405，method not allow。这是通过http_method_not_allowed方法返回相应报文。

options

options实际意义是获取该请求所支持的http方法，所以通过options返回相对应的报文，通过_allowed_methods来进行查询这个view所支持的方法。

as_view

as_view是一个classmethod，用于urls中，对url进行mapping，在as_view中，会对每一个请求构建实例，通过dispatch方法对相应的方法进行转发，进入对应方法的函数中。若head方法未实现，则等于get方法。

dispatch

dispatch函数中，通过request.method，来对应class的方法，看是否有对应的方法，进行执行，否则，返回method_not_allowed。

源码

class View(object):
    """
    Intentionally simple parent class for all views. Only implements
    dispatch-by-method and simple sanity checking.
    """

    http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']

    def __init__(self, **kwargs):
        """
        Constructor. Called in the URLconf; can contain helpful extra
        keyword arguments, and other things.
        """
        # Go through keyword arguments, and either save their values to our
        # instance, or raise an error.
        for key, value in six.iteritems(kwargs):
            setattr(self, key, value)

    @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.request = request
            self.args = args
            self.kwargs = kwargs
            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

    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:
            handler = getattr(self, request.method.lower(), self.http_method_not_allowed)
        else:
            handler = self.http_method_not_allowed
        return handler(request, *args, **kwargs)

    def http_method_not_allowed(self, request, *args, **kwargs):
        logger.warning('Method Not Allowed (%s): %s', request.method, request.path,
            extra={
                'status_code': 405,
                'request': request
            }
        )
        return http.HttpResponseNotAllowed(self._allowed_methods())

    def options(self, request, *args, **kwargs):
        """
        Handles responding to requests for the OPTIONS HTTP verb.
        """
        response = http.HttpResponse()
        response['Allow'] = ', '.join(self._allowed_methods())
        response['Content-Length'] = '0'
        return response

    def _allowed_methods(self):
        return [m.upper() for m in self.http_method_names if hasattr(self, m)]