Django中的CBV与FBV

Posted 2020-12-22 zh-xiaoyuan

一、FBV

FBV（function base views） 就是在视图里使用函数处理请求。

在之前django的学习中，我们一直使用的是这种方式，所以不再赘述。

二、CBV

CBV（class base views） 就是在视图里使用类处理请求。

Python是一个面向对象的编程语言，如果只用函数来开发，有很多面向对象的优点就错失了（继承、封装、多态）。所以Django在后来加入了Class-Based-View。可以让我们用类写View。这样做的优点主要下面两种：

1. 提高了代码的复用性，可以使用面向对象的技术，比如Mixin（多继承）
2. 可以用不同的函数针对不同的HTTP方法处理，而不是通过很多if判断，提高代码可读性

1、使用class-based views

如果我们要写一个处理GET方法的view，用函数写的话是下面这样。

from django.http import HttpResponse
  
def my_view(request):
     if request.method == ‘GET‘:
            return HttpResponse(‘OK‘)

如果用class-based view写的话，就是下面这样

from django.http import HttpResponse
from django.views import View
  
class MyView(View):

      def get(self, request):
            return HttpResponse(‘OK‘)

Django的url是将一个请求分配给可调用的函数的，而不是一个class。针对这个问题，class-based view提供了一个as_view()静态方法（也就是类方法），调用这个方法，会创建一个类的实例，然后通过实例调用dispatch()方法，dispatch()方法会根据request的method的不同调用相应的方法来处理request（如get()，post()等）。到这里，这些方法和function-based view差不多了，要接收request，得到一个response返回。如果方法没有定义，会抛出HttpResponseNotAllowed异常。

在url中，就这么写：

# urls.py
from django.conf.urls import url
from myapp.views import MyView
  
urlpatterns = [
     url(r‘^index/$‘, MyView.as_view()),
]

类的属性可以通过两种方法设置，第一种是常见的Python的方法，可以被子类覆盖。

from django.http import HttpResponse
from django.views import View
  
class GreetingView(View):
    name = "hui"
    def get(self, request):
         return HttpResponse(self.name)
  
# You can override that in a subclass
  
class MorningGreetingView(GreetingView):
    name= "alex"

第二种方法，你也可以在url中指定类的属性：

在url中设置类的属性Python

urlpatterns = [
   url(r‘^index/$‘, GreetingView.as_view(name="egon")),
]

2、使用Mixin

我觉得要理解django的class-based-view（以下简称cbv），首先要明白django引入cbv的目的是什么。在django1.3之前，generic view也就是所谓的通用视图，使用的是function-based-view（fbv），亦即基于函数的视图。有人认为fbv比cbv更pythonic，窃以为不然。python的一大重要的特性就是面向对象。而cbv更能体现python的面向对象。cbv是通过class的方式来实现视图方法的。class相对于function，更能利用多态的特定，因此更容易从宏观层面上将项目内的比较通用的功能抽象出来。关于多态，不多解释，有兴趣的同学自己Google。总之可以理解为一个东西具有多种形态（的特性）。cbv的实现原理通过看django的源码就很容易明白，大体就是由url路由到这个cbv之后，通过cbv内部的dispatch方法进行分发，将get请求分发给cbv.get方法处理，将post请求分发给cbv.post方法处理，其他方法类似。怎么利用多态呢？cbv里引入了mixin的概念。Mixin就是写好了的一些基础类，然后通过不同的Mixin组合成为最终想要的类。

所以，理解cbv的基础是，理解Mixin。Django中使用Mixin来重用代码，一个View Class可以继承多个Mixin，但是只能继承一个View（包括View的子类），推荐把View写在最右边，多个Mixin写在左边。

3、CBV之View源码

view.py

class LoginView(View):
    def get(self,request):

        return render(request,"login.html")

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

urls.py

    url(r‘^index/‘, views.index),  #FBV
    #index后面没有括号，index匹配成功后会调用index方法，才会给它加括号传request执行

    url(r‘^login/‘, views.LoginView.as_view()),  #CBV
    #as_view后面有括号，但views.LoginView.as_view()整体是一个函数名，login一旦匹配成功给函数加括号传request执行

as_view()是LoginView下面的一个方法，LoginView自己类下没有as_view这个方法，找其父类View

源码分析：

class View(object):  （1）
    """
    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):  (2)
        """
        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):  #view方法后有括号，用户访问login会执行此方法     (4)
            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)  #self.dispatch是一个实例方法，后面有括号，可以看出用户 一旦访问login真正执行的是dispatch方法
　　　　　　　#这里我们要搞清楚self是什么，我们一层层找 self->def view()->return view->def as_view()->LoginView，但LoginView类下面没有dispatch方法，我们再回
　　　　　　　#到当前View类进行查找发现在下面定义有dispatch方法    (5)
        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  #django一启动执行as_view()方法，返回函数名view     (3)

　　　　　
　　def dispatch(self, request, *args, **kwargs):  (6)
   　　 # 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)    #可以看出最后执行的是找到的  请求方法  对应的实例方法      (7)

a、可以看到as_view()函数返回的是一个函数名view,

b、有用户访问login就会给view加上函数执行，返回实例方法dispatch()

c、执行dispatch()方法，返回的是找到的用户请求方法对应的实例方法，也就是我们定义的get、post等方法，找不到就抛出一个异常。

有了上面的理解之后我们看下面的代码：

from django.shortcuts import render,HttpResponse

from django.views import View

def index(request):
    pass

class LoginView(View):

    #重定义dispatch方法，此方法会覆盖父类的dispatch方法，
    #为了希望能同时实现父类的功能下面用super调用父类dispatch方法
    def dispatch(self, request, *args, **kwargs):
        print("dispatch...")
        # 调用父类dispatch两种方法
        #方法1
        # ret=super(LoginView, self).dispatch(request, *args, **kwargs)
        #执行父类dispatch方法，也就是执行下面定义的get方法，然后用ret接收返回的响应
        #方法2
        ret=super().dispatch(request, *args, **kwargs)
        print("123")
        return ret

    def get(self,request):
        print("get...")

        return render(request,"login.html")

    def post(self,request):
        print("post...")

        return HttpResponse("post...")

"""
打印结果：
        dispatch...
        get...
        123
        [24/May/2020 12:26:18] "GET /login/ HTTP/1.1" 200 393
        [24/May/2020 12:26:20] "POST /login/ HTTP/1.1" 200 7
        dispatch...
        post...
        123

"""