Python模板引擎Jinja2库的功能介绍、使用和代码示例

原创 于 2025-09-11 17:10:59 发布 · 1k 阅读 · 19 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#python #开发语言 #flask #pip #beautifulsoup #django #fastapi

文章目录

Jinja2 是一个功能强大的 Python 模板引擎，由 Flask 作者 Armin Ronacher 开发，广泛用于 Web 开发（如 Flask、FastAPI 等框架）和文档生成场景。它支持变量替换、控制结构（条件判断、循环）、模板继承、宏定义等高级功能，语法简洁直观，兼具灵活性和安全性。

一、Jinja2 核心特点

  1. 强大的变量处理：支持访问字典、列表、对象属性，甚至调用函数/方法。
  2. 丰富的控制结构：提供 if-else 条件判断、for 循环等，逻辑处理灵活。
  3. 模板复用机制：通过 继承（extends）、包含（include）、宏（macro） 实现模板模块化。
  4. 安全特性：默认自动转义 HTML 特殊字符，防止 XSS 攻击。
  5. 可扩展性：支持自定义过滤器（Filters）、测试器（Tests）和全局函数。

二、安装与基本概念

安装

pip install jinja2  # 支持 Python 3.6+

核心概念

  • 模板（Template）：包含固定内容和动态占位符的文本文件（如 HTML、Markdown 等）。
  • 上下文（Context）：传递给模板的变量/数据集合（字典形式）。
  • 环境（Environment）：Jinja2 的核心对象，管理模板加载、配置（如自动转义、变量分隔符等）。
  • 加载器（Loader）：负责从文件系统、字符串或其他来源加载模板（常用 FileSystemLoader 从本地文件加载）。

三、基础用法：从模板到渲染

Jinja2 的核心流程是：创建环境 → 加载模板 → 传递上下文 → 渲染输出。

1. 最小示例：字符串模板渲染

from jinja2 import Template

# 1. 定义模板字符串（包含动态变量 {{ name }}）
template_str = "Hello, {{ name }}! You are {{ age }} years old."

# 2. 创建模板对象
template = Template(template_str)

# 3. 传递上下文数据（字典形式）并渲染
result = template.render(name="Alice", age=30)

print(result)  # 输出：Hello, Alice! You are 30 years old.

2. 从文件加载模板（常用场景）

实际开发中，模板通常存储在文件中（如 templates 目录），需通过 FileSystemLoader 加载。

项目结构
myproject/
├── app.py          # 主程序
└── templates/      # 模板目录
    └── greeting.html  # 模板文件

app.py文件代码

from jinja2 import Environment, FileSystemLoader
import os

# 1. 配置环境：指定模板目录（绝对路径更可靠）
template_dir = os.path.join(os.path.dirname(__file__), "templates")
env = Environment(loader=FileSystemLoader(template_dir))  # 用FileSystemLoader加载文件

# 2. 加载模板文件（templates/greeting.html）
template = env.get_template("greeting.html")

# 3. 定义上下文数据
context = {
    "user": {"name": "Bob", "hobbies": ["reading", "coding", "hiking"]},
    "is_member": True
}

# 4. 渲染模板
html_output = template.render(**context)

# 打印结果或写入文件
print(html_output)
with open("output.html", "w", encoding="utf-8") as f:
    f.write(html_output)

templates/greeting.html文件代码

<!DOCTYPE html>
<html>
<head>
    <title>Greeting</title>
</head>
<body>
    <h1>Hello, {{ user.name }}!</h1>  <!-- 访问对象属性/字典值 -->
    
    {% if is_member %}  <!-- 条件判断 -->
        <p>Welcome back, member!</p>
    {% else %}
        <p>Please sign up to become a member.</p>
    {% endif %}
    
    <p>Your hobbies:</p>
    <ul>
        {% for hobby in user.hobbies %}  <!-- 循环遍历列表 -->
            <li>{{ loop.index }}. {{ hobby }}</li>  <!-- loop.index 是循环索引（从1开始） -->
        {% endfor %}
    </ul>
</body>
</html>
渲染输出（简化）
<!DOCTYPE html>
<html>
<head><title>Greeting</title></head>
<body>
    <h1>Hello, Bob!</h1>
    <p>Welcome back, member!</p>
    <p>Your hobbies:</p>
    <ul>
        <li>1. reading</li>
        <li>2. coding</li>
        <li>3. hiking</li>
    </ul>
</body>
</html>

四、核心语法与特性

1. 变量与数据访问

模板中通过 {{ 变量名 }} 引用上下文数据，支持多种数据类型：

数据类型模板中访问方式示例（上下文：{"user": {"name": "Alice"}, "scores": [90, 85]}）
字典/对象属性{{ dict.key }} 或 {{ obj.attr }}{{ user.name }} → “Alice”
列表/元组{{ list[index] }}{{ scores[0] }} → 90
函数/方法调用{{ func() }} （需在上下文定义函数）上下文含 {"add": lambda a,b: a+b} → {{ add(2,3) }} → 5

2. 控制结构

条件判断（if-elif-else）
{% if score >= 90 %}
    <p>优秀</p>
{% elif score >= 60 %}
    <p>及格</p>
{% else %}
    <p>不及格</p>
{% endif %}
循环（for）
<!-- 遍历列表，使用 loop 变量获取循环信息 -->
<ul>
    {% for item in items %}
        <li>
            {{ loop.index }}. {{ item }}  <!-- loop.index：从1开始的索引 -->
            {% if loop.first %}（第一个）{% endif %}
            {% if loop.last %}（最后一个）{% endif %}
        </li>
    {% else %}  <!-- 列表为空时执行 -->
        <li>无数据</li>
    {% endfor %}
</ul>

3. 模板继承（extends 与 block）

模板继承是实现模板复用的核心机制，通过 extends 继承父模板，用 block 重写父模板的可变部分。

父模板（templates/base.html）
<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>{% block title %}默认标题{% endblock %}</title>  <!-- 可被重写的块 -->
    <style>
        {% block style %}{% endblock %}  <!-- 样式块 -->
    </style>
</head>
<body>
    <header>网站头部</header>
    <main>
        {% block content %}{% endblock %}  <!-- 内容块（核心可变部分） -->
    </main>
    <footer>网站底部</footer>
</body>
</html>
子模板（templates/home.html）
{% extends "base.html" %}  <!-- 继承父模板 -->

{% block title %}首页{% endblock %}  <!-- 重写标题块 -->

{% block style %}  <!-- 重写样式块 -->
    main { color: #333; }
{% endblock %}

{% block content %}  <!-- 重写内容块 -->
    <h2>欢迎来到首页</h2>
    <p>这是首页的具体内容</p>
{% endblock %}
渲染子模板
# 代码中加载子模板，会自动应用父模板结构
template = env.get_template("home.html")
print(template.render())

4. 包含其他模板（include）

通过 include 可将一个模板嵌入到另一个模板中（适合复用小片段，如导航栏、广告位）。

被包含的模板（templates/nav.html）
<nav>
    <a href="/">首页</a>
    <a href="/about">关于</a>
</nav>
在其他模板中包含
<!-- 在 base.html 中包含导航 -->
<body>
    {% include "nav.html" %}  <!-- 嵌入导航模板 -->
    <main>{% block content %}{% endblock %}</main>
</body>

5. 宏（macro）：模板中的“函数”

宏用于定义可复用的代码片段（类似函数），支持参数传递，适合生成重复 HTML 结构（如表格行、按钮）。

{# 定义宏（可放在单独的 macros.html 中，通过 include 引入） #}
{% macro button(text, type="primary") %}
    <button class="btn btn-{{ type }}">
        {{ text }}
    </button>
{% endmacro %}

{# 使用宏 #}
{{ button("提交") }}  <!-- 生成：<button class="btn btn-primary">提交</button> -->
{{ button("取消", type="danger") }}  <!-- 生成：<button class="btn btn-danger">取消</button> -->

6. 过滤器（Filters）：处理变量

过滤器用于对变量进行格式化或转换，语法：{{ 变量 | 过滤器名(参数) }}。Jinja2 内置多种过滤器，也支持自定义。

常用内置过滤器

| 过滤器 | 功能示例（{{ value | 过滤器 }}） |
|----------------|-----------------------------------------------------------|
| upper | 转为大写："hello" → "HELLO" |
| lower | 转为小写："HELLO" → "hello" |
| capitalize | 首字母大写："hello" → "Hello" |
| truncate(n) | 截断字符串到 n 长度："hello world" | truncate(5) → "hello..." |
| join(sep) | 拼接列表：[1,2,3] | join(",") → "1,2,3" |
| default(val) | 变量为 None 时用默认值：undefined_var | default("默认") |
| safe | 标记为安全内容（关闭自动转义）："<h1>hi</h1>" | safe |

示例
<p>大写：{{ "hello" | upper }}</p>  <!-- 输出：大写：HELLO -->
<p>列表拼接：{{ [1,2,3] | join("-") }}</p>  <!-- 输出：列表拼接：1-2-3 -->
<p>默认值：{{ user.nickname | default("匿名用户") }}</p>
自定义过滤器
from jinja2 import Environment, FileSystemLoader

# 1. 定义自定义过滤器：将字符串反转
def reverse_filter(s):
    return s[::-1]

# 2. 在环境中注册过滤器
env = Environment(loader=FileSystemLoader("templates"))
env.filters["reverse"] = reverse_filter  # 注册名为 reverse 的过滤器

# 3. 模板中使用（templates/filter_demo.html）
# {{ "hello" | reverse }} → "olleh"
template = env.get_template("filter_demo.html")
print(template.render())

7. 安全与自动转义

Jinja2 默认会自动转义 HTML 特殊字符（如 < 转为 &lt;），防止 XSS 攻击。若需关闭转义（如变量包含可信 HTML），可使用 safe 过滤器：

{# 自动转义（安全） #}
{{ "<script>alert('xss')</script>" }}  
<!-- 输出：&lt;script&gt;alert(&#39;xss&#39;)&lt;/script&gt; -->

{# 关闭转义（仅用于可信内容） #}
{{ "<h1>安全HTML</h1>" | safe }}  
<!-- 输出：<h1>安全HTML</h1> -->

五、与 Web 框架集成（以 Flask 为例）

Flask 内置 Jinja2 作为模板引擎，无需额外配置即可使用，默认模板目录为 templates。
app.py文件代码

from flask import Flask, render_template

app = Flask(__name__)

@app.route('/>')
def user_profile(name):
    # 传递上下文数据到模板
    user_data = {
        "name": name,
        "age": 28,
        "skills": ["Python", "Flask", "Jinja2"]
    }
    # 渲染 templates/profile.html 模板
    return render_template("demo.html", user=user_data)

if __name__ == '__main__':
    app.run(debug=True)

templates/demo.html文件代码

<h1>{{ user.name }}的个人资料</h1>
<p>年龄：{{ user.age }}</p>
<p>技能：</p>
<ul>
    {% for skill in user.skills %}
        <li>{{ skill }}</li>
    {% endfor %}
</ul>

六、高级技巧

1. 模板缓存

生产环境中，可启用模板缓存（默认关闭）提升性能：

env = Environment(
    loader=FileSystemLoader("templates"),
    auto_reload=False,  # 关闭自动重载（生产环境）
    cache_size=400  # 缓存模板数量
)

2. 全局变量与函数

通过 env.globals 注册全局变量或函数，在所有模板中可用：

# 注册全局函数
def current_time():
    from datetime import datetime
    return datetime.now().strftime("%Y-%m-%d")

env = Environment(loader=FileSystemLoader("templates"))
env.globals["current_time"] = current_time  # 模板中可直接用 {{ current_time() }}

3. 测试器（Tests）

测试器用于判断变量是否满足特定条件（语法：{{ 变量 is 测试器 }}），如 defined（是否定义）、none（是否为 None）：

{% if user is defined %}
    <p>用户已定义</p>
{% endif %}

{% if message is none %}
    <p>无消息</p>
{% endif %}

七、总结

Jinja2 凭借其简洁的语法、强大的复用机制和安全特性，成为 Python 生态中最流行的模板引擎之一。核心优势包括：

  • 模板继承：通过 extends 和 block 实现页面结构复用，减少重复代码。
  • 灵活的数据处理：支持多种数据类型访问和过滤器转换。
  • 安全性：默认自动转义，防止 XSS 攻击。
  • 框架兼容性：无缝集成 Flask、FastAPI 等主流 Web 框架。

无论是 Web 页面渲染、邮件模板生成还是静态站点构建，Jinja2 都是高效且可靠的选择。

Python-Jinja2是纯Python的模板引擎
08-10
Jinja2是纯Python的模板引擎，它提供了Django启发的非XML语法，但支持内联表达式和可选的沙盒环境。
python 利用jinja2模板生成html代码实例
09-18
1. Jinja2模板引擎的介绍及其在Python中的应用。 2. 如何使用FileSystemLoader加载模板文件。 3. 如何定义函数，使用Environment对象渲染模板并生成HTML代码。 4. 如何计算文件操作的进度并在控制台中动态显示。 ...
Python 功能强大且灵活的模板引擎Jinja2模块
weixin_54217348的博客
03-17 2065
Jinja2是一个功能强大且易于使用的Python模板引擎，它解析并渲染模板文件，结合变量和逻辑控制结构，生成动态文本输出，如HTML或XML。其灵活性和扩展性使其成为Web开发中的理想选择。
Python模块学习 - jinja2
anhuoqiu1787的博客
01-08 2097
模板 　　要了解jinja2，那么需要先理解模板的概念。模板在Python的web开发中广泛使用，它能够有效的将业务逻辑和页面逻辑分开，使代码可读性增强、并且更加容易理解和维护。 　　模板简单来说就是一个其中包涵占位变量表示动态的部分的文件，模板文件在经过动态赋值后，返回给用户。 --> 可以理解为渲染 　　python中自带一个简单的模板，就是string提供的。 ...
Jinja2，一个有趣的 Python 库！
涛哥聊Python
02-23 2226
Jinja2 是一个用于 Python 的模板引擎，它允许开发人员将动态数据插入到模板中，生成最终的输出。它的语法简洁清晰，易于学习和使用，因此受到了广泛的欢迎。变量插值：可以在模板中插入变量，并在生成输出时将其替换为实际值。条件语句：可以使用条件语句（如ifelse）在模板中执行不同的操作。循环：支持循环结构，可以对列表、字典等数据进行迭代。模板继承：可以定义模板块，并在多个模板中重复使用这些块。本文深入介绍了 Jinja2 模板引擎，并提供了多个实际应用场景的示例代码。
Jinja2 —— 超级模板 Python 库
Python栈_基的博客
02-26 1649
Jinja2[1] 是一款强大的 Python 模板引擎，它将模板语言的灵活性与 Python 代码的强大功能完美结合，达成了既易于阅读和维护又具有高效执行能力的平衡。由于它的设计十分现代化和模块化，Jinja2 成为许多 Python Web 框架的首选模板引擎。如果你熟悉 Django 的模板系统，会发现 Jinja2 的语法非常相似，但它提供了更多的灵活性和更强大的工具包。与Django 的模板系统比较起来，Jinja2 更加重视灵活性，并包含如宏、包含和导入等高级模板功能。
Django使用Jinja2模板引擎的示例代码
09-18
接下来将详细介绍Django使用Jinja2模板引擎的过程和示例代码。 首先，要在Django项目中使用Jinja2，需要安装Jinja2库。通过Python的包管理工具pip，可以轻松地进行安装。具体操作如下： ``` pip install Jinja2 ``...
Python的Flask框架中的Jinja2模板引擎学习教程
09-21
需要注意的是，Jinja2模板中的`if`和`for`语句不像Python代码那样依赖缩进来确定代码块的范围，它们必须显式地使用`{% endif %}`和`{% endfor %}`来关闭。 总的来说，Jinja2模板引擎为Flask提供了强大的模板渲染...
为Python的Tornado框架配置使用Jinja2模板引擎的方法
09-21
因此，开发者经常选择集成更强大且更易用的Jinja2模板引擎。 安装Jinja2非常简单，只需通过Python的包管理工具pip执行以下命令： ``` pip install jinja2 ``` 一旦Jinja2安装完毕，我们就可以开始将其与Tornado进行...
Python-JinjaSQL使用Jinja模板生成SQL
08-10
JinjaSQL：使用Jinja模板生成SQL，而不用担心SQL注入
Python Jinja2模块
taopad的博客
09-18 1943
JInja2模块Jinja2介绍Jinja2语法jinja2变量jinja2过滤器控制结构if语句for循环宏继承如有错误，请指正 Jinja2介绍 jinja2是Flask作者开发的一个模板系统，起初是仿django模板的一个模板引擎，为Flask提供模板支持，由于其灵活，快速和安全等优点被广泛使用。 测试是否安装有jinja2模块： import jinja2 如果没有利用pip进行下载： pip3 install jinja2 Jinja2语法 jinja2模板的基本语法： 控制结构 {% %}
python--Jinja2
最新发布
zhao的博客
08-30 538
一个非常强大的模板引擎，常用于 Python 的 Web 开发中。它允许你将 HTML、XML 或其他文本格式与动态数据结合起来，来生成动态内容。jinja2模板包含变量，表达式，标签。变量和表达式在模板求值的时候会被替换为值，标签可以控制模板的逻辑。模板语法来源与Django和python。
python jinja2_Python jinja2
weixin_33610780的博客
01-28 905
jinja2语法基本语法在jinja2中，存在三种语法：控制结构 {% %}变量取值 {{ }}注释 {# #}下面是一个简单的jinja2例子{#This is jinja code{% for file in filenames %}...{% endfor %}#}可以看到，for循环的使用方式和Python比较类似，但是没有了句尾的冒号，另外需要使用endfor最为结尾，其实在jinja2...
python模板语言_jinja模板语言
weixin_35899324的博客
02-10 434
模板要了解jinja2，那么需要先理解模板的概念。模板在Python的web开发中广泛使用，它能够有效的将业务逻辑和页面逻辑分开，使代码可读性增强、并且更加容易理解和维护。模板简单来说就是一个其中包涵占位变量表示动态的部分的文件，模板文件在经过动态赋值后，返回给用户。 --> 可以理解为渲染python中自带一个简单的模板，就是string提供的。>>> importstr...
Python 模板 Jinja2
weixin_30819085的博客
06-07 1148
Python 模板 Jinja2 模板 要了解Jinja2，就需要先理解模板的概念。模板在Python的web开发中广泛使用，它能够有效的将业务逻辑和页面逻辑分开，使代码可读性更强、更加容易理解和维护。模板简单来说就是一个包含占位变量表示动态部分的文件，模板文件在经过动态赋值后，返回给用户(可理解为渲染)。Python中自带一个简单的模板，就是string提供的： >>&gt...
HTML模版渲染-Jinja2
晴天的博客
05-17 2656
HTML模版渲染-Jinja2
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值