Explication de la vue universelle de Django

Au pire,
Le développement Web est ennuyeux et monotone. Jusqu'à présent, nous avons présenté comment Django réduit la monotonie du développement au niveau du modèle et du modèle, mais le développement Web rencontre également cette tâche fastidieuse au niveau de la vue.

Les vues génériques de Django peuvent réduire ces douleurs. Il résume certains codes et modèles couramment utilisés dans le développement de vues, de sorte que les vues de données couramment utilisées puissent être écrites rapidement sans écrire beaucoup de code. En fait, presque tous les exemples de vues des chapitres précédents peuvent être réécrits à l’aide de vues génériques.

Dans le chapitre 8, nous présentons brièvement comment rendre la vue plus « universelle ». En regardant en arrière, nous retrouverons certaines des tâches les plus courantes, telles que l'affichage d'une série d'objets et l'écriture d'un morceau de code pour afficher le contenu de n'importe quel objet. La solution consiste à passer un paramètre supplémentaire à URLConf.

Les vues universelles intégrées de Django peuvent implémenter les fonctions suivantes :

§ Effectuer des tâches simples courantes : rediriger vers Une autre page et restitue un modèle spécifié.

§ Afficher la liste et la page de détails d'un objet spécifique. Les vues event_list et Entry_list mentionnées dans le chapitre 8 sont un exemple de vue de liste. Une seule
page d'événement est ce que nous appelons une page de contenu détaillé.

§ Présenter la page d'archive des données basées sur la date année/mois/jour, la page de détails associée, la dernière page. Les archives annuelles, mensuelles et quotidiennes de Django
Weblogs (http://www.djangoproject.com/weblog/) utilisent une architecture de vue universelle, tout comme les archives d'un journal d'actualité typique.

§ Permet aux utilisateurs de créer, modifier et supprimer des objets avec ou sans autorisation.

Pour résumer, ces vues fournissent des interfaces faciles à utiliser pour les tâches courantes du développement quotidien des développeurs.

Utiliser des vues génériques

La façon d'utiliser des vues génériques consiste à créer des dictionnaires de configuration dans le fichier URLconf, puis à utiliser ces dictionnaires comme troisième membre du tuple URLconf .

Par exemple, voici une URLconf qui affiche une page À propos statique :

from django.conf.urls.defaults import *
from django.views.generic.simple import direct_to_template
urlpatterns = patterns('',
('^about/$', direct_to_template, {
'template': 'about.html'
})
)

Cela peut paraître un peu bizarre à première vue, mais cela ne nécessite aucune vue de codage ! C'est exactement la même chose que l'exemple du chapitre 8 : la vue direct_to_template obtient les informations pertinentes nécessaires au rendu de la vue à partir des paramètres.

Les vues génériques étant des fonctions de vue standard, nous pouvons les réutiliser dans nos propres vues. Par exemple, nous étendons l'exemple about pour mapper l'URL de /about// vers un about/.html rendu statiquement. Nous modifions d'abord la configuration de l'URL vers la nouvelle fonction d'affichage :

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),**
)

Ensuite, nous écrivons le code de la vue 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()

Ici, nous utilisons direct_to_template comme les autres fonctions. Puisqu'il renvoie un objet HttpResponse, nous le renvoyons simplement. Il existe une légère complication liée au cas où le modèle n'est pas trouvé. Nous ne voulons pas qu'un modèle inexistant provoque une erreur de serveur, nous interceptons donc l'exception TempalteDoesNotExist et renvoyons une erreur 404.

Y a-t-il des problèmes de sécurité ici ?

Les lecteurs aux yeux d'aigle ont peut-être remarqué une possible vulnérabilité de sécurité : nous utilisons directement les données du navigateur client pour construire le nom du modèle (template="about/%s . html"%page). À première vue, cela ressemble à une attaque classique par traversée de répertoire (voir le chapitre 19 pour plus de détails). Est-ce vraiment le cas ?

Pas du tout. Oui, une valeur de page malveillante peut provoquer une extension du répertoire, mais même si la page est récupérée à partir de l'URL demandée, toutes les valeurs ne sont pas acceptées. C'est la clé de la configuration des URL : nous utilisons l'expression régulière /w pour faire correspondre les pages des URL, et /w n'accepte que les caractères et les chiffres. Par conséquent, tous les caractères malveillants (tels que le point . et la barre oblique / dans ce cas) seront rejetés lors de l'analyse de l'URL et ne seront pas du tout transmis à la fonction d'affichage.

Les vues génériques des objets

direct_to_template sont sans aucun doute très utiles, mais les vues génériques de Django sont plus utiles lors du rendu des données à partir d'une base de données. Parce que cette application est si courante, Django est livré avec de nombreuses vues génériques intégrées pour vous aider à générer facilement des vues de liste et de détail des objets.

Jetons un coup d'œil à l'une des vues courantes : la vue liste d'objets. Utilisons l'éditeur du chapitre 5 comme exemple :

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

Pour créer une page de liste pour tous les livres, nous utilisons la configuration d'URL suivante :

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)
)

Voici ce qui est écrit Tout le code Python. Bien sûr, nous devons également rédiger un modèle. Nous pourrions clairement indiquer à la vue object_list quel modèle utiliser en incluant template_name dans le dictionnaire de paramètres supplémentaires, mais Django utilisera le nom de l'objet pour en déduire un lorsqu'un modèle n'est pas donné. Dans cet exemple, le nom du modèle dérivé serait "books/publisher_list.html", où la partie livres est le nom de l'application qui définit ce modèle, et la partie

éditeur est la version minuscule du nom du modèle.

这个模板将按照 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/apres/时出现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&#39;^authors/(?P<author_id>d+)/$&#39;, 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通用视图讲解的内容，更多相关内容请关注PHP中文网（www.php.cn）！