Jinja2模板引擎使用指南

文章目录

- - 官网链接
  - 引言
  - Jinja2 原理
  - 基础使用
  - - 安装 Jinja2
    - 基本示例
  - 高级使用
  - - 宏（Macros）
    - 过滤器（Filters）
    - 继承（Inheritance）
  - 结论

官网链接

Jinja2 官网

引言

Jinja2 是一个现代的、设计师友好的模板引擎，用于 Python。它基于 Django 的模板系统，但更为灵活、功能丰富，并提供了完整的 Unicode 支持。Jinja2 被广泛应用于 web 开发中，尤其是在 Flask 和 Django 等 Python web 框架中作为模板渲染引擎。本文将详细介绍 Jinja2 的原理、基础使用以及高级特性。

Jinja2 原理

Jinja2 的核心在于其模板渲染机制。它允许开发者定义模板文件，这些文件包含了静态内容（如 HTML 标记）和动态内容（通过模板变量和表达式插入）。当模板被渲染时，Jinja2 会解析模板文件，替换其中的动态内容为实际的值，最终生成一个完整的、包含所有必要数据的输出文件（如 HTML 页面）。

Jinja2 提供了丰富的控制结构（如条件语句、循环等）和过滤器（用于格式化变量），使得模板文件的编写既灵活又强大。

基础使用

安装 Jinja2

首先，你需要安装 Jinja2。可以通过 pip 轻松安装：

pip install Jinja2

基本示例

from jinja2 import Template# 定义一个模板字符串
template_str = '''
<html>
<head><title>{{ title }}</title></head>
<body><h1>{{ greeting }} World!</h1><ul>{% for item in item_list %}<li>{{ item }}</li>{% endfor %}</ul>
</body>
</html>
'''# 创建模板对象
template = Template(template_str)# 渲染模板
rendered_template = template.render(title='Hello Jinja2',greeting='Hello',item_list=['Apple', 'Banana', 'Cherry']
)print(rendered_template)

高级使用

宏（Macros）

宏允许你在模板中定义可重用的代码块。它们类似于 Python 中的函数。

{% macro input(name, value='', type='text') %}<input type="{{ type }}" name="{{ name }}" value="{{ value|e }}" />
{% endmacro %}<form>{{ input('username') }}{{ input('password', type='password') }}
</form>

过滤器（Filters）

Jinja2 提供了许多内置过滤器，用于修改变量的输出。你也可以自定义过滤器。

{{ my_variable|upper }}  <!-- 将变量转换为大写 --># 自定义过滤器
@app.template_filter('reverse')
def reverse_filter(s):return s[::-1]{{ my_string|reverse }}  <!-- 调用自定义过滤器 -->

继承（Inheritance）

Jinja2 支持模板继承，这允许你构建一个基础模板，然后让其他模板继承并扩展这个基础模板。

<!-- base.html -->
<html>
<head>{% block head %}<title>{% block title %}{% endblock %} - My Webpage</title>{% endblock %}
</head>
<body><div id="content">{% block content %}{% endblock %}</div>
</body>
</html><!-- child.html -->
{% extends "base.html" %}{% block title %}Index{% endblock %}{% block content %}<p>This is the index page.</p>
{% endblock %}