Django零基础入门之自定义标签及模板中的使用

承接前文《Django零基础入门之自定义过滤器及模板中的使用》，本节重点讲解Django中自定义标签的创建与使用方法。

自定义标签概述

首先从源码层面解析simple_tag的实现机制：

def simple_tag(self, func=None, takes_context=None, name=None):
    """
    Register a callable as a compiled template tag. Example:

    @register.simple_tag
    def hello(*args, **kwargs):
        return 'world'
    """

该函数主要包含三个核心参数：

1. func：指代被编译的Python函数，即实际执行逻辑的主体；
2. takes_context：用于控制是否允许标签访问模板上下文，具体用法将在后续章节展开；
3. name：功能与自定义过滤器中的filter()函数参数name一致，用于指定标签在模板中的调用名称。

第一部分：基础自定义标签

本节演示如何快速创建一个基础的自定义标签。

在模板中调用自定义标签并传递参数是常见需求。

我们将通过自定义标签实现一个功能：按照datetime模块指定的格式输出当前时间。

（1）视图函数编写：

文件路径：ceshi/views.py

（2）模板文件编写：

文件路径：templates/ceshi/test1.html

（3）自定义标签的具体实现：

文件路径：ceshi/templatetags/common_extras.py 其中format_string参数用于接收前端模板通过标签传递的格式化字符串。

（4）运行效果展示：

第二部分：中级自定义标签（上下文感知）

本节深入讲解源码参数takes_context的用法，并演示如何在不显式传递参数的情况下实现第一部分的功能。

takes_context是一个布尔值，默认设为False。当将其设置为True时，标签可以直接访问视图函数传递给模板的context上下文对象，从而获取其中的变量。

（1）视图函数编写：

文件路径：ceshi/views.py

（2）模板文件编写：

此时在模板中调用自定义标签无需携带额外参数，因为所需数据已从上下文中直接获取。 文件路径：templates/ceshi/test1.html

（3）自定义标签实现：

文件路径：ceshi/templatetags/common_extras.py

第三部分：高级自定义标签（包含标签）

本节介绍自定义包含标签（Include Tag）的使用方法。

包含标签的核心功能是渲染另一个模板文件以展示特定数据，常用于封装重复的UI结构。

例如，当多处代码结构相似（如for循环内的列表渲染），仅变量名（如choices）不同时，可将这部分代码封装为包含标签，以提高代码复用性。

<ul>
    {% for i in choices %}
        <li>{{ i }}</li>
    {% endfor %}
</ul>

这类似于函数封装，将大量重复性工作打包，调用时直接引用即可。

（1）定义存放功能代码的模板文件test01.html：

文件路径：templates/ceshi/test01.html

<ul>
    {% for i in choices %}
        <li>{{ i }}</li>
    {% endfor %}
</ul>

（2）定义包含标签：

• 装饰器传递的参数为显示数据的目标模板文件路径；
• 最后return返回一个字典对象，包含渲染模板所需的上下文变量。

（3）模板调用方式：

（4）运行效果展示：

至此，关于Django自定义标签及其在模板中应用的教程已结束。如需了解更多Django自定义标签相关内容，建议查阅本站历史文章或继续阅读后续系列，感谢支持！