一起學FLask -第二章,模板
要想開發出易於維護的程式,關鍵在於編寫形式簡潔且結構良好的程式碼。
檢視函式的作用很明確,即生成請求的響應,如第 1 章中的示例所示。對最簡單的請求來說, 這就足夠了,但一般而言,請求會改變程式的狀態,而這種變化也會在檢視函式中產生。
例如,使用者在網站中註冊了一個新賬戶。使用者在表單中輸入電子郵件地址和密碼,然後點 擊提交按鈕。伺服器接收到包含使用者輸入資料的請求,然後 Flask 把請求分發到處理註冊 請求的檢視函式。這個檢視函式需要訪問資料庫,新增新使用者,然後生成響應回送瀏覽 器。這兩個過程分別稱為業務邏輯和表現邏輯。
把業務邏輯和表現邏輯混在一起會導致程式碼難以理解和維護。假設要為一個大型表格構建 HTML 程式碼,表格中的資料由資料庫中讀取的資料以及必要的 HTML 字串連線在一起。 把表現邏輯移到模板中能夠提升程式的可維護性。
模板是一個包含響應文字的檔案,其中包含用佔位變量表示的動態部分,其具體值只在請 求的上下文中才能知道。使用真實值替換變數,再返回最終得到的響應字串,這一過程 稱為渲染。為了渲染模板,Flask 使用了一個名為 Jinja2 的強大模板引擎。
2.1 Jinja2模板引擎
形式最簡單的 Jinja2 模板就是一個包含響應文字的檔案。示例 2-1 是一個 Jinja2 模板,它 和示例 1-1 中 index() 檢視函式的響應一樣。
示例 3-1 templates/index.html:Jinja2 模板
<h1>Hello World!</h1>
示例 1-2 中,檢視函式 user() 返回的響應中包含一個使用變量表示的動態部分。示例 2-2 實現了這個響應。
示例 3-2 templates/user.html:Jinja2 模板
<h1>Hello, {{ name }}!</h1>
1.1.1 渲染模板 預設情況下,Flask 在程式資料夾中的 templates 子資料夾中尋找模板。在下一個 hello.py 版本中,要把前面定義的模板儲存在 templates 資料夾中,並分別命名為 index.html 和 user. html。 程式中的檢視函式需要修改一下,以便渲染這些模板。修改方法參見示例 1-3。
示例 1-3 hello.py:渲染模板
from flask import Flask,render_template
app = Flask(__name__)
@app.route('/')
def index():
return render_template('index.html')
@app.route('/user/<name>')
def user(name):
return render_template('user.html',name=name)
if __name__ == '__main__':
app.run()
Flask 提供的 render_template 函式把 Jinja2 模板引擎整合到了程式中。render_template 函 數的第一個引數是模板的檔名。隨後的引數都是鍵值對,表示模板中變數對應的真實 值。在這段程式碼中,第二個模板收到一個名為 name 的變數。
前例中的 name=name 是關鍵字引數,這類關鍵字引數很常見,但如果你不熟悉它們的話, 可能會覺得迷惑且難以理解。左邊的“name”表示引數名,就是模板中使用的佔位符;右 邊的“name”是當前作用域中的變數,表示同名引數的值。
2.1.2 變數
示例 2-2 在模板中使用的 {{ name }} 結構表示一個變數,它是一種特殊的佔位符,告訴模 板引擎這個位置的值從渲染模板時使用的資料中獲取。
Jinja2 能識別所有型別的變數,甚至是一些複雜的型別,例如列表、字典和物件。在模板 中使用變數的一些示例如下:
<p>A value from a dictionary: {{ mydict['key'] }}.</p>
<p>A value from a list: {{ mylist[3] }}.</p>
<p>A value from a list, with a variable index: {{ mylist[myintvar] }}.</p>
<p>A value from an object's method: {{ myobj.somemethod() }}.</p>
可以使用過濾器修改變數,過濾器名新增在變數名之後,中間使用豎線分隔。例如,下述 模板以首字母大寫形式顯示變數 name 的值:
Hello, {{ name|capitalize }}
表 2-1 列出了 Jinja2 提供的部分常用過濾器。
表2-1 Jinja2變數過濾器
過濾器名 | 說明 |
safe | 渲染值時不轉義 |
capitalize | 把值的首字母轉換成大寫,其他字母轉換成小寫 |
lower | 把值轉換成小寫形式 |
upper | 把值轉換成大寫形式 |
title | 把值中每個單詞的首字母都轉換成大寫 |
trim | 把值的首尾空格去掉 |
striptags | 渲染之前把值中所有的 HTML 標籤都刪掉 |
safe 過濾器值得特別說明一下。預設情況下,出於安全考慮,Jinja2 會轉義所有變數。例 如,如果一個變數的值為
'<h1>Hello</h1>'
Jinja2 會將其渲染成
'<h1>Hello</h1>'
瀏覽器能顯示這個 h1 元素,但不會進行解釋。很多情況下需要顯示變數中儲存 的 HTML 程式碼,這時就可使用 safe 過濾器。
千萬別在不可信的值上使用 safe 過濾器,例如使用者在表單中輸入的文字。
完整的過濾器列表可在 Jinja2 文件(http://jinja.pocoo.org/docs/templates/#builtin-filters)中 檢視。
2.1.3 控制結構
Jinja2 提供了多種控制結構,可用來改變模板的渲染流程。本節使用簡單的例子介紹其中 最有用的控制結構。
下面這個例子展示瞭如何在模板中使用條件控制語句:
{% if user %}
Hello, {{ user }}!
{% else %}
Hello, Stranger!
{% endif %}
另一種常見需求是在模板中渲染一組元素。下例展示瞭如何使用 for 迴圈實現這一需求:
<ul>
{% for comment in comments %}
<li>{{ comment }}</li>
{% endfor %}
</ul>
Jinja2 還支援巨集。巨集類似於 Python 程式碼中的函式。例如:
{% macro render_comment(comment) %}
<li>{{ comment }}</li>
{% endmacro %}
<ul>
{% for comment in comments %}
{{ render_comment(comment) }}
{% endfor %}
</ul>
為了重複使用巨集,我們可以將其儲存在單獨的檔案中,然後在需要使用的模板中匯入:
{% import 'macros.html' as macros %}
<ul>
{% for comment in comments %}
{{ macros.render_comment(comment) }}
{% endfor %}
</ul>
需要在多處重複使用的模板程式碼片段可以寫入單獨的檔案,再包含在所有模板中,以避免 重複:
{% include 'common.html' %}
另一種重複使用程式碼的強大方式是模板繼承,它類似於 Python 程式碼中的類繼承。首先,創 建一個名為 base.html 的基模板:
<html>
<head>
{% block head %}
<title>{% block title %}{% endblock %} - My Application</title>
{% endblock %}
</head>
<body>
{% block body %}
{% endblock %}
</body>
</html>
block 標籤定義的元素可在衍生模板中修改。在本例中,我們定義了名為 head、title 和 body 的塊。注意,title 包含在 head 中。下面這個示例是基模板的衍生模板:
{% extends "base.html" %}
{% block title %}Index{% endblock %}
{% block head %}
{{ super() }}
<style>
</style>
{% endblock %}
{% block body %}
<h1>Hello, World!</h1>
{% endblock %}
extends 指令宣告這個模板衍生自 base.html。在 extends 指令之後,基模板中的 3 個塊被 重新定義,模板引擎會將其插入適當的位置。注意新定義的 head 塊,在基模板中其內容不 是空的,所以使用 super() 獲取原來的內容。 稍後會展示這些控制結構的具體用法,讓你瞭解一下它們的工作原理。