Django模板层——三种自定义模板simple_tag、inclusion_tag、filter的用法

[1. 前言](#1. 前言)

[2. 前置操作](#2. 前置操作)

[3. simple_tag](#3. simple_tag)

[3.1 注意点](#3.1 注意点)

[4. inclusion_tag](#4. inclusion_tag)

[5. filter](#5. filter)

[6. 结尾](#6. 结尾)

1. 前言

在前后端不分离的模式中，Django的模板语法尤为重要，我们可以动态传入变量，并在前端HTML中进行展示。在变量展示时，会有一些内置的过滤器和方法，但这远远不能满足我们的需求。因此，在Django模板中，还有三大自定义的常用模板：simple_tag、inclusion_tag、filter ，能在开发中，为我们省去很多麻烦。

我将通过实际案例 的方式，引出自定义模板的用法。

2. 前置操作

注册app

先注册好需要使用的app：

我这里用app01来进行演示

在视图中定义好返回的HTML

创建templatetags文件夹

我们需要先创建templatetags文件夹，并放入我们自定义的模板函数，这样做是为了保证Django能够更好的管理他们，并且在后续引入模块的时候，直接去templatetags中找。

注意：templatetags是需要放在应用程序app下的，Django默认去app下寻找

建立自己的自定义模块

这里的名字可以随意

注册自定义模板标签

实例化Library对象，用于注册自定义模板标签 ，以至于Django能够使用这些标签

python 复制代码

from django.template.library import Library

register = Library()

3. simple_tag

simple_tag是Django自定义模板中的一个装饰器 ，主要用于字符串 的处理，可以定义一个接受参数并返回字符串的自定义标签。

我们还是从需求出发：

需求：在页面中实时刷新显示当前时间（简单一点，刷新之后，动态显示时间）

我们可以自定义我们的时间格式：

python 复制代码

import datetime

from django.template.library import Library

register = Library()


@register.simple_tag()
def my_func(format_string):
    return datetime.datetime.now().strftime(format_string)

html 复制代码

{% load test_tag %}
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
当前日期时间： {% my_func "%Y-%m-%d %H:%M:%S" %}

</body>
</html>

最终显示：

刷新后：

3.1 注意点

如果你在代码执行时，遇到了这个报错：

django.template.exceptions.TemplateSyntaxError: '####' is not a registered tag libr...

并且，你的代码没有任何问题，你只需要重新启动Django程序，清理缓存就好了。

4. inclusion_tag

inclusion_tag主要用于复用模板，如果在多个页面都需要使用同一段HTML代码，这个时候，复用就会使得代码变得更加简洁。

需求：使用列表展示信息

python 复制代码

@register.inclusion_tag("user.html")
def my_xo(num):
    return {"x1": [item for item in num]}

user.html

html 复制代码

<ul>
    {% for item in x1 %}
        <li>{{ item }}</li>
    {% endfor %}
</ul>

view.py

python 复制代码

def test(request):
    return render(request, 'test.html', {'num': ['王者荣耀', '原神', '和平精英']})

调用：

html 复制代码

{% load test_tag %}
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
当前日期时间： {% my_func "%Y-%m-%d %H:%M:%S" %}

展示列表：
{% my_xo num %}

</body>
</html>

结果：

5. filter

Django 模板系统中的一个过滤器，用于在模板中对变量进行简单的处理和过滤。过滤器可以用于修改变量的显示方式、筛选列表、格式化数据等。

需求：页面展示标题，最长10个字，超出打自定义传入的符号

test_tag.py

python 复制代码

@register.filter
def my_filter(x1, sign):
    return x1[:10] + sign

test.html

html 复制代码

{% load test_tag %}
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
当前日期时间： {% my_func "%Y-%m-%d %H:%M:%S" %}

展示列表：
{% my_xo num %}


标题：
{{ '我爱玩原神，那么，原神启动！'|my_filter:'...' }}

</body>
</html>

展示：

6. 结尾

有关Django模板层中三种自定义模板标签就介绍到这里了。

利用这些自定义标签，在我们日后的开发中能省却很多代码量，大多都是重复的。

这会让我们的代码更加具有可复用性。