Django模板系统：Template

2023年9月27日 73次阅读

一、模板常用语法

1.1 变量

  1. 符号：{{ }}
    • 表示变量，在模板渲染的时候替换成值
    • 使用方式：{{ 变量名 }}：变量名由字母数字和下划线组成
    • 点（.）在模板语言中有特殊的含义，用来获取对象的相应属性值
    • 注意：当模板系统遇到一个（.）时，会按照如下的顺序去查询：
      • 在字典中查询
      • 属性或者方法
      • 数字索引

1.2 内置filter

  1. filter：过滤器，用来修改变量的显示结果

    • 语法： {{ value|filter_name:参数 }}
    • ‘:’左右没有空格没有空格没有空格

  2. 内置过滤器

    • default：默认值

      • 语法：{{ value|default:”nothing”}}
      • 如果value值没传的话就显示nothing
      • 补充：TEMPLATES的OPTIONS可以增加一个选项：string_if_invalid：’找不到’，可以替代default的的作用

    • filesizeformat：文件大小，将值格式化为可读的文件尺寸

      • 语法：{{ value|filesizeformat }}
      • 如，value=123456789，输出将会是 117.7 MB

    • add：给变量加参数

      • 语法：{{ first|add:second }}
      • 优先看是否能转化为数字相加，其次是字符串拼接
      • 如果都是列表，相当于extend，循环加入

    • length：返回长度

      • 语法：{{ value|length }}
      • 返回value的长度，如，value=[‘a’, ‘b’, ‘c’, ‘d’]的话，就显示4

    • slice：切片

      • 语法：{{value|slice:”2:-1″}}

    • first / last：取第一个/最后一个元素

      • 语法：
        • 取第一个元素：{{ value|first }}
        • 取最后一个元素：{{ value|last }}

    • join：使用字符串拼接列表

      • 语法：{{ value|join:” // ” }}

    • truncatechars：截断，按照字符计数

      • truncatewords：按照字母计数，不能识别中文
      • 如果字符串字符多于指定的字符数量，那么会被截断
      • 截断的字符串将以可翻译的省略号序列（…）结尾
      • 参数：截断的字符
      • 语法：{{ value|truncatechars:9}}

    • date：日期格式化

      • 语法：{{ value|date:”Y-m-d H:i:s”}}

      • 在settings.py中配置：

        USE_L10N = False

DATETIME_FORMAT = 'Y-m-d H:i:s'    # datetime类型
DATE_FORMAT = 'Y-m-d'            # date类型
TIME_FORMAT = 'H:i:s'            # time类型

      • 配置后，使用{{now}}可以实现日期格式化

        • 其中，’now’:datetime.datetime.now()

    • safe：告诉django这段代码是安全的，不需要转义

      • 语法：{{ value|safe}}
      • 如，value = "<a href='#'>点我</a>"

1.3 自定义filter

  1. 在app下创建一个名为templatetags的python包

  2. 在templatetags中创建py文件,文件名自定义（my_tags.py）;

  3. 在py文件中写：

    from django import template
register = template.Library()        # register也不能变

  4. 写函数+装饰器

    @register.filter
def add_xx(value, arg):          # 最多有两个
    return '{}-{}'.format(value, arg)

@register.filter(name='adds')    # 相当于更改了函数名，使用时，使用新的函数名

  5. 在模板文件中使用，html文件

    {% load my_tags %}
{{ 'alex'|add_xx:'dsb' }}

  6. 注意：

    • 为避免出错，templatetags最好是一个Python包，并且名称不能更改
    • register名称也不能更改，必要时需要重启项目
    • Python包下的init中可能有其他内容django不能识别，导致出错，可以直接删除内容

1.4 标签tag

  1. 符号：{% %}

  2. for循环

    <ul>
{% for user in user_list %}
    <li>{{ user.name }}</li>
{% endfor %}
</ul>
    • forloop：字典形式
    VariableDescription
    forloop.counter当前循环的索引值（从1开始）
    forloop.counter0当前循环的索引值（从0开始）
    forloop.revcounter当前循环的倒序索引值（到1结束）
    forloop.revcounter0当前循环的倒序索引值（到0结束）
    forloop.first当前循环是不是第一次循环（布尔值）
    forloop.last当前循环是不是最后一次循环（布尔值）
    forloop.parentloop本层循环的外层循环
    • for … empty
    {% for book in all_books %}
    <tr>
     .....
    </tr>
{% empty %}
    <td>没有相关的数据</td>
{% endfor %}

  3. if判断

    • if语句支持 and 、or、==、>、<、!=、<=、>=、in、not in、is、is not判断
    {% if 条件1  %}
 xxx
{% elif 条件2  %}
    xxx
{% else  %}
 xxxxx
{% endif %}
    • 连续判断
      • python中，10>5>1 –> 10>5 and 5>1 –> true
      • js中，10>5>1 –> true>1 –> 1>1 –> false
      • 模板中，不支持连续连续判断 也不支持算数运算（可使用过滤器）

  4. with：给变量重命名，但只在with区域内生效

    {% with hobby.2 as talk %}
{# 相当于 {% with talk=hobby.2 %}，其中=两边不能有空格 #}
 {{ talk }}
{% endwith %}

  5. csrf_token

    • 该标签用于跨站请求伪造保护
      • csrf：跨站请求伪造
    • 使用方式：在form表单中写上{% csrf_token %}
    • 这样就不用在settings中注释含csrf的中间件了

1.5 注释

  • 符号：{# 要注释的内容 #}

  • 快捷键：Ctrl + ?

    {# 要注释的内容 #}

二、母板和继承

2.1 母板

  1. 母板就是一个普通的html，提取多个页面的公共部分，通过定义block块来实现

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

  2. block块：

    {% block 块名 %}

{% endblock %}

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

2.2 继承

  1. 子页面继承母板：{% extends ‘母板html’ %}

    {% extends 'layouts.html' %}

  2. 子页面通过重写block块，来替换母板中相应的内容

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

2.3 注意

  1. {% extends ‘base.html’ %}要写在第一行，前面不要有内容，否则内容会显示出来
  2. {% extends ‘base.html’ %}中的’base.html’ 必须加上引号，不然会被当做变量去查找
  3. 子页面把要显示的内容写在block块中，否则不会显示出来
  4. 多个位置有独特内容，可以定义多个block块，特殊：定义css、js块等

三、组件

  1. 组件：一小段html代码段

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

    {% include 'navbar.html' %}

四、静态文件相关

  1. 目的：更改setting中静态文件的别名时，不影响在更改之前的静态文件的引用，即引用会跟随别名的更改而自动更改，这样就不会报错了

  2. 方法一：使用static，原本路径：/static/images/hi.jpg

    {% load static %}
<img src="{% static "images/hi.jpg" %}" alt="Hi">
    • 文件多处被用到可以存为一个变量
    {% load static %}
{% static "images/hi.jpg" as myphoto %}
<img src="{{ myphoto }}">

  3. 方法二：使用get_static_prefix，原本路径：/static/images/hi.jpg

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

{# 补充：获取别名 #}
{% get_static_prefix %}
    • 文件多处被用到可以存为一个变量
    {% load static %}
{% get_static_prefix as STATIC_PREFIX %}
<img src="{{ STATIC_PREFIX }}images/hi.jpg" alt="Hi">

五、自定义simple_tag

  1. 和自定义filter类似，区别：接收的参数更灵活，能接收万能参数

  2. 定义注册simple_tag

    @register.simple_tag
def join_str(*args, **kwargs):
    return '{} - {} '.format('*'.join(args), '$'.join(kwargs.values()))

@register.simple_tag(name='join')    # 相当于更改了函数名，使用时，使用新的函数名

  3. 使用自定义simple_tag

    {% load my_tags %}
{% join_str '1' '2' k1='3' k2='4' %}

六、inclusion_tag

  1. 在app下的templatetags（python包）中创建py文件,文件名自定义（my_inclusion.py）;

  2. 在py文件中写：

    from django import template
register = template.Library()        # register也不能变

  3. 写函数+装饰器

    @register.inclusion_tag('result.html')
# result.html 是内容的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}

  4. 在result.html中写：

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

  5. 在模板文件中使用

    {% load my_inclusion %}
{% show_results 10 %}
点赞