本教程上接教程第3部分。我们将继续开发网页投票应用,在本部分将主要关注简单的表单处理以及如何对代码进行优化。
让我们更新一下在上一个教程中编写的投票详细页面的模板(“polls/detail.html”),让它包含一个HTML<form> 元素:
<h1>{{ question.question_text }}</h1>
{% if error_message %}<p><strong>{{ error_message }}</strong></p>{% endif %}
<form action="{% url 'polls:vote' question.id %}" method="post">
{% csrf_token %}
{% for choice in question.choice_set.all %}
<input type="radio" name="choice" id="choice{{ forloop.counter }}" value="{{ choice.id }}" />
<label for="choice{{ forloop.counter }}">{{ choice.choice_text }}</label><br />
{% endfor %}
<input type="submit" value="Vote" />
</form>
简要说明:
现在,我们来创建一个处理提交的数据的Django视图,并用它来处理。记住,在教程 3中,我们为投票应用创建了一个URLconf ,包含这一行:
url(r'^(?P<question_id>[0-9]+)/vote/$', views.vote, name='vote'),
我们还创建了一个vote()函数的虚拟实现。让我们来创建一个真实的版本。 将下面的代码添加到polls/views.py:
from django.shortcuts import get_object_or_404, render
from django.http import HttpResponseRedirect, HttpResponse
from django.core.urlresolvers import reverse
from .models import Choice, Question
# ...
def vote(request, question_id):
p = get_object_or_404(Question, pk=question_id)
try:
selected_choice = p.choice_set.get(pk=request.POST['choice'])
except (KeyError, Choice.DoesNotExist):
# Redisplay the question voting form.
return render(request, 'polls/detail.html', {
'question': p,
'error_message': "You didn't select a choice.",
})
else:
selected_choice.votes += 1
selected_choice.save()
# Always return an HttpResponseRedirect after successfully dealing
# with POST data. This prevents data from being posted twice if a
# user hits the Back button.
return HttpResponseRedirect(reverse('polls:results', args=(p.id,)))
有些新的东西我们来解释一下:
request.POST 是一个类似字典的对象,让你可以通过关键字的名字获取提交的数据。 这个例子中,request.POST['choice'] 以字符串形式返回选择的Choice的ID。request.POST 的值永远是字符串。
注意,Django还以同样的方式提供request.GET用于访问GET数据 —— 但我们在代码中显式地使用request.POST,以保证数据只能通过POST调用改动。
如果在POST数据中没有提供choice,request.POST['choice']将引发一个KeyError。上面的代码检查KeyError,如果没有给出choice将重新显示Question表单和一个错误信息。
在增加Choice的得票数之后,代码返回一个 HttpResponseRedirect而不是常用的HttpResponse。HttpResponseRedirect只接收一个参数:用户将要被重定向的URL(请继续看下去,我们将会解释如何构造这个例子中的URL)。
正如上面的Python注释指出的,你应该在成功处理POST数据后总是返回一个HttpResponseRedirect。 这不是Django的特定技巧; 这是那些优秀网站在开发实践中形成的共识。
在这个例子中,我们在HttpResponseRedirect的构造函数中使用reverse()函数。这个函数避免了我们在视图函数中硬编码URL。它需要我们给出我们想要跳转的视图的名字和该视图所对应的URL模式中需要给该视图提供的参数。 在本例中,使用在教程3中设定的URLconf, reverse() 调用将返回一个这样的字符串:
'/polls/3/results/'
... 其中3是p.id的值。重定向的URL将调用'results'视图来显示最终的页面。
正如在教程3中提到的,request是一个 HttpRequest对象。更多关于HttpRequest对象的内容,请参见请求和响应的文档。
当有人对Question进行投票后,vote()视图将请求重定向到Question的结果界面。让我们来编写这个视图:
from django.shortcuts import get_object_or_404, render
def results(request, question_id):
question = get_object_or_404(Question, pk=question_id)
return render(request, 'polls/results.html', {'question': question})
这和教程 3中的detail()视图几乎一模一样。唯一的不同是模板的名字。 我们将在稍后解决这个冗余问题。
下面创建一个polls/results.html模板:
<h1>{{ question.question_text }}</h1>
<ul>
{% for choice in question.choice_set.all %}
<li>{{ choice.choice_text }} -- {{ choice.votes }} vote{{ choice.votes|pluralize }}</li>
{% endfor %}
</ul>
<a href="{% url 'polls:detail' question.id %}">Vote again?</a>
现在,在你的浏览器中访问/polls/1/然后为Question投票。你应该看到一个投票结果页面,并且在你每次投票之后都会更新。 如果你提交时没有选择任何Choice,你应该看到错误信息。
detail()(在教程 3中)和results()视图都很简单 —— 并且,像上面提到的那样,存在冗余问题。用来显示一个议题列表的index() 视图(也在教程 3 中)和它们类似。
这些视图反映基本的Web开发中的一个常见情况:根据URL中的参数从数据库中获取数据、载入模板文件然后返回渲染后的模板。 由于这种情况非常普遍,Django提供了一种叫做“generic views”的系统可以方便地进行处理。
Generic views会将常见的模式抽象化,可以使你在编写app时甚至不需要编写Python代码。
让我们将我们的投票应用转换成使用通用视图系统,这样我们可以删除许多我们的代码。我们仅仅需要做以下几步来完成转换: 我们将:
请继续阅读来了解详细信息。
为什么要重构代码?
一般来说,当编写一个Django应用时,你应该先评估一下通用视图是否可以解决你的问题,你应该在一开始使用它,而不是进行到一半时重构代码。本教程目前为止是有意将重点放在以“困难的方式”编写视图,这是为将重点放在核心概念上。
就像在使用计算器之前你需要知道基本的数学一样。
首先,打开polls/urls.py 这个URLconf 并将它修改成:
from django.conf.urls import url
from . import views
urlpatterns = [
url(r'^$', views.IndexView.as_view(), name='index'),
url(r'^(?P<pk>[0-9]+)/$', views.DetailView.as_view(), name='detail'),
url(r'^(?P<pk>[0-9]+)/results/$', views.ResultsView.as_view(), name='results'),
url(r'^(?P<question_id>[0-9]+)/vote/$', views.vote, name='vote'),
]
注意在第二个和第三个模式的正则表达式中,匹配的模式的名字由<question_id> 变成 <pk>。
下一步,我们将删除旧的index、detail和 results 视图,并用Django的通用视图代替。打开polls/views.py文件,并将它修改成:
from django.shortcuts import get_object_or_404, render
from django.http import HttpResponseRedirect
from django.core.urlresolvers import reverse
from django.views import generic
from .models import Choice, Question
class IndexView(generic.ListView):
template_name = 'polls/index.html'
context_object_name = 'latest_question_list'
def get_queryset(self):
"""Return the last five published questions."""
return Question.objects.order_by('-pub_date')[:5]
class DetailView(generic.DetailView):
model = Question
template_name = 'polls/detail.html'
class ResultsView(generic.DetailView):
model = Question
template_name = 'polls/results.html'
def vote(request, question_id):
... # same as above
我们在这里使用两个通用视图:ListView 和 DetailView。这两个视图分别抽象“显示一个对象列表”和“显示一个特定类型对象的详细信息页面”这两种概念。
默认情况下,通用视图DetailView 使用一个叫做<app name>/<model name>_detail.html的模板。在我们的例子中,它将使用 "polls/question_detail.html"模板。template_name属性是用来告诉Django使用一个指定的模板名字,而不是自动生成的默认名字。 我们也为results列表视图指定了template_name —— 这确保results视图和detail视图在渲染时具有不同的外观,即使它们在后台都是同一个 DetailView。
类似地,ListView使用一个叫做<app name>/<model name>_list.html的默认模板;我们使用template_name 来告诉ListView 使用我们自己已经存在的"polls/index.html"模板。
在之前的教程中,提供模板文件时都带有一个包含question 和 latest_question_list 变量的context。对于DetailView ,question变量会自动提供—— 因为我们使用Django 的模型 (Question), Django 能够为context 变量决定一个合适的名字。然而对于ListView, 自动生成的context 变量是question_list。为了覆盖这个行为,我们提供 context_object_name 属性,表示我们想使用latest_question_list。作为一种替换方案,你可以改变你的模板来匹配新的context变量 —— 但直接告诉Django使用你想要的变量会省事很多。
启动服务器,使用一下基于通用视图的新投票应用。
更多关于通用视图的详细信息,请查看通用视图的文档。
当你对你所写的表单和通用视图感到满意后,请阅读教程的第5部分 来了解如何测试我们的投票应用。
2015年5月13日