目录
编写第一个Django应用程序,第四部分
本文接上篇文章的第三部分。我们继续投票应用程序,并将关注点放在表单处理和削减我们的代码。
编写一个最小的表单
让我们更新上一篇文章中使用的投票详情模板(“polls/detail.html”)内容,使该模板包含一个<form>标签:
<form action="{% url 'polls:vote' question.id %}" method="post">
{% csrf_token %}
<fieldset>
<legend><h1>{{ question.question_text }}</h1></legend>
{% if error_message %}<p><strong>{{ error_message }}</strong></p>{% endif %}
{% 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 %}
</fieldset>
<input type="submit" value="Vote">
</form>
简要说明:
- 上面的模板为每个问题选项提供一个单选按钮,每一个单选按钮的value值为当前问题选项的ID,单元按钮的name属性值为“choice”。这意味着,当有人选择其中一个单选按钮并提交表单时,它将使用POST发送数据choice=#,其中#是所选选项的ID,这是HTML表单的基本概念。
- 我们将表单的action设置为{% url ‘polls:vote’ question.id %},并且设置method=”post”。使用method=”post”(而不是method=”get”)非常重要,因为提交表单的行为将改变服务器端的数据。无论何时创建表单更改服务器端数据,都要使用method=”post”。这个技巧不是Django特有的,这是一个很好的web开发实践。
- forloop.counter表示for标记循环的次数。
- 由于我们正在创建一个POST表单(它可以具有修改数据的效果),因此我们需要担心跨站点请求伪造。值得庆幸的是,你不必过于担心,因为Django提供了一个有用的系统来保护它。简而言之,所有针对内部url的POST表单都应该使用{% csrf token %}模板标记。
现在,让我们创建一个Django视图来处理表单提交的数据。不知道你还有没有映像,我们在上篇文章中为投票应用程序的此行为创建了一个URLconf:
# polls/urls.py
path("<int:question_id>/vote/", views.vote, name="vote"),
我们为此还创建了一个vote()示例函数。现在让我们来真正地实现这个函数,将以下内容添加到polls/views.py:
from django.http import HttpResponse, HttpResponseRedirect
from django.shortcuts import get_object_or_404, render
from django.urls import reverse
from .models import Choice, Question
def vote(request, question_id):
question = get_object_or_404(Question, pk=question_id)
try:
selected_choice = question.choice_set.get(pk=request.POST["choice"])
except (KeyError, Choice.DoesNotExist):
# Redisplay the question voting form.
return render(
request,
"polls/detail.html",
{
"question": question,
"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=(question.id,)))
此代码包含了一些我们尚未涉及的内容:
- request.POST是一个类似字典的对象,允许我们通过键名访问提交的数据。在本例中,request[‘choice’]以字符串的形式返回选择的选项ID。request.POST的值总是字符串类型。
Django也提供了request.GET以同样的方式访问GET数据——但是我们在代码中明确使用request.POST,以确保数据只通过POST调用更改。
- 如果choice没有提供我们所需要数据的键名,那么request.POST[‘choice’]将引发KeyError异常。上面的代码检查KeyError,如果引发该异常,则重新显示带有错误消息的问题表单。
- 在我们完成增加投票数量后,代码返回一个HttpResponseRedirect而不是通常使用的HttpResponse。HttpResponseRedirect接受一个参数:用户将被重定向到指定的URL。
正如上面的Python注释所指出的,在成功处理POST数据后,应该始终返回HttpResponseRedirect。这个技巧不是Django特有的,这是一个很好的web开发实践。
- 在当前这个例子中,我们在HttpResponseRedirect构造函数中使用了reverse()函数。此函数有助于避免在视图函数中硬编码URL,它被赋予我们想要传递控制权的视图名称,以及指向该视图URL模式的可变部分。在当前示例中,使用我们上篇文章设置的URLconf,这个reverse()函数调用将返回一个如下所示的字符串:
"/polls/3/results/"
其中3是question.id的值,然后调用‘results’视图来显示最终页面。
在有人对某个问题进行投票后,vote()视图将重定向到该问题的结果页面。让我们来编写该视图:
# polls/views.py
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})
这与上篇文章中的detail()视图几乎完全相同,唯一的区别是模板名,稍后我们将解决这样的冗余问题。
现在,创建一个polls/results.html模板:
<!-- polls/templates/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并对问题进行投票,你应该会看到每次投票都会更新结果页面;如果提交表单时没有选择选项,则应该会看到错误消息。
使用泛型视图:代码越少越好
detail()视图和results()视图都很短——并且,如上文所说,它们是存在冗余的。显示投票列表的index()视图也是这样的。
这些视图基本代表了Web开发的常见情况:根据URL中传递的参数从数据库中获取数据,然后加载模板并返回呈现的模板。因为这些功能很常见,所以Django提供了一种快捷方式,称为“泛型视图”系统。
泛型视图将通用模式抽象到甚至不需要编写Python代码就可以编写应用程序的程度。例如,ListView和DetailView泛型视图分别抽象了“显示对象列表”和“显示特定类型对象的详细页面”的概念。
让我们将投票应用程序转换为使用泛型视图系统,这样我们就可以删除一些我们自己写的代码。我们需要采取几个步骤来进行转换,我们将:
- 修改URLconf。
- 删除一些旧的、不需要的视图。
- 引入基于Django泛型视图的新视图。
修改URLconf
首先,打开polls/urls.py,像下面这样修改URLconf:
from django.urls import path
from . import views
app_name = "polls"
urlpatterns = [
path("", views.IndexView.as_view(), name="index"),
path("<int:pk>/", views.DetailView.as_view(), name="detail"),
path("<int:pk>/results/", views.ResultsView.as_view(), name="results"),
path("<int:question_id>/vote/", views.vote, name="vote"),
]
注意,第二个和第三个模式的路径字符串中匹配模式的名称已从<question_id>更改为<pk>。这是必须的,因为我们将使用DetailView泛型视图替换我们的detail()和results()视图,它期望从URL捕获的主键值称为“pk”。
修改视图
接下来,我们删除旧的index、detail和results视图并改用Django的泛型视图。为此,我们打开polls/views.py文件并像这样更改它:
from django.http import HttpResponseRedirect
from django.shortcuts import get_object_or_404, render
from django.urls 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"
每个泛型视图都需要知道它将作用于哪个模型,这是使用model属性提供或通过定义get_queryset()方式来指定。
默认情况下,DetailView泛型视图使用名为<app name>/<model name>_detail.html的模板。在我们的例子中,它将使用的模板是“polls/question_detail.html”。如果你不想使用默认的模板,可以通过template_name属性告诉Django你要使用的模板名称。我们还为结果视图指定了模板名称——这确保了结果视图和详细信息视图在呈现时具有不同的外观,即使它们使用的都是DetailView泛型视图。
同样,ListView泛型视图使用一个名为<app name>/<model name>_list.html;我们用template_name告诉ListView使用我们现有的“polls/index.html”模板。
在前几部分的文章中,模板提供了包含question和latest_question_list的上下文变量。对于DetailView,question变量是自动提供的——因为我们使用的是Django模型(Question),Django能够为上下文变量提供一个合适的名称。但是,对于ListView,自动生成的上下文变量是question_list,为了覆盖这一名称,我们提供了context_object_name属性,指定我们要改用latest_question_list。作为一种替代方法,可以修改模板来匹配新的默认上下文变量——但是告诉Django使用想要的变量要容易得多。
运行开发服务器,访问使用基于泛型视图的投票应用程序。
欢迎关注我的公众号