本文是对 Django 官网文档的翻译。
官网链接:https://docs.djangoproject.com/en/1.11/topics/class-based-views/intro/
适用版本:Django1.11
类视图提供了一种使用 Python 对象实现视图的方法。类视图不会替代函数视图, 与函数视图相比,它们有一定的差异和优势:
采用单独的函数来处理特定 HTTP 请求(GET,POST等)代替函数视图的条件分支。
可以使用面向对象的技术,如 mixins(多重继承)将代码重新定义为可重用的组件。
通用视图、类视图和通用类视图之间的关系和历史
最初,只有视图函数,Django 将 HttpRequest 传递给函数并且期望返回一个 HttpResponse 。 这是 Django 的工作范围。
早期的开发发现了视图中共同的习语和模式,因此引入了函数通用视图来抽象这些模式,从而简化常见视图开发。
函数通用视图虽然可以很好地处理简单情况,但是超出一些简单配置选项后就没有办法对它们进行扩展或定制了,这限制了它们在许多现实应用程序中的使用。
创建类通用视图与创建函数通用视图的目的相同(使视图开发更容易)。然而,使用 mixins 来实现的解决方案比采用函数通用视图更具扩展性和灵活性。
如果您以前曾尝试过函数通用视图,并发现了它们的缺点,那么不应该将类通用视图简单地看做函数通用视图的类方式等效,而应该看做是解决通用视图问题的新方法。
Django 构建类通用视图的基类和 mixins 工具包非常灵活,它为简单应用可能涉及到的默认方法和属性提供了很多钩子。例如,不仅可以通过为 form_class 赋值设置类属性,还可以使用 get_form 方法设置类属性,默认情况下,该方法调用只返回类的 form_class 属性的 get_form_class 方法。这为设置表单提供了从简单属性到完全动态调用挂接等多种选项。这些选项看起来像增加了简单情况的复杂性,但如果没有这些选项,更高级的设计将受到限制。
使用类视图
类视图的核心思想在于使用不同的类实例方法响应不同的 HTTP 请求方法,而不是在单个视图函数中使用条件分支代码。
视图函数处理 HTTP GET 的代码是这样的:
from django.http import HttpResponse
def my_view(request):
if request.method == 'GET':
# <view logic>
return HttpResponse('result')
在类视图中,它将变为:
from django.http import HttpResponse
from django.views import View
class MyView(View):
def get(self, request):
# <view logic>
return HttpResponse('result')
由于 Django 的 URL 解析器希望将请求和关联的参数发送到可调用函数(而不是类),类视图定义了一个 as_view() 方法,该方法为匹配关联 URL 模式的请求提供一个可调用函数。as_views() 函数创建一个类实例并调用该类实例的 dispatch() 方法。 dispatch 对请求进行分析,确定请求类型(GET,POST等)并将请求匹配到对应方法(如果已定义对应方法),或引发 HttpResponseNotAllowed 异常(如果没定义对应方法):
# urls.py
from django.conf.urls import url
from myapp.views import MyView
urlpatterns = [
url(r'^about/$', MyView.as_view()),
]
值得注意的是,类方法返回的内容与函数视图返回的内容相同,都是某种形式的 HttpResponse 。 这意味着 http快捷函数 或 TemplateResponse 对象在类视图中是有效的。
虽然最小的类视图不需要设置任何类属性就可以实现工作,类属性在许多类设计中非常有用,我们可以通过两种方式配置或设置类属性:
第一种方法是标准的 Python 方法--在子类中覆盖属性和方法。 如果父类有一个 greeting 属性:
from django.http import HttpResponse
from django.views import View
class GreetingView(View):
greeting = "Good Day"
def get(self, request):
return HttpResponse(self.greeting)
可以在子类中这样重写:
class MorningGreetingView(GreetingView):
greeting = "Morning to ya"
另一种方法是在 URLconf 中的 as_views() 中以关键词参数的形式进行配置。
urlpatterns = [
url(r'^about/$', GreetingView.as_view(greeting="G'day")),
]
注意:为请求实例化视图类时,通过 as_view() 入口设置的类属性只在定义 URL 时配置一次。
使用mixins
Mixins是一种多继承的形式,在多继承中多个父类的行为和属性可以互相结合。
例如,通用类视图中有一个名为 TemplateResponseMixin 的 mixin ,它的主要作用是定义render_to_response()方法。当与 View 类的行进行结合时,结果是 TemplateView 类。TemplateView 类将请求分配给合适的匹配方法( View 类定义的行为),并通过输入 template_name 属性的 render_to_reponse() 方法返回一个TemplateResponse 对象( TemplateResponseMixin 定义的一个行为)。
Mixins 是在多个类中重用代码的绝佳方法,但是使用它们也需要一些代价。 代码分散到 mixins 中越多,阅读一个子类并知道它能做什么就越困难,当创建具有深继承树的类的子类时,也越难知道要重写哪个 mixin 的哪个方法。
还要注意,只能继承一个通用视图,也就是说,只有一个父类可以继承 View ,而其余的(如果有的话)应该继承 mixins 。 尝试继承多个继承 View 的类将无法正常工作,例如,尝试组合 ProcessFormView 和 ListView 实现在列表顶部使用表单不会得到预期的结果。
使用类视图处理表单
处理表单的函数视图看起来是这样的:
from django.http import HttpResponseRedirect
from django.shortcuts import render
from .forms import MyForm
def myview(request):
if request.method == "POST":
form = MyForm(request.POST)
if form.is_valid():
# <process form cleaned data>
return HttpResponseRedirect('/success/')
else:
form = MyForm(initial={'key': 'value'})
return render(request, 'form_template.html', {'form': form})
对应的类视图是这样的:
from django.http import HttpResponseRedirect
from django.shortcuts import render
from django.views import View
from .forms import MyForm
class MyFormView(View):
form_class = MyForm
initial = {'key': 'value'}
template_name = 'form_template.html'
def get(self, request, *args, **kwargs):
form = self.form_class(initial=self.initial)
return render(request, self.template_name, {'form': form})
def post(self, request, *args, **kwargs):
form = self.form_class(request.POST)
if form.is_valid():
# <process form cleaned data>
return HttpResponseRedirect('/success/')
return render(request, self.template_name, {'form': form})
这是一个非常简单的例子,但是仍然可以看到,我们可以通过重写类属性(比如form_class)来自定义视图,重写类属性的方法包括 URLconf 配置、创建子类并重写一个或多个方法(或者两者都有)。
装饰类视图
不仅可以通过 mixins 扩展类视图,还可以使用装饰器。由于类视图不是函数,对 as_view() 进行装饰与对创建的子类进行装饰的工作方式不同。
在URLconf中进行装饰
装饰类视图最简单的方法是装饰 as_view() 方法的结果,最简单的实现方法是在部署视图的 URLconf 中。
from django.contrib.auth.decorators import login_required, permission_required
from django.views.generic import TemplateView
from .views import VoteView
urlpatterns = [
url(r'^about/$', login_required(TemplateView.as_view(template_name="secret.html"))),
url(r'^vote/$', permission_required('polls.can_vote')(VoteView.as_view())),
]
这种方法对使用的实例进行装饰。 如果希望每个视图的实例都被装饰,需要采取不同的方法。
装饰类
如果需要装饰类视图的每个实例,则需要对类进行装饰。可用通过装饰类的 dispatch() 方法来实现对类进行装饰。类方法与单独函数不尽相同,因此不能只对类方法应用一个函数装饰器,而需要先将其转换为一个方法装饰器。method_decorator 装饰器可以将一个函数装饰器转换为一个方法装饰器,以使函数装饰器可以用于实例方法中,例如:
from django.contrib.auth.decorators import login_required
from django.utils.decorators import method_decorator
from django.views.generic import TemplateView
class ProtectedView(TemplateView):
template_name = 'secret.html'
@method_decorator(login_required)
def dispatch(self, *args, **kwargs):
return super(ProtectedView, self).dispatch(*args, **kwargs)
或者,可以更简洁地通过装饰类并将要装饰的方法的名称作为关键字参数进行传递:
@method_decorator(login_required, name='dispatch')
class ProtectedView(TemplateView):
template_name = 'secret.html'
如果有一个在几个位置使用的通用装饰器集合,则可以定义一个装饰器列表或元组来进行装饰,而不用多次执行method_decorator() 。下面例子中的两个类是等效的:
decorators = [never_cache, login_required]
@method_decorator(decorators, name='dispatch')
class ProtectedView(TemplateView):
template_name = 'secret.html'
@method_decorator(never_cache, name='dispatch')
@method_decorator(login_required, name='dispatch')
class ProtectedView(TemplateView):
template_name = 'secret.html'
装饰器将按照传入到装饰器的顺序对请求进行处理,上例中,never_cache() 将比 login_required() 先处理请求。
在这个例子中,每个 ProtectedView 的实例都将具有登录保护。
注意:method_decorator 将
*args
和**kwargs
作为参数传输给类的装饰方法。如果方法不接收兼容参数则可能会引发 TypeError 异常。