# ch03 · 模板：Jinja2 语法、继承、宏、过滤器

> 来源：教材配套 PPT《第三章 模板.pptx》，共 47 页。本节只摘录**知识点与关键文字**，图取自 PPT 原页。

## 第 1 页 · 讲师：谢福财

- 讲师：谢福财
- Flask课程——
- **第三章**
- 模板

![第1页图](media/ch03/slide01_img1.png)

## 第 2 页 · 了解静态网页与动态网页的区别

- 了解静态网页与动态网页的区别
- 掌握Jinja2模板引擎的使用方法
- 掌握Flask-Bootstrap的使用方法
- 学习目标

![第2页图](media/ch03/slide02_img1.png)

## 第 3 页 · Flask-Bootstrap

- Flask-Bootstrap
- 模板简介
- Jinja2模板引擎
- 小结

## 第 4 页 · 模板简介

- 模板简介
- 01

## 第 5 页 · 概念解释

- 概念解释
- 什么是模板？
- 模板是一种通用的布局或结构，用于创建多个具有相似风格和功能的内容。在计算机编程和设计领域，模板是一个预定义的框架，其中包含了一些固定的元素、样式、格式或占位符，以便在特定场景中填充内容。使用模板可以帮助保持一致性、提高效率，并降低开发的重复性。简单来说的话，模板的作用是内容注入、页面继承与包含。

## 第 6 页 · Jinja2模板引擎

- Jinja2模板引擎
- 02

## 第 7 页 · 概念解释

- 概念解释
- jinja2模板引擎是什么？
- Jinja2 是一个流行的 Python 模板引擎，用于在 Python 应用程序中生成动态内容。模板引擎是一种将数据和模板结合，生成最终输出的工具。Jinja2 允许开发者将动态数据嵌入到静态模板中，以生成 HTML、XML、JSON 等格式的输出。

## 第 8 页 · 安装依赖

- 安装依赖
- 我们在第一章的时候，已经把Jinja2模板一同下载了下来，如果有不清楚的话，可以打开cmd(命令提示符)，输入代码：pip install jinja2==2.11.3
- 在使用模板时，所有静态资源应放置在“static”资源目录下，而模板页面应放置在“templates”模板目录下。
- 我们要遵循一个思路，每当写一个模板页面，都要写他对应的视图函数，不然写了的页面就没法被浏览到。

## 第 9 页 · Jinja2模板引擎

- Jinja2模板引擎
- 我们来举一个简单的例子，首先在“templates”模板目录下创建一个模板页面文件，如下图所示。

![第9页图](media/ch03/slide09_img1.png)

## 第 10 页 · Jinja2模板引擎

- Jinja2模板引擎
- 然后在视图函数里面的代码如下所示。
- from flask import Flask, render_template
- @app.route('/value')
- def value(username=None):
- return render_template('value.html')
- render_template用于渲染模板文件
- 然后下面就是渲染名为 'value.html' 的模板文件，并将渲染后的内容返回给用户的浏览器。效果如下图所示。

![第10页图](media/ch03/slide10_img1.png)

## 第 11 页 · 基本语法

- 基本语法
- 以下是3种基本语法，在接下来的代码中将会经常出现。
- （1）“{% ... %}”为“控制”语句，常用于编写结构控制，定义模板、变量等。
- （2）“{{ ... }}”为“表达式”语句，常用于输出变量，调用宏指令、对象函数等。
- （3）“{# ... #}”为“注释”语句，用于添加代码注解。

## 第 12 页 · 基本语法

- 基本语法
- （1）“{{ ... }}”为“表达式”语句，常用于输出变量，调用宏指令、对象函数等。代码例子如下
- <!DOCTYPE html>
- <html>
- <head>
- <title>测试</title>
- </head>
- <body>
- <h1>Hello, {{ user }}</h1>
- <p>Your age is {{ age }}</p>
- </body>
- </html>
- 在这个示例中，使用表达式语句输出了 user 和 age 变量的值。

## 第 13 页 · 基本语法

- 基本语法
- （2）“{% ... %}”为“控制”语句，常用于编写结构控制，定义模板、变量等。代码例子如下
- <!DOCTYPE html>
- <html>
- <head>
- <title>测试</title>
- </head>
- <body>
- {% if user %}
- <h1>Hello, {{ user }}!</h1>
- {% else %}
- <h1>Welcome, Guest!</h1>
- {% endif %}
- </body>
- </html>
- 在这个示例中，根据 user 变量的值，使用控制语句实现了一个简单的条件语句。

## 第 14 页 · 基本语法

- 基本语法
- （3）“{# ... #}”为“注释”语句，用于添加代码注解。代码例子如下
- <!DOCTYPE html>
- <html>
- <head>
- <title>测试</title>
- </head>
- <body>
- <h1>Hello, {{ user }}</h1>
- {# 这是一个提示。下面会显示你的年龄 #}
- <p>Your age is ${{ age }}</p>
- </body>
- </html>
- 在这个示例中，使用注释语句添加了一个代码注解，不会在最终输出中显示

## 第 15 页 · 语法使用

- 语法使用
- 注释的使用方法和其他语言的注释用法一样，这里就略过注释用法，举例控制和表达式的使用方法。
- 表达式的用法，拿注入变量举例，首先得从视图函数注入变量，再将需要显示到页面的变量在模板文件中使用“表达式”语句输出变量。视图函数代码如下
- @app.route('/value')
- @app.route('/value/<string:username>')
- def value(username=None):
- return render_template('value.html', username=username)
- 表达式语句输入代码如下
- <!DOCTYPE html>
- <html lang="zh">
- <head>
- <meta charset="UTF-8">
- <title>注入变量</title>
- </head>
- <body>
- {# 在"表达式"语句中，可使用"or"为变量添加默认值 #}
- <h1>{{ username or '游客'}}</h1>
- <h2>欢迎使用！！！</h2>
- </body>
- </html>

## 第 16 页 · 语法使用

- 语法使用
- 效果如下图所示
- 无username的示例图
- 有username的示例图

![第16页图](media/ch03/slide16_img1.png)

![第16页图](media/ch03/slide16_img2.png)

## 第 17 页 · 语法使用

- 语法使用
- 控制用法，简单来说就像其他语言的if判断，举个文章列表的简单例子，也是先写视图函数，再写模板内容，视图函数代码如下。
- @app.route('/control')
- @app.route('/control/<int:num>')
- def control(num=0):
- # 此处使用 list 模拟文章列表
- articles = []
- for i in range(1, num + 1):
- articles.append({
- 'title': '文章%d标题' % i,
- 'content': ('文章%d的内容 ' % i) * i,
- })
- return render_template('control.html', num=num, articles=articles)

## 第 18 页 · 语法使用

- 语法使用
- 模板(control.html)的代码如下，可以看到这些语句与Python的控制语句相似，同时又类似于HTML标签，控制语句需要使用如“{% endxxx %}”的格式，对前面的语句进行闭合。
- <!DOCTYPE html>
- <html lang="zh">
- <head>
- <meta charset="UTF-8">
- <title>控制结构</title>
- </head>
- <body>
- <h1>文章列表</h1>
- {% if num <= 0 %}
- <h2>文章数量为0，没有内容可展示。</h2>
- {% else %}
- {% for article in articles %}
- <h2>{{ article.title }}</h2>
- <p>{{ article.content }}</p>
- {% endfor %}
- {% endif %}
- </body>
- </html>

## 第 19 页 · 语法使用

- 语法使用
- 效果图如下图所示。根据路径后面的参数，来改变效果

![第19页图](media/ch03/slide19_img1.png)

![第19页图](media/ch03/slide19_img2.png)

## 第 20 页 · 模板的包含与继承

- 模板的包含与继承
- 前文提到，模板可以用于解决公共内容的冗余问题。例如，将公共部分的内容分离到一个单独的文件，再将模板加载到需要使用的页面中。如果按这种模式进行开发，在修改公共部分内容时，仅需要修改公共部分内容所处的文件，即可修改所有使用公共部分内容的页面，大大缩短修改各个页面的时间
- 。

## 第 21 页 · 模板的包含与继承

- 模板的包含与继承
- 模板的包含：
- 模板的包含允许您将一个模板嵌入到另一个模板中，从而实现模块化和代码重用。这对于在多个页面中使用相同的组件或块非常有用。
- 假设我们有一个简单的 header.html 模板，表示网站的页头部分，代码如下。
- <!DOCTYPE html>
- <html>
- <head>
- <title>{{ title }}</title>
- </head>
- <body>
- <header>
- <h1>testTitle</h1>
- </header>
- </body>

## 第 22 页 · 模板的包含与继承

- 模板的包含与继承
- demo.html的代码如下
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="UTF-8">
- <title>Title</title>
- </head>
- <body>
- {% include 'header.html' %}
- <p>Welcome to our website!</p>
- </body>
- </html>
- {% include 'header.html' %}这句代码就是代表着我们可以在不同的页面中引用这个页头部分。

## 第 23 页 · 模板的包含与继承

- 模板的包含与继承
- 效果如下图所示。这便是模板的包含。

![第23页图](media/ch03/slide23_img1.png)

## 第 24 页 · 模板的包含与继承

- 模板的包含与继承
- 模板的继承：
- 模板的继承允许我们创建一个基础模板（称为父模板），定义其中的共同结构和占位符，然后创建子模板来填充实际内容。
- 假设我们有一个简单的 base.html 模板，表示父模板，代码如下。
- <!DOCTYPE html>
- <html>
- <head>
- <title>{% block title %}Default Title{% endblock %}</title>
- </head>
- <body>
- <header>
- <h1>{% block header %}Default Header{% endblock %}</h1>
- </header>
- <main>
- {% block content %}{% endblock %}
- </main>
- </body>
- </html>

## 第 25 页 · 模板的包含与继承

- 模板的包含与继承
- 然后创建一个子模版来填充具体内容，同时覆盖掉父模板的内容，代码如下
- {% extends 'base.html' %}
- {% block title %}Page Title{% endblock %}
- {% block header %}Welcome to My Site{% endblock %}
- {% block content %}
- <p>This is the main content of the page.</p>
- <p>Additional content goes here.</p>
- {% endblock %}
- {% extends 'base.html' %}这个就是用来继承我们的父模板在子模版使用，通过这种方式，我们可以将页面的结构和内容分开，使代码更加模块化和易于维护。父模板定义了整体结构，而子模板填充了特定内容。

## 第 26 页 · 模板的包含与继承

- 模板的包含与继承
- 效果如下图所示。

![第26页图](media/ch03/slide26_img1.png)

## 第 27 页 · 宏指令

- 宏指令
- 我们前面碰到的基本都是需要多次修改的静态内容，总不能想改动东西就天天去修改源码，那么如果我们想动态实现添加，删除，那该怎么办呢，我们就迎来一个新的概念，宏指令。
- 比方说，我们要做一个常见的任务，比如创建一个 HTML 按钮，但稍后可能会用到不止一次。在这种情况下，我们可以使用 Jinja2 的宏来实现这一点。
- 拿文章的增加和删除举例。我们按照视图函数，然后再写页面的思路来写，视图函数的代码如下。
- @app.route('/macro')
- @app.route('/macro/<int:num>')
- def macro(num=0):
- # 此处使用 list 模拟文章列表
- articles = []
- for i in range(1, num + 1):
- articles.append({
- 'title': '文章%d标题' % i,
- 'content': ('文章%d的内容 ' % i) * i,
- })
- return render_template('macro.html', num=num, num_prev=num - 1, num_next=num + 1, articles=articles)

## 第 28 页 · 宏指令

- 宏指令
- 宏指令(macro_define.html)文件代码如下。
- {% macro article_item(title, content) %}
- <h2>{{ title }}</h2>
- <p>{{ content }}</p>
- {% endmacro %}
- {% macro article_list(articles, article_num) %}
- {% if article_num <= 0 %}
- <h2>文章数量为0，没有内容可展示。</h2>
- {% else %}
- {% for article in articles %}
- {{ article_item(article.title, article.content) }}
- {% endfor %}
- {% endif %}
- {% endmacro %}

## 第 29 页 · 宏指令

- 宏指令
- 使用宏代码(macro.html)网页文件代码如下。
- {# 宏指令可以定义在单独的文件，然后被其他文件所引入 #}
- {% import 'macro_define.html' as macro %}
- {% block title %}
- 宏指令
- {% endblock %}
- {% block inner_content %}
- {# 宏指令的使用方法类似于函数 #}
- {{ macro.article_list(articles, num) }}
- {% if num > 0 %}
- <a href="{{ url_for('macro', num=num_prev) }}" class="btn btn- primary">-1</a>
- {% endif %}
- <a href="{{ url_for('macro', num=num_next) }}" class="btn btn- primary">+1</a>
- {% endblock %}

## 第 30 页 · 宏指令

- 宏指令
- 效果如下图所示。
- 可以看到，写好了宏，就只需要在网页去点击就能进行增加和删除内容，只需调用宏，而不必重复编写网页代码。

![第30页图](media/ch03/slide30_img1.png)

![第30页图](media/ch03/slide30_img2.png)

![第30页图](media/ch03/slide30_img3.png)

## 第 31 页 · 注册全局对象

- 注册全局对象
- 在 Jinja2 模板引擎中，有的时候可以通过函数调用来获取数据，但是在继承的模板里面，如果需要调用某个固定的函数，通常需要在每一个使用被继承模板的视图函数中注入相应的函数（变量），但这显然不是推荐的操作方法。这时，需要注册全局对象。
- 用到的函数是:app.add_template_global(需要注册的函数名，’别名’)。例子代码如下图所示。
- 视图代码如下：
- # 注册全局对象的类型不限，可以是任何类型（函数亦可）
- def range_list(x):
- # 该函数生成了数量为 x 的 int list（从 0 开始）
- return list(range(x))
- # 将函数注册到全局对象中
- app.add_template_global(range_list, 'global_test')
- @app.route('/global')
- def global_():
- return render_template('global.html')

## 第 32 页 · 注册全局对象

- 注册全局对象
- 模板文件代码如下：
- {% block title %}注册全局对象{% endblock %}
- {% block inner_content %}
- {# 此处将数字列表输出到页面中 #}
- {{ global_test(10) }}
- {% endblock %}
- 效果如下图所示。

![第32页图](media/ch03/slide32_img1.png)

## 第 33 页 · 变量过滤器

- 变量过滤器
- 变量过滤器是 Jinja2 中一种用于在模板中对变量进行修改或格式化的功能。您可以使用过滤器对变量进行操作，使其适应您的需求，如格式化日期、将文本转换为大写、截取字符串等。
- 这个用到的函数：app.add_ template_filterer(‘过滤器名称’)，视图函数代码如下：
- import time
- def convert_time(t):
- return time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(t))
- # 注册模板变量过滤器
- app.add_template_filter(convert_time)
- @app.route('/demo')
- def global_():
- return render_template('demo.html')

## 第 34 页 · 变量过滤器

- 变量过滤器
- 页面代码(demo.html)如下：
- {# 自定义变量过滤器，时间可通过time.time()获取 #}
- <p>{{ 1572497288.095447 | convert_time }}</p>
- 效果如下图所示：

![第34页图](media/ch03/slide34_img1.png)

## 第 35 页 · Flask-Bootstrap

- Flask-Bootstrap
- 03

## 第 36 页 · 概念解释

- 概念解释
- Flask-Bootstrap是什么？
- 前面的内容中提到了Bootstrap前端框架，同时也通过手动引用、构建模板的方式，使用了Bootstrap框架。而在快速开发场景中，这种从零开始配置的方式并不适用。Flask-Bootstrap提供了一系列的基本模板，包含对资源的引用、一些快捷宏指令等。

## 第 37 页 · Flask-Bootstrap

- Flask-Bootstrap
- 安装Flask-Bootstrap的方式和之前一样，打开命令提示符输入以下代码
- pip install flask-bootstrap==3.3.7
- 安装成功如下图所示

![第37页图](media/ch03/slide37_img1.png)

## 第 38 页 · 使用方法

- 使用方法
- 首先需要引入Flask-Bootstrap包中的Bootstrap类，然后在应用初始化之后，对Bootstrap实例进行初始化。代码如下
- from flask import Flask, render_template
- from flask_bootstrap import Bootstrap
- app = Flask(__name__)
- # flask_bootstrap 初始化代码
- bootstrap = Bootstrap()
- bootstrap.init_app(app)
- # 使用本地资源，禁用cdn
- bootstrap_cdns = app.extensions['bootstrap']['cdns']
- bootstrap_cdns['bootstrap'] = bootstrap_cdns['local']
- bootstrap_cdns['jquery'] = bootstrap_cdns['local']

## 第 39 页 · 使用方法

- 使用方法
- 视图函数代码如下
- @app.route('/bootstrap')
- def bootstrap_flask():
- return render_template('bootstrap_flask.html')

## 第 40 页 · 使用方法

- 使用方法
- 由于我们的模板文件代码继承了bootstrap的模板，为方便使用（定制），我们在Python安装目录/site-packages/flask_bootstrap/ templates”中找到需要用的模板文件复制到当前项目。如下图所示。

![第40页图](media/ch03/slide40_img1.png)

![第40页图](media/ch03/slide40_img2.png)

## 第 41 页 · 使用方法

- 使用方法
- 模板文件(bootstrap_flask.html)代码如下
- {% extends 'bootstrap/base.html' %}
- {% block title %}Flask Bootstrap{% endblock %}
- {% block navbar %}
- {% include 'include_nav.html' %}
- {% endblock %}
- {% block content %}
- <div class="container">
- <p>flask_bootstrap提供了一些基本的模板，可以省去从零编写模板页的过程。</p>
- <p>flask_bootstrap同时还提供了 flask_wtf 表单生成的宏指令（后续讲解）。</p>
- </div>
- {% endblock %}

## 第 42 页 · 使用方法

- 使用方法
- 效果就如下图所示。

![第42页图](media/ch03/slide42_img1.png)

## 第 43 页 · 使用方法

- 使用方法
- Flask-Bootstrap提供了常用的基础模板，在开发过程中使用这些模板，可节省编写基础模板的时间。
- Flask-Bootstrap提供的基准模板（base.html）定义了一些常用区块，通常情况下，只要继承基准模板，并重写区块，便可以满足大部分的需求。基准模板中定义的一些常用区块，如下表所示。

## 第 44 页 · 课后小结

- 课后小结
- 04

## 第 45 页 · 小结

- 小结
- 1、Jinja2模板引擎提供了很简洁、方便的模板语法，使模板编写、维护变得简单。使用模板进行开发，将所有公共部分分离，可减少大部分重复性的工作。
- 2、Flask-Boostrap简化了将 Bootstrap 整合到 Flask 应用中的过程，提供了一致的界面和响应式设计，同时还保留了定制性和灵活性，使我们能够轻松构建 Web 界面。

## 第 46 页 · 课后作业

- 课后作业
- 今日作业
- 课后习题3.5
- 创建一个 Flask 应用。
- 使用模板继承，创建一个基础模板（父模板）和一个或多个子模板。父模板包含网页的通用结构，子模板填充特定内容。
- 在父模板中创建一个宏指令，用于显示页面的页头。
- 在子模板中通过模板继承和宏指令，创建一个具有不同内容的网页。

## 第 47 页 · 谢谢聆听

- 谢谢聆听
