Django 範本

在上一章節中我們使用 django.http.HttpResponse() 來輸出 "Hello World!"。該方式將數據與視圖混合在一起,不符合 Django 的 MVC 思想。

本章節我們將為大家詳細介紹 Django 範本的應用,範本是一個文本,用於分離文檔的表現形式和內容。


範本應用實例

我們接著上一章節的專案將在 HelloWorld 目錄底下創建 templates 目錄並建立 hello.html檔,整個目錄結構如下:

HelloWorld/
|-- HelloWorld
|   |-- __init__.py
|   |-- __init__.pyc
|   |-- settings.py
|   |-- settings.pyc
|   |-- urls.py
|   |-- urls.pyc
|   |-- view.py
|   |-- view.pyc
|   |-- wsgi.py
|   `-- wsgi.pyc
|-- manage.py
`-- templates
    `-- hello.html

hello.html 檔代碼如下:

HelloWorld/templates/hello.html 檔代碼:

<h1>{{ hello }}</h1>

從範本中我們知道變數使用了雙括弧。

接下來我們需要向Django說明範本檔的路徑,修改HelloWorld/settings.py,修改 TEMPLATES 中的 DIRS 為 [BASE_DIR+"/templates",],如下所示:

HelloWorld/HelloWorld/settings.py 檔代碼:

...TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [BASE_DIR+"/templates",], # 修改位置 'APP_DIRS': True, 'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], }, }, ] ...

我們現在修改 view.py,增加一個新的對象,用於向範本提交數據:

HelloWorld/HelloWorld/view.py 檔代碼:

from django.shortcuts import render def hello(request): context = {} context['hello'] = 'Hello World!' return render(request, 'hello.html', context)

可以看到,我們這裏使用 render 來替代之前使用的 HttpResponse。render 還使用了一個字典 context 作為參數。

context 字典中元素的鍵值 "hello" 對應了範本中的變數 "{{ hello }}"。

再訪問訪問 http://127.0.0.1:8000/hello,可以看到頁面:

這樣我們就完成了使用範本來輸出數據,從而實現數據與視圖分離。

接下來我們將具體介紹範本中常用的語法規則。


Django 範本標籤

if/else 標籤

基本語法格式如下:

{% if condition %}
     ... display
{% endif %}

或者:

{% if condition1 %}
   ... display 1
{% elif condition2 %}
   ... display 2
{% else %}
   ... display 3
{% endif %}

根據條件判斷是否輸出。if/else 支持嵌套。

{% if %} 標籤接受 and , or 或者 not 關鍵字來對多個變數做判斷 ,或者對變數取反( not ),例如:

{% if athlete_list and coach_list %}
     athletes 和 coaches 變數都是可用的。

{% endif %}

for 標籤

{% for %} 允許我們在一個序列上迭代。

與Python的 for 語句的情形類似,迴圈語法是 for X in Y ,Y是要迭代的序列而X是在每一個特定的迴圈中使用的變數名稱。

每一次迴圈中,範本系統會渲染在 {% for %} 和 {% endfor %} 之間的所有內容。

例如,給定一個運動員列表 athlete_list 變數,我們可以使用下麵的代碼來顯示這個列表:

<ul>
{% for athlete in athlete_list %}
    <li>{{ athlete.name }}</li>
{% endfor %}
</ul>

給標籤增加一個 reversed 使得該列表被反向迭代:

{% for athlete in athlete_list reversed %}
...
{% endfor %}

可以嵌套使用 {% for %} 標籤:

{% for athlete in athlete_list %}
    <h1>{{ athlete.name }}</h1>
    <ul>
    {% for sport in athlete.sports_played %}
        <li>{{ sport }}</li>
    {% endfor %}
    </ul>
{% endfor %}

ifequal/ifnotequal 標籤

{% ifequal %} 標籤比較兩個值,當他們相等時,顯示在 {% ifequal %} 和 {% endifequal %} 之中所有的值。

下麵的例子比較兩個範本變數 user 和 currentuser :

{% ifequal user currentuser %}
    <h1>Welcome!</h1>
{% endifequal %}

和 {% if %} 類似, {% ifequal %} 支持可選的 {% else%} 標籤:8

{% ifequal section 'sitenews' %}
    <h1>Site News</h1>
{% else %}
    <h1>No News Here</h1>
{% endifequal %}

注釋標籤

Django 注釋使用 {# #}。

{# 這是一個注釋 #}

篩檢程式

範本篩檢程式可以在變數被顯示前修改它,篩檢程式使用管道字元,如下所示:

{{ name|lower }}

{{ name }} 變數被篩檢程式 lower 處理後,文檔大寫轉換文本為小寫。

過濾管道可以被* 套接* ,既是說,一個篩檢程式管道的輸出又可以作為下一個管道的輸入:

{{ my_list|first|upper }}

以上實例將第一個元素並將其轉化為大寫。

有些篩檢程式有參數。 篩檢程式的參數跟隨冒號之後並且總是以雙引號包含。 例如:

{{ bio|truncatewords:"30" }}

這個將顯示變數 bio 的前30個詞。

其他篩檢程式:

  • addslashes : 添加反斜杠到任何反斜杠、單引號或者雙引號前面。
  • date : 按指定的格式字串參數格式化 date 或者 datetime 對象,實例:
    {{ pub_date|date:"F j, Y" }}
  • length : 返回變數的長度。

include 標籤

{% include %} 標籤允許在範本中包含其他的範本的內容。

下麵這個例子都包含了 nav.html 範本:

{% include "nav.html" %}

範本繼承

範本可以用繼承的方式來實現複用。

接下來我們先創建之前專案的 templates 目錄中添加 base.html 檔,代碼如下:

HelloWorld/templates/base.html 檔代碼:

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>IT研修(xuhuhu.com)</title> </head> <body> <h1>Hello World!</h1> <p>IT研修 Django 測試。</p> {% block mainbody %} <p>original</p> {% endblock %} </body> </html>

以上代碼中,名為 mainbody 的 block 標籤是可以被繼承者們替換掉的部分。

所有的 {% block %} 標籤告訴範本引擎,子範本可以重載這些部分。

hello.html 中繼承 base.html,並替換特定 block,hello.html 修改後的代碼如下:

HelloWorld/templates/hello.html 檔代碼:

{%extends "base.html" %} {% block mainbody %} <p>繼承了 base.html 檔</p> {% endblock %}

第一行代碼說明 hello.html 繼承了 base.html 檔。可以看到,這裏相同名字的 block 標籤用以替換 base.html 的相應 block。

重新訪問地址 http://127.0.0.1:8000/hello,輸出結果如下: