模板
模板放在根目录的templates
文件夹下,如果找不到可能要修改settings.py
文件,具体的之后再说
渲染模板
render_to_string
将模板编译后,渲染成python的字符串格式,最后通过HttpResponse
类包装成一个HttpResponse
对象返回
1 | from django.template.loader import render_to_string |
render
更简单
将模板渲染成字符串和包装成HttpResponse对象一部到位完成
1 | from django.shortcuts import render |
模板查找路径
settings.py
文件的templates
部分进行配置
DIRS
列表:,在这个列表中可以存放所有的模板路径,以后在视图中使用render或者render_to_string渲染模板的时候,会在这个列表的路径中查找模板APP_DIRS
:默认为True
,这个设置为True
后,会在INSTALLED_APPS
(已安装的APP)下的templates
文件夹中查找模板,文件夹名必须为templates
查找顺序:优先级为,
DIRS
-> 当前APP的templates
文件夹-> 其它INSTALLED_APPS
的templates
文件夹。比如代码render(‘list.html’)。先会在DIRS这个列表中依次查找路径下有没有这个模板,如果有,就返回。如果DIRS列表中所有的路径都没有找到,那么会先检查当前这个视图所处的app是否已经安装,如果已经安装了,那么就先在当前这个app下的templates文件夹中查找模板,如果没有找到,那么会在其他已经安装了的app中查找。如果所有路径下都没有找到,那么会抛出一个TemplateDoesNotExist的异常。
1 | TEMPLATES = [ |
模板变量
- 视图中,以字典的形式传入模板
1 | return render(request, 'index.html', context=context) #context是字典 |
- 在模板中使用变量,以
{{ 变量 }}
的形式 - 访问对象的属性,通过
对象.属性名
来访问,如访问person
对象的username
属性,通过person.username
- 访问字典的
key
对应的value
,通过字典.key
的方式访问,不能通过中括号[]
的形式访问,不能使用字典本身的属性名作为key
,防止自身属性被忽略,无法访问 - 列表和元组,同样使用点
.
的方式访问,不能通过中括号[]
,{{ person.0 }}
模板标签
if
标签
- 所有的标签都是在
{% %}
之间 if
标签有闭合标签,{% endif %}
if
标签的判断运算符,与python
相同,==、!=、<、<=、>、>=、in、not in、is、is not
等- 还可以使用
elif
,else
等标签
for...in...
标签
类似于Python
中的for...in...
。可以遍历列表、元组、字符串、字典等一切可以遍历的对象。
没有continue
和break
语句
1 | {% for person in persons %} |
如果想要反向遍历,那么在遍历的时候就加上一个reversed
1 | {% for person in persons reversed %} |
遍历字典的时候,需要使用items
、keys
和values
等方法。在DTL中,执行一个方法不能使用圆括号的形式
1 | {% 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循环。
for…in…empty标签
这个标签使用跟for...in...
是一样的,只不过是在遍历的对象如果没有元素的情况下,会执行empty中的内容
1 | {% for person in persons %} |
with标签
- 在模板中,通过
with
语句来定义变量 with
语句有两种使用方式,一种是with xx=xxx
的形式(=
左右没有空格),第二种是with xxx as xx
的形式- 定义的变量只能在with语句块中使用,在
with
语句块外面取不到这个变量
1 | {% with person.0 as zs %} |
url标签
在模版中,我们经常要写一些url,比如某个a标签中需要定义href属性。通过硬编码的方式直接将这个url写死的话,对于以后项目维护不方便。因此建议使用这种反转的方式来实现,类似于django中的reverse一样
1 | <a href="{% url 'book:list' %}">图书列表页面</a> #book可能是app名,或命名空间的名,有待验证。一般直接写name就好 |
如果url
反转的时候需要传递参数,那么可以在后面传递。但是参数分位置参数和关键字参数。位置参数和关键字参数不能同时使用
1 | # path部分 |
如果想要在使用url
标签反转的时候要传递查询字符串的参数,那么必须要手动在在后面添加
1 | <a href="{% url 'book:detail' book_id=1 %}?page=1">图书详情页面</a> |
如果需要传递多个参数,那么通过空格的方式进行分隔
1 | <a href="{% url 'book:detail' book_id=1 page=2 %}">图书详情页面</a> |
autosecape标签
- 模板中默认开启自动转义。自动转义是可以将一些特殊的字符,转义成html语法能识别的字符,比如
<
会被转义成<
,而>
会被自动转义成>
。 - 如果变量确实是可信任的,可以使用
autoescape
标签来关掉自动转义
1 | {% autoescape off %} |
verbatim标签:
默认在DTL模板中是会去解析那些特殊字符的。比如{%
和%}
以及`{{`等。如果你在某个代码片段中不想使用DTL的解析引擎。那么你可以把这个代码片段放在`verbatim`标签中
1
2
3{% verbatim %}
{{if dying}}Still alive.{{/if}}
{% endverbatim %}1
{{ value|add:"2" }}
1
2
3
4
5
6
7
8
9def add(value, arg):
"""Add the arg to the value."""
try:
return int(value) + int(arg)
except (ValueError, TypeError):
try:
return value + arg
except Exception:
return ''1
{{ value|cut:" " }}
1
2
3
4
5
6
7def cut(value, arg):
"""Remove all values of arg from the given string."""
safe = isinstance(value, SafeData)
value = value.replace(arg, '')
if safe and arg != ';':
return mark_safe(value)
return value1
2
3
4
5
6
7# 数据
context = {
"birthday": datetime.now()
}
# 模版
{{ birthday|date:"Y/m/d" }}1
{{ value|default:"nothing" }}
1
{{ value|default_if_none:"nothing" }}
1
{{ value|first }}
1
{{ value|last }}
| 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
类似与Python
中的join
,将列表/元组/字符串用指定的字符进行拼接。示例代码如下:
1 | {{ value|join:"/" }} |
如果value
是等于['a','b','c']
,那么以上代码将输出a/b/c
。
length
获取一个列表/元组/字符串/字典的长度。示例代码如下:
1 | {{ value|length }} |
如果value
是等于['a','b','c']
,那么以上代码将输出3
。如果value
为None
,那么以上将返回0
。
lower
将值中所有的字符全部转换成小写。示例代码如下:
1 | {{ value|lower }} |
如果value是等于Hello World。那么以上代码将输出hello world。
upper
类似于lower
,只不过是将指定的字符串全部转换成大写。
random
在被给的列表/字符串/元组中随机的选择一个值。示例代码如下:
1 | {{ value|random }} |
如果value
是等于['a','b','c']
,那么以上代码会在列表中随机选择一个。
safe
标记一个字符串是安全的。也即会关掉这个字符串的自动转义。示例代码如下:
1 | {{value|safe}} |
如果value是一个不包含任何特殊字符的字符串,比如<a>
这种,那么以上代码就会把字符串正常的输入。如果value
是一串html代码,那么以上代码将会把这个html代码渲染到浏览器中。
slice
类似于Python中的切片操作。示例代码如下:
1 | {{ some_list|slice:"2:" }} |
以上代码将会给some_list
从2
开始做切片操作。
stringtags
删除字符串中所有的html
标签。示例代码如下:
1 | {{ value|striptags }} |
如果value
是<strong>hello world</strong>
,那么以上代码将会输出hello world
。
truncatechars
如果给定的字符串长度超过了过滤器指定的长度。那么就会进行切割,并且会拼接三个点来作为省略号。示例代码如下:
1 | {{ value|truncatechars:5 }} |
如果value
是等于北京欢迎您~
,那么输出的结果是北京...
。可能你会想,为什么不会北京欢迎您...
呢。因为三个点也占了三个字符,所以北京
+三个点的字符长度就是5。
truncatechars_html
类似于truncatechars
,只不过是不会切割html
标签。示例代码如下:
1 | {{ value|truncatechars_html:5 }} |
如果value
是等于<p>北京欢迎您~</p>
,那么输出将是<p>北京...</p>
自定义过滤器
- 首先在某个app中,创建一个python包,名为
templatetags
,必须是这个名,不然找不到。 - 在
templatetags
包下面,创建一个python文件来存储过滤器 - 自定义的过滤器(也就是函数),这个函数的第一个参数永远是被过滤的那个值,还可以再定义另一个参数,过滤器最多只有2个参数
- 写完过滤器(函数)后,要使用
django.template.Library.filter
进行注册 - 将过滤器所在的app添加到
settings.py
的INSTALLED_APPS
列表中,不然Django也找不到这个过滤器 - 在模板中使用
load
标签加载过滤器所在的python文件,就可以用了 django.template.Library.filter
还可以当做装饰器来使用,如果filter
函数没有传递参数,默认使用函数名字作为过滤器名字,也可以传递name
参数作为过滤器名字
1 | # 某app的templatetags文件夹下的my_fliter.py文件 |
1 | <!-- 模板文件 --> |
模板结构优化
include标签
- 重复使用的模板代码,可以单独抽取出来,用到的地方使用
include
调用 include
的模板,可以直接使用当前模板传递进来的变量。也可以使用with xx=xxx
传递参数
1 | {% include 'header.html' with username='John'} |
模板继承
在前端页面开发中。有些代码是需要重复使用的。这种情况可以使用include标签来实现。也可以使用另外一个比较强大的方式来实现,那就是模版继承。模版继承类似于Python中的类,在父类中可以先定义好一些变量和方法,然后在子类中实现。模版继承也可以在父模版中先定义好一些子模版需要用到的代码,然后子模版直接继承就可以了。并且因为子模版肯定有自己的不同代码,因此可以在父模版中定义一个block接口,然后子模版再去实现。以下是父模版的代码:
1 | {% load static %} |
这个模版,我们取名叫做base.html,定义好一个简单的html骨架,然后定义好两个block接口,让子模版来根据具体需求来实现。子模板然后通过extends标签来实现,示例代码如下:
1 | {% extends "base.html" %} |
注意:
extends
标签必须放在模版的第一行。- 子模板中的代码必须放在
block
中,否则将不会被渲染。
block
默认会覆盖父模板的内容,如果在某个block
中需要使用父模版的内容,那么可以使用{{block.super}}
来继承。比如上例,{%block title%}
,如果想要使用父模版的title,那么可以在子模版的title block
中使用{{ block.super }}
来实现。
在定义block
的时候,除了在block
开始的地方定义这个block
的名字,还可以在block
结束的时候定义名字。比如{% block title %}{% endblock title %}
。这在大型模版中显得尤其有用,能让你快速的看到block
包含在哪里。
加载静态文件
在一个网页中,不仅仅只有一个html
骨架,还需要css
样式文件,js
执行文件以及一些图片等。因此在DTL
中加载静态文件是一个必须要解决的问题。在DTL中,使用static
标签来加载静态文件。要使用static
标签,首先需要{% load static %}
。加载静态文件的步骤如下:
- 首先确保
django.contrib.staticfiles
已经添加到settings.INSTALLED_APPS
中。(默认有) - 确保在
settings.py
中设置了STATIC_URL
。(默认有) - 在已经安装了的
app
下创建一个文件夹叫做static
,然后再在这个static
文件夹下创建一个当前app
的名字的文件夹,再把静态文件放到这个文件夹下。例如你的app
叫做book
,有一个静态文件叫做zhiliao.jpg
,那么路径为book/static/book/zhiliao.jpg
。创建app
同名文件夹的目的是,避免多个app
的静态文件名相同,调用时发生混淆。 - 如果有一些静态文件是不和任何
app
挂钩的。那么可以在settings.py
中添加STATICFILES_DIRS
,以后DTL就会在这个列表的路径中查找静态文件。比如可以设置为
1 | #根目录下,与templates同级 |
- 在模版中使用
load
标签加载static
标签。比如要加载在项目的static
文件夹下的style.css
的文件。那么示例代码如下:
1 | {% load static %} |
如果不想每次在模版中加载静态文件都使用
load
加载static
标签,那么可以在settings.py
中的TEMPLATES/OPTIONS
添加'builtins':['django.templatetags.static']
,这样以后在模版中就可以直接使用static
标签,而不用手动的load
了。如果没有在
settings.INSTALLED_APPS
中添加django.contrib.staticfiles
。那么我们就需要手动的将请求静态文件的url
与静态文件的路径进行映射了。很少用到。示例代码如下:
1 | from django.conf import settings |