Django Template（标签、过滤器、 include

2021-12-25 本文已影响0人木火_magic

以后有更新会自动增加到文末，每个小知识点都很有用

在模版中使用变量，需要将变量放到{{ 变量 }}中。
如果想要访问对象的属性，那么可以通过对象.属性名来进行访问。

常用标签

if

{% if test_list %}
    列表不为空
{% elif test_dict %}
    列表为空，字典不为空
{% else %}
    列表字典均为空
{% endif %}

for in

{% for person in persons %}
<p>{{ person.name }}</p>
{% endfor %}

# 如果想要反向遍历，那么在遍历的时候就加上一个`reversed`。
# {% for person in persons reversed %}

# 遍历字典的时候，需要使用`items`、`keys`和`values`等方法。
# {% for key,value in person.items %}

在`for`循环中，`DTL`提供了一些变量可供使用。这些变量如下：

forloop.counter：当前循环的下标。以1作为起始值。　　
forloop.counter0：当前循环的下标。以0作为起始值。　　
forloop.revcounter：当前循环的反向下标值。比如列表有5个元素，那么第一次遍历这个属性是等于5，第二次是4，以此类推。并且是以1作为最后一个元素的下标。
forloop.revcounter0：类似于forloop.revcounter。不同的是最后一个元素的下标是从0开始。
forloop.first：是否是第一次遍历。
forloop.last：是否是最后一次遍历。
forloop.parentloop：如果有多个循环嵌套，那么这个属性代表的是上一级的for循环。

with 定义变量

{% with zs=persons.0%}
    <p>{{ zs }}</p>
{% endwith %}

# 定义的变量只能在with语句块中使用，在with语句块外面使用取不到这个变量。
# 下面这个因为超过了with语句块，因此不能使用这个变量
<p>{{ zs }}</p>

# `with`语句有两种使用方式，第一种是`with xx=xxx`的形式，第二种是`with xxx as xxx`的形式。
{% with persons.0 as zs %}
    <p>{{ zs }}</p>
{% endwith %}

url


<a href="{% url 'book:list' %}">图书列表页面</a>

如果通过硬编码的方式直接将这个`url`写死在里面也是可以的。
但是这样对于以后项目维护可能不是一件好事。
因此建议使用这种反转的方式来实现
# path部分
path('detail/<book_id>/',views.book_detail,name='detail')

 第一种1、
# url反转，使用位置参数
<a href="{% url 'book:detail' 1 %}">图书详情页面</a>

 第二种2、
# url反转，使用关键字参数
<a href="{% url 'book:detail' book_id=1 %}">图书详情页面</a>

autoescape off 关闭特殊字符进行转义

{% autoescape off %}
    {{ info }}
{% endautoescape %}

verbatim

默认在`DTL`模板中是会去解析那些特殊字符的。
比如`{%`和`%}`以及`{{`等。
如果你在某个代码片段中不想使用`DTL`的解析引擎。
那么你可以把这个代码片段放在`verbatim`标签中。
示例代码下：

{% verbatim %}
{{  if dying}}Still alive.{{/if   }}
{% endverbatim %}

过滤器

add 过滤器

{{ value|add:"2" }}
# 如果value原本等于4，运行后value=6

cut 过滤器

# 移除值中所有指定的字符串。类似于`python`中的`replace(args,"")`

{{ value|cut:" " }}
# 以上示例将会移除`value`中所有的空格字符。

date 过滤器

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

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

格式字符	描述	示例
Y	四位数字的年份	2018
m	两位数字的月份	01-12
n	月份，1-9前面没有0前缀	1-12
d	两位数字的天	01-31
j	天，但是1-9前面没有0前缀	1-31
g	小时，12小时格式的，1-9前面没有0前缀	1-12
h	小时，12小时格式的，1-9前面有0前缀	01-12
G	小时，24小时格式的，1-9前面没有0前缀	1-23
H	小时，24小时格式的，1-9前面有0前缀	01-23
i	分钟，1-9前面有0前缀	00-59
s	秒，1-9前面有0前缀	00-59

default 过滤器

如果值被评估为`False`。比如`[]`，`""`，`None`，`{}`等
这些在`if`判断中为`False`的值，
都会使用`default`过滤器提供的默认值。
示例代码如下：

{{ value|default:"nothing" }}

# 如果`value`是等于一个空的字符串。
# 比如`""`，那么以上代码将会输出`nothing`。

default_if_none 过滤器

如果值是`None`，
那么将会使用`default_if_none`提供的默认值。
这个和`default`有区别，
`default`是所有被评估为`False`的都会使用默认值。
而`default_if_none`
则只有这个值是等于`None`的时候才会使用默认值。
示例代码如下：

{{ value|default_if_none:"nothing" }}

如果`value`是等于`""`也即空字符串，
那么以上会输出空字符串。
如果`value`是一个`None`值，
以上代码才会输出`nothing`。

first 、last 过滤器

返回列表/元组/字符串中的第一个、最后一个元素。示例代码如下：

{{ value|first }}
如果`value`是等于`['a','b','c']`，那么输出将会是`a`。

{{ value|last }}
如果`value`是等于`['a','b','c']`，那么输出将会是`c`。

floatformat 过滤器

使用四舍五入的方式格式化一个浮点类型。如果这个过滤器没有传递任何参数。那么只会在小数点后保留一个小数，如果小数后面全是0，那么只会保留整数。当然也可以传递一个参数，标识具体要保留几个小数。

没有传递参数：

value	模版代码	输出
34.23234	`{{ value\|floatformat }}`	34.2
34.000	`{{ value\|floatformat }}`	34
34.260	`{{ value\|floatformat }}`	34.3

传递参数

value	模版代码	输出
34.23234	`{{value\|floatformat:3}}`	34.232
34.0000	`{{value\|floatformat:3}}`	34.000
34.26000	`{{value\|floatformat:3}}`	34.260

join 过滤器

将列表/元组/字符串用指定的字符进行拼接。示例代码如下：

{{ value|join:"/" }}

如果`value`是等于`['a','b','c']`，那么以上代码将输出`a/b/c`。

length 过滤器

获取一个列表/元组/字符串/字典的长度。示例代码如下：

{{ value|length }}

如果`value`是等于`['a','b','c']`，
那么以上代码将输出`3`。如果`value`为`None`，
那么以上将返回`0`。

lower 过滤器：将值中所有的字符全部转换成小写
upper 过滤器：将指定的字符串全部转换成大写
random 过滤器：在被给的列表/字符串/元组中随机的选择一个值，如果value是等于['a','b','c']，那么以上代码会在列表中随机选择一个。
safe 过滤器：标记一个字符串是安全的。也即会关掉这个字符串的自动转义

{{value|safe}}

如果`value`是一个不包含任何特殊字符的字符串，
比如`<a>`这种，那么以上代码就会把字符串正常的输入。
如果`value`是一串`html`代码，
那么以上代码将会把这个`html`代码渲染到浏览器中。

slice 过滤器

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

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

以上代码将会给`some_list`从`2`开始做切片操作。

striptags 过滤器：删除字符串中所有的html标签。
truncatechars 过滤器

给定的字符串长度超过了过滤器指定的长度。
那么就会进行切割，
并且会拼接三个点来作为省略号。
示例代码如下：

{{ value|truncatechars:5 }}

    如果`value`是等于`北京欢迎您~`，
    那么输出的结果是`北京...`。
    可能你会想，为什么不会`北京欢迎您...`呢。
    因为三个点也占了三个字符，
    所以`北京`+三个点的字符长度就是5。

truncatechars_html 过滤器

类似于`truncatechars`，
只不过是不会切割`html`标签。示例代码如下：

{{ value|truncatechars:5 }}

　　如果`value`是等于`<p>北京欢迎您~</p>`，
　　那么输出将是`<p>北京...</p>`。

自定义过滤器

1、首先在某个app中，创建一个python包，叫做templatetags，注意，这个包的名字必须为templatetags，不然就找不到。

2、在这个templatetags包下面，创建一个python文件用来存储过滤器。

3、在新建的python文件中，定义过滤器（也就是函数），这个函数的第一个参数永远是被过滤的那个值，并且如果在使用过滤器的时候传递参数，那么还可以定义另外一个参数。但是过滤器最多只能有2个参数。

4、在写完过滤器（函数）后，要使用django.template.Library.filter进行注册。

5、还要把这个过滤器所在的这个app添加到settings==>INSTALLED_APS中，进行安装，不然Django也找不到这个过滤器。

6、在模板中使用load标签加载过滤器所在的python包。

7、可以使用过滤器了。

8、django.template.Library.filter还可以当作装饰器来使用。如果filter函数没有传递任何参数，那么将会使用这个函数的名字来作为过滤器的名字。当然如果你不想使用函数的名字来作为过滤器的名字，也可以传递一个name参数。示例代码如下：

@register.filter('my_greet')
    def greet(value,word):
        return value + word

模板结构

6-1 include 标签

1、有些模版代码是重复的。因此可以单独抽取出来，以后哪里需要用到，就直接使用include进来就可以了。

2、如果想要在include子模版的时候，传递一些参数，那么可以使用with xxx=xxx的形式。示例代码如下：

{% include 'header.html' with username='zhiliao' %}

6-2 模板继承

1、在前端页面开发中。有些代码是需要重复使用的。这种情况可以使用include标签来实现。也可以使用另外一个比较强大的方式来实现，那就是模版继承。模版继承类似于Python中的类，在父类中可以先定义好一些变量和方法，然后在子类中实现。模版继承也可以在父模版中先定义好一些子模版需要用到的代码，然后子模版直接继承就可以了。并且因为子模版肯定有自己的不同代码，因此可以在父模版中定义一个block接口，然后子模版再去实现。以下是父模版的代码：

{% load static %}
<!DOCTYPE html>
<html lang="en">
<head>
<link rel="stylesheet" href="{% static 'style.css' %}" />
<title>{% block title %}我的站点{% endblock %}</title>
</head>

<body>
<div id="sidebar">
{% block sidebar %}
<ul>
<li><a href="/">首页</a></li>
<li><a href="/blog/">博客</a></li>
</ul>
{% endblock %}
</div>
<div id="content">
{% block content %}{% endblock %}
</div>
</body>
</html>

这个模版，我们取名叫做base.html，定义好一个简单的html骨架，然后定义好两个block接口，让子模版来根据具体需求来实现。子模板然后通过extends标签来实现，示例代码如下：

{% extends "base.html" %}
{% block title %}博客列表{% endblock %}
{% block content %}
{% for entry in blog_entries %}
<h2>{{ entry.title }}</h2>
<p>{{ entry.body }}</p>
{% endfor %}
{% endblock %}

注意：extends标签必须放在模版的第开始的位置；子模板中的代码必须放在block中，否则将不会被渲染

2、如果在某个block中需要使用父模版的内容，那么可以使用{{block.super}}来继承。比如上例，{%block title%}，如果想要使用父模版的title，那么可以在子模版的title block中使用{{ block.super }}来实现。

3、在定义block的时候，除了在block开始的地方定义这个block的名字，还可以在block结束的时候定义名字。比如{% block title %}{% endblock title %}。这在大型模版中显得尤其有用，能让你快速的看到block包含在哪里。

加载静态文件

在一个网页中，不仅仅只有一个html骨架，还需要css样式文件，js执行文件以及一些图片等。因此在DTL中加载静态文件是一个必须要解决的问题。在DTL中，使用static标签来加载静态文件。要使用static标签，首先需要{% load static %}。加载静态文件的步骤如下：

1）首先确保django.contrib.staticfiles已经添加到settings.INSTALLED_APPS中。

2）确保在settings.py中设置了STATIC_URL。

3）在已经安装了的app下创建一个文件夹叫做static，然后再在这个static文件夹下创建一个当前app的名字的文件夹，再把静态文件放到这个文件夹下。例如你的app叫做book，有一个静态文件叫做zhiliao.jpg，那么路径为book/static/book/zhiliao.jpg。（为什么在app下创建一个static文件夹，还需要在这个static下创建一个同app名字的文件夹呢？原因是如果直接把静态文件放在static文件夹下，那么在模版加载静态文件的时候就是使用zhiliao.jpg，如果在多个app之间有同名的静态文件，这时候可能就会产生混淆。而在static文件夹下加了一个同名app文件夹，在模版中加载的时候就是使用app/zhiliao.jpg，这样就可以避免产生混淆。）

4）如果有一些静态文件是不和任何app挂钩的。那么可以在settings.py中添加STATICFILES_DIRS，以后DTL就会在这个列表的路径中查找静态文件。比如可以设置为:

STATICFILES_DIRS = [
    os.path.join(BASE_DIR,"static")
]

5）在模版中使用load标签加载static标签。比如要加载在项目的static文件夹下的style.css的文件。那么示例代码如下：

{% load static %}
<link rel="stylesheet" href="{% static 'style.css' %}">

6）如果不想每次在模版中加载静态文件都使用load加载static标签，那么可以在settings.py中的TEMPLATES/OPTIONS添加'builtins':['django.templatetags.static']，这样以后在模版中就可以直接使用static标签，而不用手动的load了。

7）如果没有在settings.INSTALLED_APPS中添加django.contrib.staticfiles。那么我们就需要手动的将请求静态文件的url与静态文件的路径进行映射了。示例代码如下：

from django.conf import settings
from django.conf.urls.static import static

urlpatterns = [
# 其他的url映射
] + static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)