第九章: 通用视图

完成常用的简单任务：重定向到另一个页面以及渲染一个指定的模板。

显示列表和某个特定对象的详细内容页面。第 8 章中提到的 event_list 和

entry_list 视图就是列表视图的一个例子。一个单一的 event 页面就是我们所说的详细内容页面。

呈现基于日期的数据的年/月/日归档页面，关联的详情页面，最新页面。Django Weblogs (http://www.djangoproject.com/weblog/)的年、月、日的归档就是使用通用视图 架构的，就像是典型的新闻报纸归档。

允许用户在授权或者未经授权的情况下创建、修改和删除对象。 综上所述，这些视图为开发者日常开发中常见的任务提供了易用的接口。

使用通用视图

使用通用视图的方法是在 URLconf 文件中创建配置字典，然后把这些字典作为 URLconf 元组的第三个成员。

例如，下面是一个呈现静态“关于”页面的 URLconf： from django.conf.urls.defaults import *

from django.views.generic.simple import direct_to_template

urlpatterns = patterns('', ('^about/$', direct_to_template, {

'template': 'about.html'

})

)

一眼看上去似乎有点不可思议，不需要编写代码的视图！它和第八章中的例子完全一样：

direct_to_template 视图从参数中获取渲染视图所需的相关信息。

因为通用视图都是标准的视图函数，我们可以在我们自己的视图中重用它。例如，我们扩展

about 例子把映射的 URL 从 /about/<whatever>/ 到一个静态渲染 about/<whatever>.html 。我们首先修改 URL 配置到新的视图函数：

from django.conf.urls.defaults import *

from django.views.generic.simple import direct_to_template

**from mysite.books.views import about_pages**

urlpatterns = patterns('', ('^about/$', direct_to_template, {

'template': 'about.html'

}),

**('^about/(w+)/$', about_pages),**

)

接下来，我们编写 about_pages 视图的代码：

from django.http import Http404

from django.template import TemplateDoesNotExist

from django.views.generic.simple import direct_to_template

def about_pages(request, page): try:

return direct_to_template(request, template="about/%s.html" % page) except TemplateDoesNotExist:

raise Http404()

在这里我们象使用其他函数一样使用 direct_to_template 。因为它返回一个 HttpResponse对象，我们只需要简单的返回它就好了。有一个稍微复杂的地方，要处理没有找到模板的情况。 我们不希望一个不存在的模板引发服务器错误，所以我们捕捉 TempalteDoesNotExist异常 并返回 404 错误。

这里有没有安全性问题？

眼尖的读者可能已经注意到一个可能的安全漏洞：我们直接使用从客户端浏览器来的数据构造 模板名称(template="about/%s.html" % page )。乍看起来，这像是一个经典的 目录遍历（directory traversal） 攻击（详情请看第十九章）。事实真是这样吗？

完全不是。是的，一个恶意的 page 值可以导致目录跨越，但是尽管 page 是 从 请求的 URL中获取的，并不是所有的值都被接受。这就是 URL 配置的关键所在：我们使用正则表达式 \w+

来从 URL 里匹配 page ，而 \w 只接受字符和数字。因此，任何恶意的字符 （例如在这里是点 . 和正斜线 / ）将在 URL 解析时被拒绝，根本不会传递给视图函数。

对象的通用视图

direct_to_template 毫无疑问是非常有用的，但 Django 通用视图最有用的是在呈现 数据库中的数据。因为这个应用实在太普遍了，Django 带有很多内建的通用视图来帮助你很容易 的生成对象的列表和明细视图。

让我们先看看其中的一个通用视图：对象列表视图。我们使用第五章中的 Publisher 来举例： class Publisher(models.Model):

name = models.CharField(maxlength=30)

address = models.CharField(maxlength=50) city = models.CharField(maxlength=60)

state_province = models.CharField(maxlength=30) country = models.CharField(maxlength=50) website = models.URLField()

def

__str__(self): return self.name

class Meta:

ordering = ["-name"]

class Admin: pass

要为所有的书籍创建一个列表页面，我们使用下面的 URL 配置： from django.conf.urls.defaults import *

from django.views.generic import list_detail

from mysite.books.models import Publisher

publisher_info = {

"queryset" : Publisher.objects.all(),

}

urlpatterns = patterns('',

(r'^publishers/$', list_detail.object_list, publisher_info)

)

这就是所要编写的所有 Python 代码。当然，我们还需要编写一个模板。我们可以通过在额外参数 字典里包含 template_name 来清楚的告诉 object_list 视图使用哪个模板，但是 由

于 Django 在不给定模板的时候会用对象的名称推导出一个。在这个例子中，这个推导出的模板名称 将是 "books/publisher_list.html" ，其中 books 部分是定义这个模型的 app 的名称， publisher 部分是这个模型名称的小写。

这个模板将按照 context 中包含的变量 object_list 来渲染，这个变量包含所有的书籍对象。 一个非常简单的模板看起来象下面这样：

{% extends "base.html" %}

{% block content %}

<h2>Publishers</h2>

<ul>

{% for publisher in object_list %}

<li>{{ publisher.name }}</li>

{% endfor %}

</ul>

{% endblock %}

这就是所有要做的事。要使用通用视图酷酷的特性只需要修改参数字典并传递给通用视图函数。 附录 D 是通用视图的完全参考资料；本章接下来的章节将讲到自定义和扩展通用视图的一些方法。

扩展通用视图

毫无疑问，使用通用视图可以充分加快开发速度。然而，在多数的工程中，也会出现通用视图不能 满足需求的情况。实际上，刚接触 Django 的开发者最常见的问题就是怎样使用通用视图来处理更多的情况。

幸运的是，几乎每种情况都有相应的方法来简单的扩展通用视图来处理它。这时总是使用下面的 这些方法。

制作友好的模板 Context

你也许已经注意到范例中的出版商列表模板在变量 object_list 里保存所有的书籍。这个方法工作的很好，只是对编写模板的人不太友好：他们不得不去了解他们现在处理的数据是什么， 比方说在这里是书籍。用象 publisher_list 这样的变量名会更好一点，这样变量的值 看起来就很清楚了。

我们可以很容易的像下面这样修改 template_object_name 参数的名称： publisher_info = {

"queryset" : Publisher.objects.all(),

**"template_object_name" : "publisher",**

}

urlpatterns = patterns('',

(r'^publishers/$', list_detail.object_list, publisher_info)

)

使用有用的 template_object_name 总是个好想法。你的设计模板的合作伙伴会感谢你的。

添加额外的 Context

你常常需要呈现比通用视图提供的更多的额外信息。例如，考虑一下在每个出版商页面实现所有其他 出版商列表。 object_detail 通用视图提供了出版商到 context，但是看起来没有办法在模板中 获取 所有 出版商列表。

这是解决方法：所有的通用视图都有一个额外的可选参数 extra_context 。这个参数是一个字典数据类型，包含要添加到模板的 context 中的额外的对象。所以要提供所有的出版商明细给视图，我们就用这样的 info 字典：

publisher_info = {

"queryset" : Publisher.objects.all(), "template_object_name" : "publisher",

**"extra_context" : {"book_list" : Book.objects.all()}**

}

这样就把一个 {{ book_list }} 变量放到模板的 context 中。这个方法可以用来传递任意数据 到通用视图模板中去，非常方便。

不过，这里有一个很隐蔽的 BUG，不知道你发现了没有？

我们现在来看一下， extra_context 里包含数据库查询的问题。因为在这个例子中，我们把

Publisher.objects.all() 放在 URLconf 中，它只会执行一次（当 URLconf 第一次加载的时 候）。当你添加或删除出版商，你会发现在重启 Web 服务器之前，通用视图不会反映出这些 修改的（有关QuerySet 何时被缓存和赋值的更多信息请参考附录C 中“缓存与查询集”一节）。

备注

这个问题不适用于通用视图的 queryset 参数。因为 Django 知道有些特别的 QuerySet 永远不能 被缓存，通用视图在渲染前都做了缓存清除工作。

解决这个问题的办法是在 extra_context 中用一个回调（callback）来 代替使用一个变量。任何可以调用的对象（例如一个函数）在传递给 extra_context 后都会在每次视图渲染前执行（而不是只执行一次）。 你可以象这样定义一个函数：

def get_books():

return Book.objects.all()

publisher_info = {

"queryset" : Publisher.objects.all(), "template_object_name" : "publisher", "extra_context" : **{"book_list" : get_books}**

}

或者你可以使用另一个不是那么清晰但是很简短的方法，事实上 Publisher.objects.all 本身就是可以调用的：

publisher_info = {

"queryset" : Publisher.objects.all(), "template_object_name" : "publisher",

"extra_context" : **{"book_list" : Book.objects.all}**

}

注意 Book.objects.all 后面没有括号；这表示这是一个函数的引用，并没有 真调用它（通用视图将会在渲染时调用它）。

显示对象的子集

现在让我们来仔细看看这个 queryset 。大多数通用视图有一个 queryset 参数，这个参数告诉视图要显示对象的集合 （有关 QuerySet 的解释请看第五章的 “选择对象”章节，详细资料请参看附录 C）。

举一个简单的例子，我们打算对书籍列表按出版日期排序，最近的排在最前： book_info = {

"queryset" : Book.objects.all().order_by("-publication_date"),

}

urlpatterns = patterns('',

(r'^publishers/$', list_detail.object_list, publisher_info),

**(r'^books/$', list_detail.object_list, book_info),**

)

这是一个相当简单的例子，但是很说明问题。当然，你通常还想做比重新排序更多的事。 如果你想要呈现某个特定出版商出版的所有书籍列表，你可以使用同样的技术：

**apress_books = {**

**"queryset": Book.objects.filter(publisher__name="Apress Publishing"),**

**"template_name" : "books/apress_list.html"**

**}**

urlpatterns = patterns('',

(r'^publishers/$', list_detail.object_list, publisher_info),

**(r'^books/apress/$', list_detail.object_list, apress_books),**

)

注意 在使用一个过滤的 queryset 的同时，我们还使用一个自定义的模板名称。 如果我们不这么做，通用视图就会用以前的模板，这可能不是我们想要的结果。

同样要注意的是这并不是一个处理出版商相关书籍的最好方法。如果我们想要添加另一个 出版商页面，我们就得在 URL 配置中写 URL 配置，如果有很多的出版商，这个方法就不能 接受了。在接下来的章节我们将来解决这个问题。

备注

如果你在请求 /books/apress/ 时出现 404 错误，请检查以确保你的数据库中出版商 中有名为 Apress Publishing 的记录。通用视图有一个 allow_empty 参数可以 用来处理这个情况，详情请看附录 D。

用函数包装来处理复杂的数据过滤

另一个常见的需求是按 URL 里的关键字来过滤数据对象。在前面我们用在 URL 配置中 硬编码出版商名称的方法来做这个，但是我们想要用一个视图就能显示某个出版商 的所有书籍该怎么办呢？我们可以通过对 object_list 通用视图进行包装来避免 写一大堆的手工代码。按惯例，我们先从写 URL 配置开始：

urlpatterns = patterns('',

(r'^publishers/$', list_detail.object_list, publisher_info),

**(r'^books/(w+)/$', books_by_publisher),**

)

接下来，我们写 books_by_publisher 这个视图：（上面的代码中正则表达式有误，在 w 前要加反斜線）

from django.http import Http404

from django.views.generic import list_detail from mysite.books.models import Book, Publisher

def books_by_publisher(request, name):

# Look up the publisher (and raise a 404 if it can't be found). try:

publisher = Publisher.objects.get(name__iexact=name) except Publisher.DoesNotExist:

raise Http404

# Use the object_list view for the heavy lifting. return list_detail.object_list(

request,

queryset = Book.objects.filter(publisher=publisher), template_name = "books/books_by_publisher.html", template_object_name = "books",

extra_context = {"publisher" : publisher}

)

这是因为通用视图就是 Python 函数。和其他的视图函数一样，通用视图也是接受一些 参数并返回 HttpResponse 对象。因此，通过包装通用视图函数可以做更多的事。

注意

注意到在前面这个例子中我们在 extra_context 传递了当前出版商这个参数。 这在包装时通常是一个好注意；它让模板知道当前显示内容的上一层对象。

处理额外工作

我们再来看看最后一个常用模式：在调用通用视图前后做些额外工作。

想象一下我们在 Author 对象里有一个 last_accessed 字段，我们用这个字段来更正对

author 的最近访问时间。当然通用视图 object_detail 并不能处理 这个问题，我们可以很容易的写一个自定义的视图来更新这个字段。

首先，我们需要在 URL 配置里设置指向到新的自定义视图： from mysite.books.views import author_detail

urlpatterns = patterns('',

#...

**(r'^authors/(?P<author_id>d+)/$', author_detail),**

)

接下来写包装函数： import datetime

from mysite.books.models import Author

from django.views.generic import list_detail from django.shortcuts import get_object_or_404

def author_detail(request, author_id):

# Look up the Author (and raise a 404 if she's not found) author = get_object_or_404(Author, pk=author_id)

# Record the last accessed date author.last_accessed = datetime.datetime.now() author.save()

# Show the detail page

return list_detail.object_detail( request,

queryset = Author.objects.all(), object_id = author_id,

)

注意

除非你添加 last_accessed 字段到你的 Author 模型并创建 books/author_detail.html模板，否则这段代码不能真正工作。

我们可以用同样的方法修改通用视图的返回值。如果我们想要提供一个供下载用的 纯文本版本的 author 列表，我们可以用下面这个视图：

def author_list_plaintext(request): response = list_detail.object_list(

request,

queryset = Author.objects.all(), mimetype = "text/plain",

template_name = "books/author_list.txt"

)

response["Content-Disposition"] = "attachment; filename=authors.txt" return response

这个方法之所以工作是因为通用视图返回的 HttpResponse 对象可以象一个字典 一样的设置 HTTP 的头部。随便说一下，这个 Content-Disposition 的含义是 告诉浏览器下载并保存这个页面，而不是在浏览器中显示它。

接下来？

在这一章我们只讲了 Django 带的通用视图其中一部分，不过这些方法也适用于其他的 通用视图。有关更详细的内容，请看附录 D。

在下一章中我们将深入到 Django 模板系统的内部去，展示所有扩展它的酷方法。目前 为之，我们还只是把模板引擎当作一个渲染内容的静态工具。