第四章 前端模板（web UI)

模板是一个包含响应文本的文件，其中包含用占位变量表示的动态部分，其具体值只在请求的上下文中才能知道。使用真实值替换变量，再返回最终得到的响应字符串，这一过程称为渲染。为了渲染模板，Flask使用了一个名为Jinja2的强大模板引擎。

4.1 Jinja2模板引擎

模板可以生成任何基于文本的格式（HTML、XML、CSV、LaTex 等等）。它并没有特定的扩展名， .html或 .xml都是可以的。

模板包含 变量 或 表达式 ，这两者在模板求值的时候会被替换为值。模板中 还有标签，控制模板的逻辑。模板语法的大量灵感来自于 Django 和 Python 。

下面是一个最小的模板，它阐明了一些基础。我们会在文档中后面的部分解释细节:

 
   
     
   
    
      

        {% for item in navigation %}
          
{{ item.caption }}
        {% endfor %}
      
 
      
藕丝空间欢迎您！ 
      {{ a_variable }} 
    
 

这里有两种分隔符: {% ... %}和 {{ ... }}。前者用于执行诸如 for 循环 或赋值的语句，后者把表达式的结果打印到模板上。

4.1.1 模板变量

在模板中使用的{{ a }}结构表示一个变量,它是一种特殊的占位符,告诉模板引擎这个位置的值从渲染模板时使用的数据中获取。Jinja2 能识别所有类型的变量,甚至是一些复杂的类型,例如列表,字典和对象。在模板中使用的变量一些示例如下:

 一个字典变量:{{ mydict['key'] }}。
 一个列表变量:{{ mylist['index'] }}。
 一个列表变量,并且带有索引:{{ mylist['myintvar] }}。
 一个对象变量:{{ myobj.somemethod() }}。

4.1.2 过滤器

变量可以通过 过滤器 修改。过滤器与变量用管道符号（ |）分割，并且也 可以用圆括号传递可选参数。多个过滤器可以链式调用，前一个过滤器的输出会被作为 后一个过滤器的输入。

例如 {{ name|striptags|title }}会移除 name中的所有 HTML 标签并且改写 为标题样式的大小写格式。过滤器接受带圆括号的参数，如同函数调用。这个例子会把一个列表用逗号连接起来: {{ list|join(', ') }}。

下表列出了 Jinja2 提供的部分常用过滤器

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

safe 过滤器值要特别说明一下。默认情况下,出于安全考虑,Jinja2 会转义所有变量。例如,如果一个变量值为

Hello

,Jinja2 会将其渲染成<h1>Hello</h1>浏览器能显示这个 h1 元素,但不进行解释。很多情况下需要显示变量中存储的 HTML 代码,这时就可以使用 safe 过滤器。

4.1.3 注释

要把模板中一行的部分注释掉，默认使用 {# ... #} 注释语法。这在调试或 添加给你自己或其它模板设计者的信息时是有用的:

{# note: disabled template because we no longer use this
   {% for user in users %}
       ...     
   {% endfor %}
#}

4.1.4 空白控制

默认配置中，模板引擎不会对空白做进一步修改，所以每个空白（空格、制表符、换行符 等等）都会原封不动返回。如果应用配置了 Jinja 的 trim_blocks，模板标签后的 第一个换行符会被自动移除（像 PHP 中一样）。

此外，你也可以手动剥离模板中的空白。当你在块（比如一个 for 标签、一段注释或变 量表达式）的开始或结束放置一个减号（ -），可以移除块前或块后的空白:

{% for item in seq -%}
  {{ item }} 
{%- endfor %}

这会产出中间不带空白的所有元素。如果 seq是 1到 9的数字的列表， 输出会是123456789。

如果开启了 行语句 ，它们会自动去除行首的空白。

提示:
标签和减号之间不能有空白。

有效的:

 {%- if foo -%}
     ...
 {% endif %}

无效的:

 {% - if foo - %}
     ...
 {% endif %}

4.1.5 转义

有时想要或甚至必要让 Jinja 忽略部分，不会把它作为变量或块来处理。例如，如果 使用默认语法，你想在在使用把 {{作为原始字符串使用，并且不会开始一个变量 的语法结构，你需要使用一个技巧。

最简单的方法是在变量分隔符中（ {{）使用变量表达式输出:

{{ '{{' }}
对于较大的段落，标记一个块为 raw是有意义的。例如展示 Jinja 语法的实例， 你可以在模板中用这个片段:

{% raw %}
  

    {% for item in seq %}
       
{{ item }}
    {% endfor %}
  
 
{% endraw %}

4.1.6 行语句

如果应用启用了行语句，就可以把一个行标记为一个语句。例如如果行语句前缀配置为 #，下面的两个例子是等价的:

 # for item in seq
   
{{ item }}
 # endfor 
 

 {% for item in seq %}
    
{{ item }}
 {% endfor %} 

行语句前缀可以出现在一行的任意位置，只要它前面没有文本。为了语句有更好的可读 性，在块的开始（比如 for、 if、 elif等等）以冒号结尾:

# for item in seq:
  ... 
# endfor

提示:

若有未闭合的圆括号、花括号或方括号，行语句可以跨越多行:

   # for href, caption in [('index.html', 'Index'),
               ('about.html', 'About')]:
      
{{ caption }}
   # endfor 

从 Jinja 2.2 开始，行注释也可以使用了。例如如果配置 ##为行注释前缀， 行中所有 ##之后的内容（不包括换行符）会被忽略:

# for item in seq:
 
{{ item }}
   ## this comment is ignored 
# endfor

4.1.7 控制结构

Jinja2提供了多种控制结构，可用来改变模板的渲染流程。

条件控制语句：

{% if user %}
   你好， {{ user }}!
{% endif %} 

循环控制语句及宏(宏类似于Python代码中的函数)：

{% macro render_comment(comment) %}
   
{{ comment }}
{% endmacro %}

   {% for comment in comments %}
     {{ render_comment(comment) }}
   {% endfor %}

在一个 for 循环块中你可以访问这些特殊的变量:

变量	描述
loop.index	当前循环迭代的次数（从 1 开始）
loop.index0	当前循环迭代的次数（从 0 开始）
loop.revindex	到循环结束需要迭代的次数（从 1 开始）
loop.revindex0	到循环结束需要迭代的次数（从 0 开始）
loop.first	如果是第一次迭代，为 True 。
loop.last	如果是最后一次迭代，为 True 。
loop.length	序列中的项目数。
loop.cycle	在一串序列间期取值的辅助函数。见下面的解释。

在 for 循环中，可以使用特殊的 loop.cycle 辅助函数，伴随循环在一个字符串/变 量列表中周期取值:

{% for row in rows %}
   
{{ row }}
{% endfor %}

重复使用宏的方法：

{% import 'macros.html' as macros %}
 

    {% for comment in comments %}
       {{ macros.render_comment(comment) }} 
    {% endfor %}
 

4.1.8 模板继承

类似于Python代码中的类继承。首先创建一个名为base.html的基模板：

    
    {% block head %}
        
    {% endblock %}
    
    
       {% block body %}
       {% endblock %}
    

基模板的衍生模板：

 {% extends 'base.html' %}
 {% block title %}首页{% endblock %}
 {% block head %}
     {{ super() }} 
     
 {% endblock %}
 {% block body %}
     
你好，世界！
 {% endblock %}

extents指令声明这个模板衍生自base.html。在extents指令之后，基模板中的3个块被重新定义，模板引擎会将其插入适当的位置。super()函数用来获取基模板原来的内容。

4.2 在程序中配置bootstrap模板

要想在程序中集成Bootstrap，显然要对模板做必要的改动。有一个更简单的方法是使用一个名为Flask-Bootstrap的Flask扩展，简化集成过程。

(flask)$ pip install flask-bootstrap

不过由于上述插件功能有限，推荐使用自己配置的Bootstrap模板。

将bootstrap模板中的核心css文件 bootstrap.min.css 和主题css文件bootstrap-theme.mim.css复制到 静态文件夹static 的 static/css文件夹里，同时将字体文件复制到static/fonts文件夹里；将jquery核心js文件jquery.min.js和bootstrap的js文件bootstrap.min.js文件复制到static/js文件夹里。同时，你可以将自己的个性化模板所用用到的css和js文件复制到相应的文件夹里。

4.3 渲染模板

默认情况下,Flask 在程序文件夹中的 templates 子文件夹中寻找模板。在下一个hello.py版本中，要把已定义的模板保存在templates文件夹中，并分别命名为index.html和user.html。
示例 4-2 hello.py：渲染模板

 from flask import Flask, render_template
 # …
 @app.route('/')
 def index():
     return render_template('index.html')
 @app.route('/user/')
 def user(name):
     return render_template('user.html', name=name)

Flask提供的render_template函数把Jinja2模板引擎集成到了程序中。render_template函数第一个参数是模板的文件名。随后的参数都是键值对，表示模板中变量对应的真实值。

启动你的项目：

(flask)$ python hello.py

这时你应该可以看到你自己的网页了。

最后，请发挥你的想象力，利用bootstrap的前端技术，来充分个性化你的页面吧。