在Python的Flask架構中使用模版的入門教程

概述

如果你已經閱讀過上一個章節,那麼你應該已經完成了充分的準備工作並且建立了一個很簡單的具有如下檔案結構的Web應用:

microblog
|-flask檔案夾
|-<一些虛擬環境的檔案>
|-app檔案夾
| |-static檔案夾
| |-templates檔案夾
| |-__init__.py檔案
| |-views.py檔案
|-tmp檔案夾
|-run.py檔案

親,想要運行這個程式麼?那就運行這個run.py檔案,然後在你的瀏覽器裡邊開啟http://localhost:5000這個地址.

我們在後面的章節會不斷地從前一章節結束的地方繼續開發我們的應用,所以你要確保你的環境已經正確安裝,並且你的應用能夠正常運行.

為什麼我們需要使用模板系統

讓我們來考慮一下,我們接下來怎麼樣擴充我們的小程式.

我們要在微博應用裡邊實現一個非常基本的功能,在首頁上面顯示一個歡迎已登入使用者的標題.暫且忽略當前應用裡邊沒有使用者的狀況,我將會在稍後解決這個問題.

要顯示一個美觀大方的標題,最簡單的方法就是改變我們提供視圖的方式來顯示一些HTML代碼,不如這樣子:\

from app import app @app.route('/')@app.route('/index')def index():  user = { 'nickname': 'Miguel' } # fake user  return '''   Home Page    
Hello, ''' + user['nickname'] + '''
 

現在,在你的瀏覽器裡面重新整理一下看看,是不是很爽?

因為我們這個小程式還支援使用者功能，所以咱用了一個使用者佔位對象，通常它被親切的稱呼為假資料或測試資料。它可以讓我們關注程式中急需解決的部分。

爽完了，面對實際吧，我希望你會覺得上面這個混合著html代碼的小程式相當噁心。想想看，如果你用一些動態內容產生的一個複雜的HTML頁面，並且想要在由這樣的程式組成的網站中改變一些頁面內容，這將會一件非常蛋疼的事情。

模板系統拯救世界

如果保持商務邏輯和表現的分離，你的網站結構將會組織的更好。不要不信，如果你用python完成了業務代碼，你甚至可以請一個網站設計師幫你完成剩下的部分。模板系統就是幫你實現業務和表現分離的。

讓我們完成第一個模板(fileapp/templates/index.html):

   {{title}} - microblog     
Hello, {{user.nickname}}!
 

如你所見，我們只是寫了一個普通的HTML頁面，唯一跟HTML有區別的就是裡面摻雜了一些以 {{ ... }} 組成的動態內容預留位置。

現在讓我們來看看視圖函數中是如何處理這個模板的(fileapp/views.py):

from flask import render_templatefrom app import app @app.route('/')@app.route('/index')def index():  user = { 'nickname': 'Miguel' } # fake user  return render_template("index.html",    title = 'Home',    user = user)

測試這段程式的重點就是看看模板系統是如何工作的。你可以比較瀏覽器中渲染後的html頁面源碼與模板檔案源碼之間的區別。

在上面的程式中，我們從 Flask 架構 import 了一個叫 render_template 的新函數，並用這個函數來渲染模板。並給這個函數賦予了模板檔案名稱和一些變數作為參數。它將匯入的變數替換掉模板中的變數預留位置，並返回渲染後的模板。

讓我們瞭解的更深入點。在 Flask 底層，render_template 函數實際上是調用了 Flask 的一個組件： Jinja2 模板處理引擎。是 Jinjia2 用匯入的變數替換掉了模板中對應的 {{ ... }} 代碼塊。

模板中的流程式控制制

Jinja2 模板系統還支援流程式控制制語句，我們來嘗試一下在模板中添加一個 if 流程式控制制語句 (fileapp/templates/index.html):

   {% if title %}  {{title}} - microblog  {% else %}  Welcome to microblog  {% endif %}     
Hello, {{user.nickname}}!
 

現在我們的模板檔案有點智能了。如果我們在視圖函數中忘了定義頁面標題變數 title，它將會使用自已的標題替代。把視圖函數中 render_template 裡的 title 變數取消試試，看看這個 if 流程語句是如何工作的。

模板中使用迴圈

也許使用者想在他的首頁上展示好友最近寫的文章，有點像人人，或者新浪微博那樣的社交動向更新，接下來我們就要看看如何來完成這個功能。

首先，建立使用者和文章 (fileapp/views.py):

def index():  user = { 'nickname': 'Miguel' } # fake user  posts = [ # fake array of posts    {      'author': { 'nickname': 'John' },      'body': 'Beautiful day in Portland!'    },    {      'author': { 'nickname': 'Susan' },      'body': 'The Avengers movie was so cool!'    }  ]  return render_template("index.html",    title = 'Home',    user = user,    posts = posts)

用數組儲存使用者的文章，每一個數組元素都是一個字典，如上代碼所示，這個dict的key是author和body，用來儲存文章的作者和文章內容。當我們決定使用資料庫來儲存這些資訊時，這個字典的key可以隱射為表的一個欄位，這裡為了給大家示範模板的使用，沒有使用資料庫相關的技術，簡單地使用字典和數組類比使用者和他的好友最近發表的文章。

我們的模板檔案現在有了一個新問題。我們剛剛建立了一個包含使用者文章的內容資料，這個數組可能包含任意數量的文章。怎樣才能讓模板根據這個數組的數量自動渲染內容。

要解決這個問題，就需要一個新的流程式控制制語句：for迴圈。讓我們來把 for迴圈添加到模板檔案 (fileapp/templates/index.html)

   {% if title %}  {{title}} - microblog  {% else %}  microblog  {% endif %}    
Hi, {{user.nickname}}!
  {% for post in posts %}  
{{post.author.nickname}} says: {{post.body}}
  {% endfor %} 

很簡單吧，你還可以在數組中添加更多的內容看看效果。

模板繼承

接來下，我們需要給這個微博(microblog)添加一個導覽功能表，裡麵包含 修改設定檔，退出登入 等類似的連結。

直接在 index.html 模板檔案中直接加入這個導航條也是可行的，但是當我們有很多模板檔案都包含這個導航條時，就會陷入為了修改導航條的某個地方而不得不在多個檔案中往返編輯的尷尬境地。當包含這個導航條的檔案越來越多時，你想死的心就會有了。

我們可以使用 Jinja2 的模板繼承功能，它可以使我們把模板中一些公用的內容組合在一起建立一個基礎模板，然後讓其它模板繼承這個基礎模板。

我們先來定義一個基礎模板，裡麵包含了導航條和那個最開始寫的關於頁面標題(title)的流程式控制制語句。(fileapp/templates/base.html):

   {% if title %}  {{title}} - microblog  {% else %}  microblog  {% endif %}    Microblog: Home    {% block content %}{% endblock %} 

在這個模板中，我們使用了 block 控制語句來定義繼承模板內容的顯示位置。注意：這個 block 語句中設定的名稱必須唯一。

接下來讓我們修改一下 index.html 模板，讓它繼承於剛剛添加的基礎模板 base.html (fileapp/templates/index.html):

{% extends "base.html" %}{% block content %}
Hi, {{user.nickname}}!
{% for post in posts %}
{{post.author.nickname}} says: {{post.body}}
{% endfor %}{% endblock %}

基礎模板 base.html 幫我們搞定了頁面結構和公用內容，所以這個 index.html 模板就成了這幅衰樣了。extends 語句使兩個模板關聯了起來。Jinja2 在渲染 index.html 模板時，發現 extends 語句，就會自動先引入 base.html 基礎模板，並對兩個模板中名為 content 的 block 語句進行匹配。Jinja2知道如何把兩個模板合并到一起。我們以後建立新的模板時，同樣也會使用這種從基礎模板繼承的方法。

結束語

如果你想節省時間，懶得敲代碼，可以從以下地址下載本章內容的範例程式碼：

下載地址：microblog-0.2.zip

