Jinja2模板引擎
转载请在文章开头附上原文链接地址：https://www.cnblogs.com/Sunzz/p/10959471.html
Flask内置的模板语言，它的设计思想来源于 Django 的模板引擎，并扩展了其语法和一系列强大的功能。
渲染模版函数
- Flask提供的 render_template 函数封装了该模板引擎
- render_template 函数的第一个参数是模板的文件名，后面的参数都是键值对，表示模板中变量对应的真实值。
模板基本使用
- 在视图函数中设置渲染模板
from flask import Flask, render_template
@app.route('/')
def index():
return render_template('index.html')
- 在项目下创建
templates文件夹，用于存放所有的模板文件，并在目录下创建一个模板html文件index.html
Title
我的模板html内容
{{}} 来表示变量名，这种 {{}} 语法叫做变量代码块
视图代码：
@app.route("/")
def index():
title = "网页标题"
return render_template("index.html",title=title)
模板代码
{{title}}
{{title}}
Jinja2 模版中的变量代码块可以是任意 Python 类型或者对象，只要它能够被 Python 的 str() 方法转换为一个字符串就可以，比如，可以通过下面的方式显示一个字典或者列表中的某个元素:
{{your_dict['key']}}
{{your_list[0]}}
用 {%%} 定义的控制代码块，可以实现一些语言层次的功能，比如循环或者if语句
{% if user %}
{{ user }}
{% else %}
hello!
{% for index in indexs %}
- {{ index }}
{% endfor %}
使用 {# #} 进行注释，注释的内容不会在html中被渲染出来
{# {{ name }} #}
模板中特有的变量和函数
你可以在自己的模板中访问一些 Flask 默认内置的函数和对象
config
你可以从模板中直接访问Flask当前的config对象:
{{config.SQLALCHEMY_DATABASE_URI}}
sqlite:///database.db
request
就是flask中代表当前请求的request对象：
{{request.url}}
http://127.0.0.1
session
为Flask的session对象
{{session.new}}
True
g变量
在视图函数中设置g变量的 name 属性的值，然后在模板中直接可以取出
{{ g.name }}
url_for()
url_for会根据传入的路由器函数名,返回该路由对应的URL,在模板中始终使用url_for()就可以安全的修改路由绑定的URL,则不比担心模板中渲染出错的链接:
{{url_for('home')}}
如果我们定义的路由URL是带有参数的,则可以把它们作为关键字参数传入url_for(),Flask会把他们填充进最终生成的URL中:
{{ url_for('post', post_id=1)}}
/post/1
流程控制
主要包含两个：
- if/else if /else / endif
- for / endfor
if语句
Jinja2 语法中的if语句跟 Python 中的 if 语句相似,后面的布尔值或返回布尔值的表达式将决定代码中的哪个流程会被执行:
{%if user.is_logged_in() %}
Logout
{% else %}
Login
{% endif %}
过滤器可以被用在 if 语句中:
{% if comments | length > 0 %}
There are {{ comments | length }} comments
{% else %}
There are no comments
{% endif %}
循环语句
- 我们可以在 Jinja2 中使用循环来迭代任何列表或者生成器函数
{% for post in posts %}
{{ post.title }}
{{ post.text | safe }}
{% endfor %}
- 循环和if语句可以组合使用，以模拟 Python 循环中的 continue 功能，下面这个循环将只会渲染post.text不为None的那些post：
{% for post in posts if post.text %}
{{ post.title }}
{{ post.text | safe }}
{% endfor %}
- 在一个 for 循环块中你可以访问这些特殊的变量:
| 变量 | 描述 |
|---|---|
| loop.index | 当前循环迭代的次数（从 1 开始） |
| loop.index0 | 当前循环迭代的次数（从 0 开始） |
| loop.revindex | 到循环结束需要迭代的次数（从 1 开始） |
| loop.revindex0 | 到循环结束需要迭代的次数（从 0 开始） |
| loop.first | 如果是第一次迭代，为 True 。 |
| loop.last | 如果是最后一次迭代，为 True 。 |
| loop.length | 序列中的项目数。 |
| loop.cycle | 在一串序列间期取值的辅助函数。见下面示例程序。 |
- 在循环内部,你可以使用一个叫做loop的特殊变量来获得关于for循环的一些信息
- 比如：要是我们想知道当前被迭代的元素序号，并模拟Python中的enumerate函数做的事情，则可以使用loop变量的index属性,例如:
{% for post in posts%}
{{loop.index}}, {{post.title}}
{% endfor %}
- 会输出这样的结果
1, Post title
2, Second Post
- cycle函数会在每次循环的时候,返回其参数中的下一个元素,可以拿上面的例子来说明:
{% for post in posts%}
{{loop.cycle('odd','even')}} {{post.title}}
{% endfor %}
- 会输出这样的结果：
odd Post Title
even Second Post
过滤器
过滤器的本质就是函数。有时候我们不仅仅只是需要输出变量的值，我们还需要修改变量的显示，甚至格式化、运算等等，而在模板中是不能直接调用 Python 中的某些方法，那么这就用到了过滤器。
使用方式：
- 过滤器的使用方式为：变量名 | 过滤器。
{{variable | filter_name(*args)}}
- 如果没有任何参数传给过滤器,则可以把括号省略掉
{{variable | filter_name }}
- 如：``，这个过滤器的作用：把变量variable 的值的首字母转换为大写，其他字母转换为小写
在 jinja2 中，过滤器是可以支持链式调用的，示例如下：
{{ "hello world" | reverse | upper }}
常见的内建过滤器
字符串操作
- safe：禁用转义
{{ 'hello' | safe }}
- capitalize：把变量值的首字母转成大写，其余字母转小写
{{ 'hello' | capitalize }}
- lower：把值转成小写
{{ 'HELLO' | lower }}
- upper：把值转成大写
{{ 'hello' | upper }}
- title：把值中的每个单词的首字母都转成大写
{{ 'hello' | title }}
- reverse：字符串反转
{{ 'olleh' | reverse }}
- format：格式化输出
{{ '%s is %d' | format('name',17) }}
- striptags：渲染之前把值中所有的HTML标签都删掉
{{ 'hello' | striptags }}
- truncate: 字符串截断
{{ 'hello every one' | truncate(9)}}
列表操作
- first：取第一个元素
{{ [1,2,3,4,5,6] | first }}
- last：取最后一个元素
{{ [1,2,3,4,5,6] | last }}
- length：获取列表长度
{{ [1,2,3,4,5,6] | length }}
- sum：列表求和
{{ [1,2,3,4,5,6] | sum }}
- sort：列表排序
{{ [6,2,3,1,5,4] | sort }}
语句块过滤
{% filter upper %}
#一大堆文字#
{% endfilter %}
自定义过滤器
过滤器的本质是函数。当模板内置的过滤器不能满足需求，可以自定义过滤器。自定义过滤器有两种实现方式：
- 一种是通过Flask应用对象的 add_template_filter 方法
- 通过装饰器来实现自定义过滤器
重要：自定义的过滤器名称如果和内置的过滤器重名，会覆盖内置的过滤器。
需求：添加列表反转的过滤器
方式一
通过调用应用程序实例的 add_template_filter 方法实现自定义过滤器。该方法第一个参数是函数名，第二个参数是自定义的过滤器名称：
def do_listreverse(li):
# 通过原列表创建一个新列表
temp_li = list(li)
# 将新列表进行返转
temp_li.reverse()
return temp_li
app.add_template_filter(do_listreverse,'lireverse')
方式二
用装饰器来实现自定义过滤器。装饰器传入的参数是自定义的过滤器名称。
@app.template_filter('lireverse')
def do_listreverse(li):
# 通过原列表创建一个新列表
temp_li = list(li)
# 将新列表进行返转
temp_li.reverse()
return temp_li
- 在 html 中使用该自定义过滤器
my_array 原内容：{{ my_array }}
my_array 反转：{{ my_array | lireverse }}
- 运行结果
my_array 原内容：[3, 4, 2, 1, 7, 9]
my_array 反转：[9, 7, 1, 2, 4, 3]
模板继承
在模板中，可能会遇到以下情况：
- 多个模板具有完全相同的顶部和底部内容
- 多个模板中具有相同的模板代码内容，但是内容中部分值不一样
- 多个模板中具有完全相同的 html 代码块内容
像遇到这种情况，可以使用 JinJa2 模板中的 继承 来进行实现
模板继承是为了重用模板中的公共内容。一般Web开发中，继承主要使用在网站的顶部菜单、底部。这些内容可以定义在父模板中，子模板直接继承，而不需要重复书写。
- 标签定义的内容
{% block top %} {% endblock %}
- 相当于在父模板中挖个坑，当子模板继承父模板时，可以进行填充。
- 子模板使用 extends 指令声明这个模板继承自哪个模板
- 父模板中定义的块在子模板中被重新定义，在子模板中调用父模板的内容可以使用super()
父模板代码：
base.html
{% block top %}
顶部菜单
{% endblock top %}
{% block content %}
{% endblock content %}
{% block bottom %}
底部
{% endblock bottom %}
子模板代码：
- extends指令声明这个模板继承自哪
{% extends 'base.html' %}
{% block content %}
需要填充的内容
{% endblock content %}
模板继承使用时注意点：
- 不支持多继承
- 为了便于阅读，在子模板中使用extends时，尽量写在模板的第一行。
- 不能在一个模板文件中定义多个相同名字的block标签。
- 当在页面中使用多个block标签时，建议给结束标签起个名字，当多个block嵌套时，阅读性更好。
代码
config.py
class Config(object):
DEBUG = True
SECRET_KEY = "abcccddgadsag"
main.py
from flask import Flask
from config import Config
from flask import render_template
app = Flask(__name__,template_folder='templates')
app.config.from_object(Config)
from flask import session
@app.route("/set_session")
def set_session():
session["username"] = 'request数据'
return "ok"
from flask import g
@app.route("/")
def index():
title = "网页标题"
dict1 = {"id":1,"username":"xiaoming","money":20.5}
love = ['睡觉','吹牛','敲代码']
g.list1 = ['睡觉','吹牛','敲代码']
g.book_list = [
{"id":1,"name":"浪潮之巅","price":88.5},
{"id":12,"name":"数学之美","price":68.5},
{"id":12,"name":"数学之美","price":68.5},
{"id":12,"name":"数学之美","price":68.5},
{"id":13,"name":"硅谷之谜","price":108.533333},
{"id":14,"name":"五年高考三年模拟","price":78.5},
]
g.title2 = ''
g.question = '如果x=10,xz,求z的取值范围?'
return render_template("index.html",title=title,dict1=dict1,love=love)
"""自定义过滤器"""
def rev(data):
data.reverse()
return data
app.add_template_filter(rev,'myrev')
@app.route("/filter")
def myfilter():
g.list1 = ['睡觉', '吹牛', '敲代码']
return render_template("f.html")
if __name__ == '__main__':
app.run()
index.html
{{title}}
{{title}}
ID
姓名
存款
{{ dict1["id"] }}
{{ dict1["username"] }}
{{ dict1["money"] }}
{{ dict1.id }}
{{ dict1.username }}
{{ dict1.money }}
- {{ love.0 }}
- {{ love.1 }}
- {{ love.2 }}
- {{ love[0] }}
- {{ love[1] }}
- {{ love[2] }}
{# for循环也支持多层的嵌套或者其他语句 #}
{% for item in love %}
- {{ item }}
{% endfor %}
{# 这里是if判断,if还可以支持多个条件的判断 #}
{% if dict1.money < 20 %}
存款太少了,需要充值
{% endif %}
{# 特殊变量 #}
{# 支持直接读取配置信息 #}
{{ config.SECRET_KEY }}
{# 支持获取请求信息 #}
{{ request.method }}
{# 支持获取session数据 #}
{{ session.username }}
{# 支持获取g变量 #}
{{ g.list1 }}
{# 支持使用url_for生成地址 #}
跳转到sesion
{# for循环中还内置了循环对象loop,可以操作循环过程中的索引 #}
序号
ID
书名
价格
{% for book in g.book_list %}
{% if loop.first %}
{% elif loop.last %}
{% else %}
{% endif %}
{{ loop.revindex }}
{{ "%03d" % book.id }}
{{ book.name }}
{{ book.price }}
{% endfor %}
{# 过滤器 #}
{{ dict1.username | upper | reverse }}
{#
默认情况下, flask会自动针对html标签进行实体化转移,目的时为了防止xss攻击
但是,我们后端也会有一些包含样式的内容要输出页面中,此时可以使用 safe 过滤器
#}
{{ g.title2 | safe }}
{# 这个过滤器会直接删除html标签,也是为了防止xss攻击,但是这个过滤器慎用,在遇到数学公式的时候,会误伤. #}
{{ g.title2 | striptags }}
{{ g.question | striptags }}
{# 字符长度截取 #}
{{ 'hello every one' | truncate(9)}}
{% filter upper %}
dasdasd
dsa
das
ds
ad
{{ 'hello every one' | truncate(9)}}
asd
asdas
{% endfilter %}
{{ "hwello" }}
在 Flask 项目中解决 CSRF 攻击
在 Flask 中， Flask-wtf 扩展有一套完善的 csrf 防护体系，对于我们开发者来说，使用起来非常简单
1 设置应用程序的 secret_key，用于加密生成的 csrf_token 的值
# session加密的时候已经配置过了.如果没有在配置项中设置,则如下:
app.secret_key = "#此处可以写随机字符串#"
2 导入 flask_wtf.csrf 中的 CSRFProtect 类，进行初始化，并在初始化的时候关联 app
from flask.ext.wtf import CSRFProtect
CSRFProtect(app)
3 在表单中使用 CSRF 令牌: