3.1 Jinja2模板引擎

模板

模板是包含响应文本的文件，其中包含用占位变量表示的动态部分，其具体值只在请求的上下文中才能知道。

使用真实值替换变量，再返回最终得到的响应字符串，这一过程称为渲染。

为了渲染模板，Flask 使用一个名为 Jinja2 的强大模板引擎。

Jinja2模板引擎

形式最简单的 Jinja2 模板就是一个包含响应文本的文件。

示例 3-1　templates/index.html：Jinja2 模板

<h1>Hello World!</h1>

示例 3-2　templates/user.html：Jinja2 模板

<h1>Hello, {{ name }}!</h1>

渲染模板

默认情况下，Flask 在应用目录中的 templates 子目录里寻找模板。

你需要新建 templates 子目录，再把前面定义的模板保存在里面，分别命名为 index.html 和 user.html。

应用中的视图函数需要修改一下，以便渲染这些模板。修改方法参见示例 3-3。

示例 3-3　hello.py：渲染模板

from flask import Flask, render_template

# ...

@app.route('/')
def index():
    return render_template('index.html')

@app.route('/user/<name>')
def user(name):
    return render_template('user.html', name=name)

Flask 提供的 render_template() 函数把 Jinja2 模板引擎集成到了应用中。这个函数的第一 个参数是模板的文件名，随后的参数都是键 – 值对，表示模板中变量对应的具体值。在这段代码中，第二个模板收到一个名为 name 的变量。

前例中的 name=name 是经常使用的关键字参数，如果你不熟悉的话，可能不知所云。左边 的 name 表示参数名，就是模板中使用的占位符；右边的 name 是当前作用域中的变量，表示同名参数的值。两侧使用相同的变量名是很常见，但不是强制要求。

变量

示例 3-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 }}

表3-1：Jinja2变量过滤器

过滤器名 说明
safe 渲染值时不转义
capitalize 把值的首字母转换成大写，其他字母转换成小写
lower 把值转换成小写形式
upper 把值转换成大写形式
title 把值中每个单词的首字母都转换成大写
trim 把值的首尾空格删掉
striptags 渲染之前把值中所有的 HTML 标签都删掉

safe 过滤器值得特别说明一下。默认情况下，出于安全考虑，Jinja2 会转义所有变量。

例如，如果一个变量的值为 '<h1>Hello</h1>'，Jinja2 会将其渲染成 '&lt;h1&gt;Hello&lt;/ h1&gt;'，浏览器能显示这个 h1 元素，但不会解释它。

很多情况下需要显示变量中存储的 HTML 代码，这时就可使用 safe 过滤器。

完整的过滤器列表可在 Jinja2 文档（http://jinja.pocoo.org/docs/2.10/templates/#builtin-filters） 中查看。

控制结构

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>

基模板中定义的区块可在衍生模板中覆盖。Jinja2 使用 block 和 endblock 指令在基模板中 定义内容区块。在本例中，我们定义了名为 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 个区块被重新定义，模板引擎会将其插入适当的位置。

如果基模板和衍生模板中的同名区块中都 有内容，衍生模板中的内容将显示出来。

在衍生模板的区块里可以调用 super()，引用基 模板中同名区块里的内容。上例中的 head 区块就是这么做的。

《基于Python的Web应用开发实战(第二版)》

posted @ 2019-01-07 11:16  °❆黄雷❄°  阅读(111)  评论(0)  编辑  收藏  举报