Django中利用filter与simple_tag为前端自定义函数的实现方法

时间:2024-01-06 17:01:26

转自:http://www.jb51.net/article/116303.htm

前言

Django的模板引擎提供了一般性的功能函数,通过前端可以实现多数的代码逻辑功能,这里称之为一般性,是因为它仅支持大多数常见情况下的函数功能,例如if判断,ifequal对比返回值等,但是稍微复杂一些的函数功能并不支持,例如通过模板来判断一个返回值是否是合法的数字类型,此时如果又不希望通过后台视图代码来实现的话,我们就可以自定义一些前端函数功能。

Django为我们提供了两种方式,分别是filter和simple_tag,下面对比两种方式,分别实现判断返回值的功能函数。

准备工作

1、应用程序必须要注册到settings配置文件中

2、在应用目录下创建templatetags目录

3、在templatetags创建模块文件,并导入Django内部方法

filter

在templatetags目录下创建python模块,这里命名为app01_func.py,内容如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
from django import template
from django.template.defaultfilters import stringfilter
register = template.Library()
@register.filter
def value_verification(value): # value为前端传递的参数
 try:
  int(value)
  return True
 except:
  return False

定制完后台功能后,就可以在模板文件中调用函数功能,首选需要在模板文件头中引入后台python模块。

1
{% load app01_func %}

例如我们需要判断后台返回值load是否为一个有效数字时,可以做如下调用:

1
2
3
4
5
{% if load|value_verification %}
 {{ load }} is a valid int number.
{% else %}
 {{ load }} is letter.
{% endif %}

simple_tag

simple_tag的代码方式与filter一样,不同的是在装饰器部分需要调用simple_tag方法

1
2
3
4
5
6
7
8
9
10
11
12
13
from django import template
from django.template.defaultfilters import stringfilter
register = template.Library()
@register.simple # 这里修改为simple_tag
def value_verification(value): # value为前端传递的参数
 try:
  int(value)
  return True
 except:
  return False

同时前端的调用方式也需要改为

1
{% value_verification load %}

传递参数

- filter 最多支持两个参数传递

- simple 支持多个参数传递

filter中可以通过下面的方式实现参数传递

1
{{ load | value_verification:"100"}}

这里即向后端传递了两个参数,一个是load,另一个是100,后端也要为函数指定好形参:

1
2
def value_verification(value, custom): # 配置好形参
 ...

simple_tag中可以指定多个形参,前台的调用方式如下:

1
{% value_verification load 100 200 ... %}

这里filter中最多只能接受两个参数,但此时参数又多,又不想使用simple_tag的情况下,可以将多个参数用特定字符拼接成一个字符串传递给后端,后端通过split方式同样能获取多个参数。

对比总结

通过simple_tag和filter可以完成模板引擎无法完成的某些事情,filter将我们指定的函数变成了返回值可执行的方法,simple_tag将函数功能变为标签功能,例如if、ifequal等,同样调用方式也不同,对比如下:

1
2
{{ load | value_verification }} # filter
{% value_verification load %} # simple_tag

因为调用方式的不同,如果返回值需要做为if或ifequal判断依据的话,这里只能使用filter方法了,stringfilter方法可以实现将接收到的所有参数变为字符串类型,同register装饰器一样引用到函数方法上即可,这里注意要放在register下面,否则无法生效。