模板(templates)

语法

只需要记住两种特殊符号：

  • {{ }}：变量相关
  • {% %}：逻辑相关

变量

变量名由字母数字和下划线组成。

格式如下：

{{ 变量名 }}

view中代码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
def template_test(request):
    l = [31, 52, 23]
    d = {"name": "Rohn"}

    class Person(object):
        def __init__(self, name, age):
            self.name = name
            self.age = age

        def dream(self):
            return "%s is dream..."%(self.name)

    libai = Persion(name="Rohn", age=52)
    baijy = Persion(name="John", age=31)

    person_list = [libai, baijy]
    return render(request, "template_test.html", {"l": l, "d": d, "person_list": person_list})

模板中支持的写法：

1
2
3
4
5
6
7
8
{# 取l中的第一个参数 #}
{{ l.1 }}
{# 取字典中key的值 #}
{{ d.name }}
{# 取对象的name属性 #}
{{ person_list.0.name }}
{# .操作只能调用不带参数的方法 #}
{{ person_list.0.dream }}

Filters

语法：

{{ value|filter_name:参数 }}

default

1
{{ value|default: "nothing"}}

Tips：如果value值没传的话就显示nothing

length

语法格式：

{{ value|length }}

Tips：|左右没有空格没有空格没有空格

返回value的长度，如value=['a', 'b', 'c', 'd']的话，就显示4。

filesizeformat

将值格式化为一个 人类可读的 文件尺寸 （例如 '13 KB', '4.1 MB', '102 bytes', 等等）。例如：

1
{{ value|filesizeformat }}

slice

切片

1
{{value|slice:"2:-1"}}

date

格式化

1
{{ value|date:"Y-m-d H:i:s"}}

safe

Django的模板中会对HTML标签和JS等语法标签进行自动转义，原因显而易见，这样是为了安全。

但是有的时候我们可能不希望这些HTML元素被转义，比如我们做一个内容管理系统，后台添加的文章中是经过修饰的，这些修饰可能是通过一个类似于FCKeditor编辑加注了HTML修饰符的文本，如果自动转义的话显示的就是保护HTML标签的源文件。为了在Django中关闭HTML的自动转义有两种方式，如果是一个单独的变量我们可以通过过滤器|safe的方式告诉Django这段代码是安全的不必转义。

例如：

value = “点我“

1
{{ value|safe}}

truncatechars

如果字符串字符多于指定的字符数量，那么会被截断。截断的字符串将以可翻译的省略号序列（“…”）结尾。

参数：截断的字符数

1
{{ value|truncatechars:9}}

自定义filter

自定义过滤器只是带有一个或两个参数的Python函数:

  • 变量（输入）的值 - -不一定是一个字符串
  • 参数的值 - 这可以有一个默认值，或完全省略

例如，在过滤器{{var | foo：“bar”}}中，过滤器foo将传递变量var和参数bar。

自定义filter代码文件摆放位置：

1
2
3
4
5
6
7
app01/
    __init__.py
    models.py
    templatetags/         # 在app01下面新建一个package package
        __init__.py
        app01_filters.py  # 建一个存放自定义filter的文件
    views.py

编写自定义filter

1
2
3
4
5
6
7
8
9
10
from django import template
register = template.Library()

@register.filter(name="cut")
def cut(value, arg):
    return value.replace(arg, "%s--->Rohn"%value)

@register.filter(name="addstr")
def add_str(value):
    return "%s 说：学而不思则罔" %value

使用自定义filter

1
2
3
4
5
{# 先导入我们自定义filter那个文件 #}
{% load app01_filters %}
{# 使用我们自定义的filter #}
{{ d.name|addstr }}
{{ d.name|cut:"Rohn" }}

Tags

标签看起来像是这样的： {% tag %}。

标签比变量复杂得多，有些用于在输出中创建文本，有些用于控制循环或判断逻辑，有些用于加载外部信息到模板中供以后的变量使用。

一些标签需要开始和结束标签（即 {％ 标签 ％} ... 标签 内容 ... {％ ENDTAG ％}）。

for

循环对象中每个元素。需要结束标签{% endfor %} 。

1
2
3
4
5
<ul>
{% for user in user_list %}
    <li>{{ user.name }}</li>
{% endfor %}
</ul>

for循环可用的一些参数：P

Variable Description
forloop.counter 当前循环的索引值（从1开始）
forloop.counter0 当前循环的索引值（从0开始）
forloop.revcounter 当前循环的倒序索引值（从1开始）
forloop.revcounter0 当前循环的倒序索引值（从0开始）
forloop.first 当前循环是不是第一次循环（布尔值）
forloop.last 当前循环是不是最后一次循环（布尔值）
forloop.parentloop 本层循环的外层循环

for … empty

1
2
3
4
5
6
7
<ul>
{% for user in user_list %}
    <li>{{ user.name }}</li>
{% empty %}
    <li>aaaaa</li>
{% endfor %}
</ul>

if,elif和else

if语句支持 and 、or、==、>、<、!=、<=、>=、in、not in、is、is not判断。

1
2
3
4
5
6
7
{% if user_list %}
    用户人数：{{ user_list|length }}
{% elif black_list %}
    黑名单数：{{ black_list|length }}
{% else %}
    没有用户
{% endif %}

当然也可以只有if和else

1
2
3
4
5
{% if user_list|length > 5 %}
    人数多于五个
{% else %}
    人数少于五个
{% endif %}

with

定义一个中间变量

1
2
3
{% with total=business.employees.count %}
    {{ total }} employee{{ total|pluralize }}
{% endwith %}

csrf_token

这个标签用于跨站请求伪造保护。

在页面的form表单里面写上{% csrf_token %}

注释

1
{# ... #}

注意事项

  1. Django的模板语言不支持连续判断，即不支持以下写法：
1
2
3
{% if a > b > c %}
...
{% endif %}
  1. Django的模板语言中属性的优先级大于方法
1
2
3
def xx(request):
    d = {"a": 1, "b": 2, "c": 3, "items": "100"}
    return render(request, "xx.html", {"data": d})

如上，我们在使用render方法渲染一个页面的时候，传的字典d有一个key是items并且还有默认的d.items()方法，此时在模板中:

1
{{ data.items }}

默认会取d的items key的值。

母板

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="x-ua-compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <title>Title</title>
  {% block page-css %}
  
  {% endblock %}
</head>
<body>

<h1>这是母板的标题</h1>

{% block page-main %}

{% endblock %}
<h1>母板底部内容</h1>
{% block page-js %}

{% endblock %}
</body>
</html>

Tips：我们通常会在母板中定义页面专用的CSS块和JS块，方便子页面替换。

继承母板

在子页面中在页面最上方使用下面的语法来继承母板。

1
{% extends 'layouts.html' %}

块(block)

通过在母板中使用{% block xxx %}来定义块。

在子页面中通过定义母板中的block名来对应替换母板中相应的内容。

1
2
3
4
5
{% block page-main %}
  <p>这是继承模板的内容</p>
  <p>ddddd</p>
  <p>fffff</p>
{% endblock %}

组件

可以将常用的页面内容如导航条，页尾信息等组件保存在单独的文件中，然后在需要使用的地方按如下语法导入即可。

1
{% include 'navbar.html' %}

静态文件相关

1
2
{% load static %}
<img src="{% static "images/hi.jpg" %}" alt="Hi!" />

引用JS文件时使用：

1
2
{% load static %}
<script src="{% static "mytest.js" %}"></script>

某个文件多处被用到可以存为一个变量

1
2
3
{% load static %}
{% static "images/hi.jpg" as myphoto %}
<img src="{{ myphoto }}"></img>

使用get_static_prefix

1
2
{% load static %}
<img src="{% get_static_prefix %}images/hi.jpg" alt="Hi!" />

或者

1
2
3
4
5
{% load static %}
{% get_static_prefix as STATIC_PREFIX %}

<img src="{{ STATIC_PREFIX }}images/hi.jpg" alt="Hi!" />
<img src="{{ STATIC_PREFIX }}images/hi2.jpg" alt="Hello!" />

自定义simpletag

和自定义filter类似，只不过接收更灵活的参数。

定义注册simple tag

1
2
3
@register.simple_tag(name="plus")
def plus(a, b, c):
    return "{} + {} + {}".format(a, b, c)

使用自定义simple tag

1
2
3
4
{% load app01_demo %}

{# simple tag #}
{% plus "1" "2" "abc" %}

inclusion_tag

多用于返回html代码片段

实例：templatetags/my_inclusion.py

1
2
3
4
5
6
7
8
9
10
from django import template

register = template.Library()


@register.inclusion_tag('result.html')
def show_results(n):
    n = 1 if n < 1 else int(n)
    data = ["第{}项".format(i) for i in range(1, n+1)]
    return {"data": data}

templates/snippets/result.html

1
2
3
4
5
<ul>
  {% for choice in data %}
    <li>{{ choice }}</li>
  {% endfor %}
</ul>

templates/index.html

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="x-ua-compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <title>inclusion_tag test</title>
</head>
<body>

{% load inclusion_tag_test %}

{% show_results 10 %}
</body>
</html>