Jinja2模板引擎设计思路源于Django的模板引擎,并扩展了语法和一些列强大的功能,其中最重要的是增加了沙箱执行功能和可选的自动转义功能,这对应用的安全来说非常重要,此外还有一些特性:
- 沙箱执行模式:模板的每个部分都在引擎的监督之下执行,模板将会被明确地标记在白名单或黑名单内,这样对于不信任的模板也可以执行
- 强大的自动HTML转义系统,可以有效地阻止跨站脚本攻击
- 模板继承机制,此机制可以使得所有模板具有相似一致的布局,也方便开发人员对模板进行修改和管理
- 高效的执行效率,Jinja2引擎在第一次加载时就把源码转换成python字节码,加快模板执行时间
- 调试系统融合了标准的python的TrackBack功能,使得模板编译和运行期间的错误能及时地被发现和调试
- 语法设置,可以重新配置Jinja2,使得他更好的适应LaTeX或JS的输出
- 有官方指导手册
安装与配置
安装可以使用pip安装,也可以在网站下载
完成后在项文件夹下(与settings.py一个文件夹)创建jinja2.py文件(该文件名没有固定要求),在这个文件中定义函数environment,并进行实例化,代码如下
from django.contrib.staticfiles.storage import staticfiles_storage
from django.urls import reverse
from jinja2 import Environment
# 将jinja2模版设置到项目环境
def environment(**options):
env = Environment(**options)
env.globals.update({
'static': staticfiles_storage.url,
'url': reverse,
})
return env
下一步在settings.py对应位置加入:
TEMPLATES = [
# 使用Jinja2模版引擎
{
'BACKEND': 'django.template.backends.jinja2.Jinja2',
'DIRS': [
os.path.join(BASE_DIR, 'templates'),
],
'APP_DIRS': True,
'OPTIONS': {
'environment': 'MyDjango.jinja2.environment'
},
},
# 使用Django的模版引擎
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [],
'APP_DIRS': True,
'OPTIONS': {'context_processors': [
'django.template.context_processors.debug',
'django.template.context_processors.request',
'django.contrib.auth.context_processors.auth',
'django.contrib.messages.context_processors.messages',
], },
},
]
即可完成模板引擎配置。
模板语法
Jinja2是基于Django模板引擎设计的,并提供了官方的文档用于查看https://www.w3cschool.cn/yshfid/也有中文文档用于查询。
示例代码如下:
base.html
<!DOCTYPE html>
<html>
<head>
{% block title %}{% endblock %}
</head>
<body>
{% block body %}{% endblock %}
</body>
</html>
index.html
{#模版继承#}
{% extends "base.html" %}
{% block title %}
{#static标签#}
{#Django的用法:{% static 'favicon.ico' %}#}
<link rel="icon" href="{{ static('favicon.ico') }}">
<title>Jinja2</title>
{% endblock %}
{% block body %}
{#使用上下文#}
{#Django的用法:{{ value.name }}#}
{#Jinja2除了支持Django的用法,还支持以下用法#}
<div>{{ value['name'] }}</div>
{#使用过滤器#}
<div>{{ value['name'] | replace('Jinja2','Django') }}</div>
{#for循环#}
{#Django的用法:{% for k,v in value.items %}#}
{% for k,v in value.items() %}
<div>key is {{ k }}</div>
<div>value is {{ v }}</div>
{% endfor %}
{#if判断#}
{% if value %}
<div>This is if</div>
{% else %}
<div>This is else</div>
{% endif %}
{#url标签#}
{#Django的用法:{% url 'index:index' %}#}
<a href="{{ url('index:index') }}">首页</a>
{% endblock %}
同样Jinja2也可以自定过滤器:代码示例如下:
项目的jinja2.py
from django.contrib.staticfiles.storage import staticfiles_storage
from django.urls import reverse
from jinja2 import Environment
def myReplace(value, old='Jinja2', new='Django'):
return str(value).replace(old, new)
# 将jinja2模版设置到项目环境
def environment(**options):
env = Environment(**options)
env.globals.update({
'static': staticfiles_storage.url,
'url': reverse,
})
env.filters['myReplace'] = myReplace
return env
HTML文件:
<!DOCTYPE html>
<html>
<body>
<div>
{{ value.name | myReplace }}
</div>
<div>
{{ value.name | myReplace('This', 'That') }}
</div>
</body>
</html>