Django 模板常用过滤器详解与源码分析

模板常用过滤器

在模板开发中，经常需要对原始数据进行预处理或格式化后才能展示。在Python后端逻辑中，这通常通过调用函数实现；而在Django模板中，则统一通过过滤器（Filter）来完成。过滤器的调用语法是使用竖线符号 | 进行连接。

add

该过滤器用于将传入的参数值与原值相加。其内部逻辑首先尝试将原值和参数转换为整数类型进行加法运算；若转换失败（例如遇到非数字字符串），则退化为字符串或列表的拼接操作。具体表现为：若两者均为字符串，则拼接为新的字符串；若均为列表，则合并为一个新列表。示例代码如下：

{{ value|add:"2" }}

当 value 的值为 4 时，执行 {{ value|add:"2" }} 的结果为 6。若 value 为普通字符串 'abc'，则结果为 'abc2'。以下是 add 过滤器的核心源码实现：

def add(value, arg):
    """Add the arg to the value."""
    try:
        return int(value) + int(arg)
    except (ValueError, TypeError):
        try:
            return value + arg
        except Exception:
            return ''

cut

此过滤器用于从原字符串中移除所有指定的子字符串，其功能类似于 Python 字符串方法 replace(args, "")。示例代码如下：

{{ value|cut:" " }}

上述示例将移除 value 中所有的空格字符。cut 过滤器的源码实现如下：

def cut(value, arg):
    """Remove all values of arg from the given string."""
    safe = isinstance(value, SafeData)
    value = value.replace(arg, '')
    if safe and arg != ';':
        return mark_safe(value)
    return value

date

该过滤器将日期对象按照指定的格式字符串转换为字符串输出。示例代码如下：

# 数据
context = {
    "birthday": datetime.now()
}

# 模版
{{ birthday|date:"Y/m/d" }}

执行后将输出 '2018/02/01'。其中，Y 代表四位数的年份，m 代表两位数的月份，d 代表两位数的日期。Django 支持更多时间格式化选项，具体对照下表：

default

当原值在布尔上下文中被评估为 False 时（例如空列表 []、空字符串 ""、None、空字典 {} 等），该过滤器将返回提供的默认值。示例代码如下：

{{ value|default:"nothing" }}

若 value 为空字符串 ""，上述代码将输出 'nothing'。

default_if_none

仅当原值严格等于 None 时，该过滤器才返回提供的默认值。这与 default 过滤器的区别在于：default 对所有 falsy 值均生效，而 default_if_none 仅对 None 值生效。示例代码如下：

{{ value|default_if_none:"nothing" }}

若 value 为空字符串 ""，上述代码将原样输出空字符串；仅当 value 为 None 时，才会输出 'nothing'。

first

用于获取列表、元组或字符串中的第一个元素。示例代码如下：

{{ value|first }}

若 value 为 ['a', 'b', 'c']，则输出结果为 'a'。

last

用于获取列表、元组或字符串中的最后一个元素。示例代码如下：

{{ value|last }}

若 value 为 ['a', 'b', 'c']，则输出结果为 'c'。

floatformat

该过滤器使用四舍五入规则格式化浮点数。若不传递参数，默认保留小数点后一位；若小数部分全为 0，则仅保留整数部分。若传递参数，则指定保留的小数位数。

未传递参数时的示例：

传递参数时的示例：

join

功能类似于 Python 的 join 方法，使用指定的分隔符将列表、元组或字符串中的元素拼接起来。示例代码如下：

{{ value|join:"/" }}

若 value 为 ['a', 'b', 'c']，上述代码将输出 'a/b/c'。

length

用于获取列表、元组、字符串或字典的长度。示例代码如下：

{{ value|length }}

若 value 为 ['a', 'b', 'c']，输出结果为 3。若 value 为 None，则返回 0。

lower

将字符串中的所有字符转换为小写。示例代码如下：

{{ value|lower }}

若 value 为 'Hello World'，则输出 'hello world'。

upper

功能与 lower 相反，将指定字符串中的所有字符转换为大写。

random

从给定的列表、字符串或元组中随机选择一个元素。示例代码如下：

{{ value|random }}

若 value 为 ['a', 'b', 'c']，上述代码将在列表中随机返回一个元素。

safe

标记字符串为安全内容，即关闭对该字符串的自动 HTML 转义。示例代码如下：

{{value|safe}}

若 value 是不包含特殊字符的普通字符串（如 '<a>' 这种非 HTML 标签文本），则正常输出。若 value 包含合法的 HTML 代码，则该代码将在浏览器中被渲染执行。

slice

功能类似于 Python 的切片操作。示例代码如下：

{{ some_list|slice:"2:" }}

上述代码将对 some_list 从索引 2 开始进行切片操作。

stringtags

注意：原文此处标题为 stringtags，但源码 a18 显示为 striptags，功能为删除字符串中所有的 HTML 标签。示例代码如下：

{{ value|striptags }}

若 value 为 '<strong>hello world</strong>'，则输出结果为 'hello world'。

truncatechars

若给定字符串长度超过过滤器指定的最大长度，则进行截断，并在末尾添加三个点（...）作为省略号。示例代码如下：

{{ value|truncatechars:5 }}

若 value 为 '北京欢迎您~'，输出结果为 '北京...'。之所以不是 '北京欢迎您...'，是因为省略号本身占用 3 个字符，加上 '北京' 共 5 个字符，符合截断长度限制。

truncatechars_html

功能类似于 truncatechars，但区别在于它不会截断 HTML 标签内部的内容，确保 HTML 结构完整。示例代码如下：

{{ value|truncatechars:5 }}

若 value 为 '<p>北京欢迎您~</p>'，输出结果为 '<p>北京...</p>'。

至此，关于 Django 模板中常用过滤器的实现原理与示例已介绍完毕。如需了解更多 Django 模板过滤器相关内容，请查阅本站往期文章或继续浏览后续教程，感谢大家的支持！