编写你的第一个 Django 应用,第 3 部分

    Django 中的视图的概念是「一类具有相同功能和模板的网页的集合」。比如,在一个博客应用中,你可能会创建如下几个视图:

    • 博客首页——展示最近的几项内容。
    • 内容“详情”页——详细展示某项内容。
    • 以年为单位的归档页——展示选中的年份里各个月份创建的内容。
    • 以月为单位的归档页——展示选中的月份里各天创建的内容。
    • 以天为单位的归档页——展示选中天里创建的所有内容。
    • 评论处理器——用于响应为一项内容添加评论的操作。
      而在我们的投票应用中,我们需要下列几个视图:

    • 问题索引页——展示最近的几个投票问题。

    • 问题详情页——展示某个投票的问题和不带结果的选项列表。
    • 问题结果页——展示某个投票的结果。
    • 投票处理器——用于响应用户为某个问题的特定选项投票的操作。
      在 Django 中,网页和其他内容都是从视图派生而来。每一个视图表现为一个简单的 Python 函数(或者说方法,如果是在基于类的视图里的话)。Django 将会根据用户请求的 URL 来选择使用哪个视图(更准确的说,是根据 URL 中域名之后的部分)。

    在你上网的过程中,很可能看见过像这样美丽的 URL: "ME2/Sites/dirmod.asp?sid=&type=gen&mod=Core+Pages&gid=A6CD4967199A42D9B65B1B" 。别担心,Django 里的 URL 规则 要比这优雅的多!

    一个 URL 模式定义了某种 URL 的基本格式——举个例子:。

    为了将 URL 和视图关联起来,Django 使用了 'URLconfs' 来配置。URLconf 将 URL 模式映射到视图。

    本教程只会介绍 URLconf 的基础内容,你可以看看 URL调度器 以获取更多内容。

    编写更多视图

    现在让我们向 polls/views.py 里添加更多视图。这些视图有一些不同,因为他们接收参数:

    polls/views.py

    把这些新视图添加进 polls.urls 模块里,只要添加几个 函数调用就行:

    polls/urls.py

    1. from django.urls import path
    2.  
    3. from . import views
    4.  
    5. urlpatterns = [
    6. # ex: /polls/
    7. path('', views.index, name='index'),
    8. # ex: /polls/5/
    9. path('<int:question_id>/', views.detail, name='detail'),
    10. # ex: /polls/5/results/
    11. path('<int:question_id>/results/', views.results, name='results'),
    12. # ex: /polls/5/vote/
    13. path('<int:question_id>/vote/', views.vote, name='vote'),
    14. ]

    然后看看你的浏览器,如果你转到 "/polls/34/" ,Django 将会运行 detail() 方法并且展示你在 URL 里提供的问题 ID。再试试 "/polls/34/vote/" 和 "/polls/34/vote/" ——你将会看到暂时用于占位的结果和投票页。

    当某人请求你网站的某一页面时——比如说, "/polls/34/" ,Django 将会载入 mysite.urls 模块,因为这在配置项 中设置了。然后 Django 寻找名为 urlpatterns 变量并且按序匹配正则表达式。在找到匹配项 'polls/',它切掉了匹配的文本("polls/"),将剩余文本——"34/",发送至 'polls.urls' URLconf 做进一步处理。在这里剩余文本匹配了 '<int:question_id>/',使得我们 Django 以如下形式调用 detail():

    1. detail(request=<HttpRequest object>, question_id=34)

    question_id=34<int:question_id> 匹配生成。使用尖括号“捕获”这部分 URL,且以关键字参数的形式发送给视图函数。上述字符串的 :question_id> 部分定义了将被用于区分匹配模式的变量名,而 int: 则是一个转换器决定了应该以什么变量类型匹配这部分的 URL 路径。

    为每个 URL 加上不必要的东西,例如 .html ,是没有必要的。不过如果你非要加的话,也是可以的:

    1. path('polls/latest.html', views.index),

    但是,别这样做,这太傻了。

    每个视图必须要做的只有两件事:返回一个包含被请求页面内容的 HttpResponse 对象,或者抛出一个异常,比如 。至于你还想干些什么,随便你。

    你的视图可以从数据库里读取记录,可以使用一个模板引擎(比如 Django 自带的,或者其他第三方的),可以生成一个 PDF 文件,可以输出一个 XML,创建一个 ZIP 文件,你可以做任何你想做的事,使用任何你想用的 Python 库。

    Django 只要求返回的是一个 HttpResponse ,或者抛出一个异常。

    因为 Django 自带的数据库 API 很方便,我们曾在 中学过,所以我们试试在视图里使用它。我们在 index() 函数里插入了一些新内容,让它能展示数据库里以发布日期排序的最近 5 个投票问题,以空格分割:

    polls/views.py

    1. from django.http import HttpResponse
    2. from .models import Question
    3.  
    4.  
    5. def index(request):
    6. latest_question_list = Question.objects.order_by('-pub_date')[:5]
    7. output = ', '.join([q.question_text for q in latest_question_list])
    8. return HttpResponse(output)
    9.  
    10. # Leave the rest of the views (detail, results, vote) unchanged

    首先,在你的 polls 目录里创建一个 templates 目录。Django 将会在这个目录里查找模板文件。

    你项目的 配置项描述了 Django 如何载入和渲染模板。默认的设置文件设置了 DjangoTemplates 后端,并将 APP_DIRS 设置成了 True。这一选项将会让 DjangoTemplates 在每个 文件夹中寻找 "templates" 子目录。这就是为什么尽管我们没有像在第二部分中那样修改 DIRS 设置,Django 也能正确找到 polls 的模板位置的原因。

    在你刚刚创建的 templates 目录里,再创建一个目录 ,然后在其中新建一个文件 index.html 。换句话说,你的模板文件的路径应该是 polls/templates/polls/index.html 。因为 Django 会寻找到对应的 app_directories ,所以你只需要使用 polls/index.html 就可以引用到这一模板了。

    模板命名空间

    虽然我们现在可以将模板文件直接放在 polls/templates 文件夹中(而不是再建立一个 polls 子文件夹),但是这样做不太好。Django 将会选择第一个匹配的模板文件,如果你有一个模板文件正好和另一个应用中的某个模板文件重名,Django 没有办法 区分 它们。我们需要帮助 Django 选择正确的模板,最简单的方法就是把他们放入各自的 命名空间 中,也就是把这些模板放入一个和 自身 应用重名的子文件夹里。

    将下面的代码输入到刚刚创建的模板文件中:

    polls/templates/polls/index.html

    1. {% if latest_question_list %}
    2. <ul>
    3. {% for question in latest_question_list %}
    4. <li><a href="/polls/{{ question.id }}/">{{ question.question_text }}</a></li>
    5. {% endfor %}
    6. </ul>
    7. {% else %}
    8. <p>No polls are available.</p>
    9. {% endif %}

    然后,让我们更新一下 polls/views.py 里的 index 视图来使用模板:

    polls/views.py

    上述代码的作用是,载入 polls/index.html 模板文件,并且向它传递一个上下文(context)。这个上下文是一个字典,它将模板内的变量映射为 Python 对象。

    用你的浏览器访问 "/polls/" ,你将会看见一个无序列表,列出了我们在 教程第 2 部分 中添加的 “What's up” 投票问题,链接指向这个投票的详情页。

    「载入模板,填充上下文,再返回由它生成的 对象」是一个非常常用的操作流程。于是 Django 提供了一个快捷函数,我们用它来重写 index() 视图:

    polls/views.py

    1. from django.shortcuts import render
    2.  
    3. from .models import Question
    4.  
    5.  
    6. def index(request):
    7. latest_question_list = Question.objects.order_by('-pub_date')[:5]
    8. context = {'latest_question_list': latest_question_list}
    9. return render(request, 'polls/index.html', context)

    注意到,我们不再需要导入 和 HttpResponse 。不过如果你还有其他函数(比如说 detail, results, 和 vote )需要用到它的话,就需要保持 HttpResponse 的导入。

    The function takes the request object as itsfirst argument, a template name as its second argument and a dictionary as itsoptional third argument. It returns an HttpResponseobject of the given template rendered with the given context.

    抛出 404 错误

    现在,我们来处理投票详情视图——它会显示指定投票的问题标题。下面是这个视图的代码:

    polls/views.py

    1. from django.http import Http404
    2. from django.shortcuts import render
    3.  
    4. from .models import Question
    5. # ...
    6. def detail(request, question_id):
    7. try:
    8. question = Question.objects.get(pk=question_id)
    9. except Question.DoesNotExist:
    10. return render(request, 'polls/detail.html', {'question': question})

    这里有个新原则。如果指定问题 ID 所对应的问题不存在,这个视图就会抛出一个 异常。

    我们稍后再讨论你需要在 polls/detail.html 里输入什么,但是如果你想试试上面这段代码是否正常工作的话,你可以暂时把下面这段输进去:

    polls/templates/polls/detail.html

    1. {{ question }}

    这样你就能测试了。

    一个快捷函数: get_object_or_404()

    polls/views.py

    1. from django.shortcuts import get_object_or_404, render
    2.  
    3. from .models import Question
    4. # ...
    5. def detail(request, question_id):
    6. question = get_object_or_404(Question, pk=question_id)
    7. return render(request, 'polls/detail.html', {'question': question})

    The function takes a Django modelas its first argument and an arbitrary number of keyword arguments, which itpasses to the get() function of themodel's manager. It raises if the object doesn'texist.

    设计哲学

    为什么我们使用辅助函数 get_object_or_404() 而不是自己捕获 异常呢?还有,为什么模型 API 不直接抛出 而是抛出 呢?

    因为这样做会增加模型层和视图层的耦合性。指导 Django 设计的最重要的思想之一就是要保证松散耦合。一些受控的耦合将会被包含在 django.shortcuts 模块中。

    也有 函数,工作原理和 get_object_or_404() 一样,除了 函数被换成了 filter() 函数。如果列表为空的话会抛出 异常。

    回过头去看看我们的 detail() 视图。它向模板传递了上下文变量 question 。下面是 polls/detail.html 模板里正式的代码:

    polls/templates/polls/detail.html

    1. <h1>{{ question.question_text }}</h1>
    2. <ul>
    3. {% for choice in question.choice_set.all %}
    4. <li>{{ choice.choice_text }}</li>
    5. {% endfor %}
    6. </ul>

    模板系统统一使用点符号来访问变量的属性。在示例 {{ question.question_text }} 中,首先 Django 尝试对 question 对象使用字典查找(也就是使用 obj.get(str) 操作),如果失败了就尝试属性查找(也就是 obj.str 操作),结果是成功了。如果这一操作也失败的话,将会尝试列表查找(也就是 obj[int] 操作)。

    在 循环中发生的函数调用:question.choice_set.all 被解释为 Python 代码 question.choice_set.all() ,将会返回一个可迭代的 Choice 对象,这一对象可以在 {% for %} 标签内部使用。

    查看 可以了解关于模板的更多信息。

    去除模板中的硬编码 URL

    还记得吗,我们在 polls/index.html 里编写投票链接时,链接是硬编码的:

    问题在于,硬编码和强耦合的链接,对于一个包含很多应用的项目来说,修改起来是十分困难的。然而,因为你在 polls.urls 的 函数中通过 name 参数为 URL 定义了名字,你可以使用 {% url %} 标签代替它:

    1. <li><a href="{% url 'detail' question.id %}">{{ question.question_text }}</a></li>

    这个标签的工作方式是在 polls.urls 模块的 URL 定义中寻具有指定名字的条目。你可以回忆一下,具有名字 'detail' 的 URL 是在如下语句中定义的:

    1. ...
    2. # the 'name' value as called by the {% url %} template tag
    3. path('<int:question_id>/', views.detail, name='detail'),
    4. ...

    如果你想改变投票详情视图的 URL,比如想改成 polls/specifics/12/ ,你不用在模板里修改任何东西(包括其它模板),只要在 polls/urls.py 里稍微修改一下就行:

    1. ...
    2. # added the word 'specifics'
    3. path('specifics/<int:question_id>/', views.detail, name='detail'),
    4. ...

    教程项目只有一个应用,polls 。在一个真实的 Django 项目中,可能会有五个,十个,二十个,甚至更多应用。Django 如何分辨重名的 URL 呢?举个例子,polls 应用有 detail 视图,可能另一个博客应用也有同名的视图。Django 如何知道 {% url %} 标签到底对应哪一个应用的 URL 呢?

    答案是:在根 URLconf 中添加命名空间。在 polls/urls.py 文件中稍作修改,加上 设置命名空间:

    polls/urls.py

    1. from django.urls import path
    2.  
    3. from . import views
    4.  
    5. app_name = 'polls'
    6. urlpatterns = [
    7. path('', views.index, name='index'),
    8. path('<int:question_id>/', views.detail, name='detail'),
    9. path('<int:question_id>/results/', views.results, name='results'),
    10. path('<int:question_id>/vote/', views.vote, name='vote'),
    11. ]

    现在,编辑 polls/index.html 文件,从:

    polls/templates/polls/index.html

    1. <li><a href="{% url 'detail' question.id %}">{{ question.question_text }}</a></li>

    修改为指向具有命名空间的详细视图:

    当你对你写的视图感到满意后,请阅读 教程的第 4 部分 了解简单的表单处理和通用视图。