Django模板系统

官方文档

常用语法:

Django模板中只需要两种特殊符号:

{{ }} 和 { % % }

{{ }}表示变量,在模板渲染的时候替换成值, {% %}表示逻辑相关的操作.

变量

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

点( . )在模板语言中有特殊的含义,用来获取对象的相应属性值

def template_test(request):
    l = [11, 22, 33]
    d = {"name": "alex"}

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

        def dream(self):
            return "{} is dream...".format(self.name)

    Alex = Person(name="Alex", age=34)
    Egon = Person(name="Egon", age=9000)
    Eva_J = Person(name="Eva_J", age=18)

    person_list = [Alex, Egon, Eva_J]
    return render(request, "template_test.html", {"l": l, "d": d, "person_list": person_list})

模板中支持的写法

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

注: 当模板系统遇到一个(.)时,会按照如下的顺序去查询.

　　　　1.在字典中查询

　　　　2.属性或者方法

　　　　3.数字索引

Filters

翻译为过滤器,用来修改变量的显示结果.

语法: {{ value|filter_name:参数}}

注: 管道符左右没有空格

default

{{ value|default:"nothing"}}

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

注: TEMPLATES的OPTIONS可以增加一个选项: string_if_invalid: '找不到' ,可以替代default的作用.

filesizeformat

将值格式化为一个'人类可读的'文件尺寸,(例如: 13kb, 4.1MB , 102 byte 等等)

{{ value|filesizeformat }}

如果 value 是 123456789，输出将会是 117.7 MB

add

给变量加参数

{{ value|add:"2" }}
value是数字4，则输出结果为6

{{ first|add:second }}
如果first是 [1,.2,3] ，second是 [4,5,6] ，那输出结果是 [1,2,3,4,5,6] 。

lower

小写

{{ value|lower }}
把value的值全部转换成小写的.

upper

大写

{{ value|upper}}
把value对应的值全部转换成大写的.

title

标题

{{ value|title }}

ljust

左对齐

{{ value|ljust:"10" }}

rjust

右对齐

{{ value|rjust:"10" }}

center

居中

{{ value|center:"15" }}

length

长度

{{ value|length }}

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

slice

切片

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

first

取第一个元素

{{ value|first }}

last

取最后一个

{{ value|last }}

join

拼接

{{ value|join:" // " }}

truncatechars

如果字符串多于指定字符数量,那么会被截断.截断的字符串将以可翻译的省略号序列("...")结尾.

参数:截断的字符数
{{ value|truncatechars:9}}

date

日期格式化

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

safe

value=' <a href='#'>点我</a> ' 如果把value直接传递过去,显示的是就是这一串字符串,如果加了safe,则会正常显示成一个a标签,可以点击跳转的标签.

{{ value|safe}}

自定义filter

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

变量(输入)的值--不一定是一个字符串
参数的值--也可以有一个默认值,或完全省略

例如 : 在过滤器{{ var|foo:'bar'}}中,过滤器foo将传递变量var和参数'bar'

自定义filter代码文件摆放位置:
app01/
    __init__.py
    models.py
    templatetags/  # 在app01下面新建一个package package
        __init__.py
        app01_filters.py  # 建一个存放自定义filter的py文件
    views.py

编写自定义filter

from django import template
register = template.Library()


@register.filter
def fill(value, arg):
    return value.replace(" ", arg)


@register.filter(name="addSB")
def add_sb(value):
    return "{} SB".format(value)

使用自定义filter

{# 先导入我们自定义filter那个文件 #}
{% load app01_filters %}

{# 使用我们自定义的filter #}
{{ somevariable|fill:"__" }}
{{ d.name|addSB }}

Tags

for

<ul>
{% for user in user_list %}
    <li>{{ user.name }}</li>
{% endfor %}
</ul>

for循环可用的一些参数:

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

for ... empty

<ul>
{% for user in user_list %}
    <li>{{ user.name }}</li>
{% empty %}
    <li>空空如也</li>
{% endfor %}
</ul>

if,elif和else

{% if user_list %}
  用户人数：{{ user_list|length }}
{% elif black_list %}
  黑名单数：{{ black_list|length }}
{% else %}
  没有用户
{% endif %}

也可以只有if和else

{% if user_list|length > 5 %}
  七座豪华SUV
{% else %}
    黄包车
{% endif %}

注意: if语句支持 and,or,==,>,<,!=,<=,>=,in,not in,is,is not判断.

with

定义一个中间变量(相当于重命名一个简单的名字)

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

csrf_token

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

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

注释

{# ...  #}

注意事项

1.Django的模板语言不支持连续判断,即不支持一下写法

{% if a > b > c %}
...
{% endif %}

2.Django的模板语言中属性的优先级大于方法

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() 方法，此时在模板语言中:

{{ data.items }}
默认会取d的items key的值.

母版

<!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>

注意: 我们通常会在母板中定义页面专用的css块和JS块,方便子页面替换.

继承母版

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

{% extends 'layouts.html' %}

块(block)

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

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

{% block page-main %}
  <p>世情薄</p>
  <p>人情恶</p>
  <p>雨送黄昏花易落</p>
{% endblock %}

组件

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

{% include 'navbar.html' %}

静态文件相关

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

引用JS文件时使用:

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

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

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

使用get_static_prefix

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

或者

{% 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

和自定义fiter类似,只不过接收更灵活的参数.

定义注册simple tag

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

使用自定义simple tag

{% load app01_demo %}

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

inclusion_tag

多用于返回html代码片段

示例:

templatetags/my_inclusion.py

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/result.html

<ul>
  {% for choice in data %}
    <li>{{ choice }}</li>
  {% endfor %}
</ul>

templates/index.html

<!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 my_inclusion %}

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