Flask和Django,以及其它很多Python框架,都默認使用Jinja2
來作爲模版引擎。
在Python中,什麼是模版?就是在一個靜態HTML加入一些類似變量的標籤,然後引擎在渲染這個HTML時候會動態的把變量填入內容,生成一個最終的HTML。
什麼是模版引擎?其實就是一種能解析類似Python語言
的標記語言的解釋器。
比如我們在HTML模版中輸入一個<p> {{ post.title }} </p>
,顯然這不是真正的HTML語法。但是當Jinja2解釋器讀取到{{ ...}}
後知道里面是一個變量,那麼就把這個變量替換爲真正的值,最後翻譯出來就變成了<p> 大標題 </p>
這樣的HTML內容。
Jinja2是一個模版語言,只是類似Python,比較符合Python語法,但不完全相同!
所有的模版引擎,實際上都差不多,不管是基於VBS語言的ASP模版,還是基於PHP語言的PHP模版,都不是與原本語言一摸一樣,而只是做到儘量一樣而已。
Jinja2語言基礎
注意:Jinja2
模版語言,是不區分縮進的,和純python不同。實際上所有模版語言都不區分縮緊。
常用標記:
- 註釋:
{# 這是註釋 #}
- 變量:
{{ post.title }}
,或字典元素{{your_dict['key']}}
,或列表{{your_list[0]}}
- 多行代碼塊:
{% 開始 %} HTML標籤 {% 結束 %}
示例:
{% if user %}
{{ user }}
{% else %}
hello!
{% for index in indexs %}
{{ index }}
{% endfor %}
Jinja2 Filter 過濾器 (即函數)
一個filter過濾器的本質就是一個function函數。使用格式爲:變量名 | 函數
。
它做到的就是,把變量傳給函數,然後再把函數返回值作爲這個代碼塊的值。
如:
<!-- 帶參數的 -->
{{變量 | 函數名(*args)}}
<!-- 不帶參數可以省略括號 -->
{{變量 | 函數名}}
鏈式調用(管道式):
和命令行的pipline管道一樣,可以一次調用多個函數(過濾器),如:
{{ "hello world" | reverse | upper }}
文本塊調用(將中間的所有文字都作爲變量內容傳入到過濾器中):
{% filter upper %}
一大堆文字
{% endfilter %}
Jinja2常用內置函數(過濾器)
字符串操作:
safe:禁用轉義
<p>{{ '<em>hello</em>' | safe }}</p>
capitalize:把變量值的首字母轉成大寫,其餘字母轉小寫
<p>{{ 'hello' | capitalize }}</p>
lower:把值轉成小寫
<p>{{ 'HELLO' | lower }}</p>
upper:把值轉成大寫
<p>{{ 'hello' | upper }}</p>
title:把值中的每個單詞的首字母都轉成大寫
<p>{{ 'hello' | title }}</p>
reverse:字符串反轉
<p>{{ 'olleh' | reverse }}</p>
format:格式化輸出
<p>{{ '%s is %d' | format('name',17) }}</p>
striptags:渲染之前把值中所有的HTML標籤都刪掉
<p>{{ '<em>hello</em>' | striptags }}</p>
truncate: 字符串截斷
<p>{{ 'hello every one' | truncate(9)}}</p>
列表操作:
first:取第一個元素
<p>{{ [1,2,3,4,5,6] | first }}</p>
last:取最後一個元素
<p>{{ [1,2,3,4,5,6] | last }}</p>
length:獲取列表長度
<p>{{ [1,2,3,4,5,6] | length }}</p>
sum:列表求和
<p>{{ [1,2,3,4,5,6] | sum }}</p>
sort:列表排序
<p>{{ [6,2,3,1,5,4] | sort }}</p>
Jinja2 Macro 宏 (自定義函數)
Jinja2是允許自定義函數的,這樣在模版中可以重複利用這個自定義函數。Jinja2稱之爲Macro
宏。
定義方法:
{% macro 函數名(參數) %}
具體的HTML內容
{% endmacro %}
<!-- 使用 -->
{{ 函數名(參數) }}
<!-- 或作爲過濾器 -->
{{ 變量 | 函數名(參數) }}
關於Jinja2自定義函數的context
上下文和環境變量的問題:
Jinja2的自定義函數“宏”,本身是沒法像filter過濾器函數一樣使用上下文和環境變量的。
不過可以加上@contextfilter
裝飾器達到同樣的效果。
導入另一個文件的自定義函數“宏”:
假設在macro.html
文件中我們定義了一個函數func()
。
那麼現在我們可以在另一個文件reference.html
中像python導入模塊一樣導入它:
{% import 'macro.html' as module %}
{{ module.func() }}
Include 模版引用
Include是我們常用的操作,即定義一個框架模版(父模版),然後一個一個指定性的把子模版引入進來。
框架模版frame.html
如下:
{% include 'header.html' %}
{% include 'body.html' %}
{% include 'footer.html' %}
Extend 模版繼承
我們可以在一個父模版中定義一個block
代碼塊,然後在另一個子模版中“繼承”這個父模版,並重寫這個block
代碼塊。
不過一般模版中的父模版,都只是留出一個block
空位,裏面不寫東西,特意等子模版來實現。
假設現在有一個父模版parent.html
:
{% block HEADER %}
頁頭部分的HTML內容。
{% endblock HEADER %}
{% block BODY %}
正文部分的HTML內容。
{% endblock BODY %}
{% block FOOTER %}
頁腳部分的HTML內容。
{% endblock FOOTER %}
其中定義了三個block,頁頭、正文和頁腳。
然後我們就可以定義一個模版child.html
來繼承父模版,並且只重寫BODY部分:
{% extends 'parent.html' %}
{% block BODY %}
由子頁面重寫改寫的的HTML內容,替換父頁面的BODY。。。
{% endblock BODY %}
擴展完成後,我們最終得到的結果是:
{% block HEADER %}
頁頭部分的HTML內容。
{% endblock HEADER %}
{% block BODY %}
由子頁面重寫改寫的的HTML內容,替換父頁面的BODY。。。
{% endblock BODY %}
{% block FOOTER %}
頁腳部分的HTML內容。
{% endblock FOOTER %}
Jinja2模版引用Flask路由中的內容
在Flask應用Jinja2模版時,在模版中可以直接調用Flask app中的一些公用變量和方法。
引用Flask的request
對象:
<p> {{ request.url }} </p>
<p> {{ request.form.get('name') }} </p>
引用Flask的url_for(...)
方法:
<!-- 它會返回我們定義的路由`app.route('/index')`所對應的URL -->
<p> {{ url_for('index') }} </p>
<!-- 它會返回我們定義的路由`app.route('/post/{post_id}')`所對應的URL -->
<p> {{ url_for('post', post_id='127') }} </p>
在模版中,我們可以引用get_flashed_messages()
方法,獲取Flask路由傳來的閃現信息
:
{% for msg in get_flashed_messages() %}
<p> {{ msg }} </p>
{% endfor %}
這種閃現信息是從Flask路由中傳來的,只要在路由中發一個flash('hello')
信息,相當於彈了一個alert()
。然後我們可以在Jinja2的模版中用get_flashed_messages()
獲得flash過來的信息列表。