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

让我们来详细讲解“Django零基础入门之自定义标签及模板中的使用”的完整攻略。

什么是Django自定义标签

Django中的自定义标签是一种扩展模板标签的功能，而这些标签提供了在模板中执行特定的功能，可以扩展Django的模板系统和标记语言。

如何定义自定义标签

1.定义标签函数

创建一个保存标签函数的Python模块，通常称为templatetags。其中，templatetags是一个存放自定义模板标签文件的文件夹。

在该文件夹中，创建一个文件your_tag_library.py，其中your_tag_library是自定义标签库的名称。在文件中定义一个函数，以对应自定义标签的功能和行为。例如：

from django import template

register = template.Library()

@register.simple_tag
def your_tag_name(param1, param2):
    # your tag function code goes here
    return some_output

注册自定义标签库

要在Django中使用自定义标签，需要将自定义标签库注册到Django中，可以在your_app中的__init__.py文件中进行注册。例如：

from django import template
from django.apps import AppConfig

class YourAppConfig(AppConfig):
    default_auto_field = 'django.db.models.BigAutoField'
    name = 'your_app'

    def ready(self):
        # register your custom tag library
        template.Library().loaders['app_directories']\
            .templates['your_tag_library'] = 'your_app/templatetags/your_tag_library.py'

使用自定义标签

在Django模板中使用自定义标签，需要在头部添加如下内容：

{% load your_tag_library %}

这将把your_tag_library中定义的自定义标签加载到模板中。

然后，在需要的地方使用自定义标签，例如：

{% your_tag_name param1 param2 %}

示例一：计算给定列表中数字的和

首先，在your_app文件夹中创建一个templatetags文件夹，然后在其中创建一个名为sum_tags.py的文件。

在sum_tags.py中创建一个名为sum的函数，用于计算给定列表中数字的和。

from django import template

register = template.Library()

@register.simple_tag
def sum(numbers):
    sum = 0
    for num in numbers:
        sum += num
    return sum

在__init__.py文件中注册自定义标签：

from django import template
from django.apps import AppConfig

class YourAppConfig(AppConfig):
    default_auto_field = 'django.db.models.BigAutoField'
    name = 'your_app'

    def ready(self):
        # register your custom tag library
        template.Library().loaders['app_directories']\
            .templates['sum_tags'] = 'your_app/templatetags/sum_tags.py'

在模板文件中使用自定义标签：

{% load sum_tags %}

The sum of [3,5,7,9] is {% sum [3,5,7,9] %}.

在浏览器中查看页面，会输出以下内容：

The sum of [3,5,7,9] is 24.

示例二：将字符转换为大写

创建一个string_tags.py文件，在其中创建一个uppercase函数，将给定字符串转换为大写。

from django import template

register = template.Library()

@register.filter(name='uppercase')
def uppercase(value):
    return value.upper()