Django
视图函数不只是直接返回文本,在实际生产环境中其实很少这样使用,因为实际的页面大多是带有样式的HTML
代码,这可以让浏览器渲染出非常漂亮的页面。目前市面上有非常多的模板系统,其中最知名最好用的就是DTL
和Jinja2
。DTL
是Django Template Language
三个单词的缩写,也就是Django
自带的模板语言。当然也可以配置Django
支持Jinja2
等其他模板引擎,但是作为Django
内置的模板语言,和Django
可以达到无缝衔接而不会产生一些不兼容的情况。
1. DTL
与普通的HTML
文件的区别
DTL
模板是一种带有特殊语法的HTML
文件,这个HTML
文件可以被Django
编译,可以传递参数进去,实现数据动态化。在编译完成后,生成一个普通的HTML
文件,然后发送给客户端。
2. 模板引擎的配置
模板引擎的相关配置在settings.py
文件中的TEMPLATES
设置。这是一个配置列表,每个引擎一个。默认值为空。创建Django
项目时,Django
会自动在settings
文件中的TEMPLATES
配置项中设置一些默认值:
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [os.path.join(BASE_DIR, 'templates')]
,
'APP_DIRS': True,
'OPTIONS': {
# 上下文处理器配置
'context_processors': [
# 设置了debug,debug将在所有的模板中可以使用
'django.template.context_processors.debug',
# 设置了request,request将在所有的模板中可以使用
'django.template.context_processors.request',
# 设置了auth,auth将在所有的模板中可以使用
'django.contrib.auth.context_processors.auth',
# 设置了messages,messages将在所有的模板中可以使用
'django.contrib.messages.context_processors.messages',
],
},
},
]
BACKEND
是配置Django
的模板引擎,配置格式类似于python
导包路径。内置的引擎django.template.backends.django.DjangoTemplates
(DTL
模版引擎)和 django.template.backends.jinja2.Jinja2
(Jinja2
模板引擎)
DIRS
是定义引擎应按搜索顺序查找模板源文件的目录列表 ,默认是os.path.join(BASE_DIR, 'templates')
[项目根目录的templates
文件夹],DIRS可以配置多个,模板会按照先后顺序进行查找。
APP_DIRS
是告诉模板引擎是否在已经安装的app
应用中查找模板文件,默认是True
OPTIONS
是一些其他的可配置选项
3. 模板的使用
渲染模板有多种方式。这里讲下两种常用的方式。
-
render_to_string
:找到模板,然后将模板编译后渲染成Python的字符串格式。最后再通过HttpResponse
类包装成一个HttpResponse
对象返回回去。示例代码如下:
from django.template.loader import render_to_string
from django.http import HttpResponse
def book_detail(request,book_id):
# 指定要渲染的模板文件[模板所在的路径,基于DIRS的路径]
html = render_to_string("detail.html")
return HttpResponse(html)
-
以上方式虽然已经很方便了。但是
Django
还提供了一个更加简便的方式,直接将模板渲染成字符串和包装成HttpResponse
对象一步到位完成。render
和render_to_string
的导入方式不一样,render
的第一个参数必须是request
[HttpRequest
对象],第二个参数是template_name
[模板文件名字]示例代码如下:from django.shortcuts import render def book_list(request): # render的第二个参数是模板所在的路径,基于DIRS的路径 return render(request,'list.html')
4. 模板查找路径配置
在项目的settings.py
文件中。有一个TEMPLATES
配置,这个配置包含了模板引擎的配置,模板查找路径的配置,模板上下文的配置等。模板路径可以在两个地方配置。
-
DIRS
:这是一个列表,在这个列表中可以存放所有的模板路径,以后在视图中使用render
或者render_to_string
渲染模板的时候,会在这个列表的路径中查找模板。 -
APP_DIRS
:默认为True
,这个设置为True
后,会在INSTALLED_APPS
的安装了的APP
下的templates
文件加中查找模板。 - 查找顺序:比如代码
render('list.html')
。先会在DIRS
这个列表中依次查找路径下有没有这个模板,如果有,就返回。如果DIRS
列表中所有的路径都没有找到,那么会先检查当前这个视图所处的app
是否已经安装,如果已经安装了,那么就先在当前这个app
下的templates
文件夹中查找模板,如果没有找到,那么会在其他已经安装了的app
中查找。如果所有路径下都没有找到,那么会抛出一个TemplateDoesNotExist
的异常[DIRS
→当前app
应用(已安装)→其他app
应用(已安装)]。
5. DTL
模板的使用
5.1 DTL
可接受的OPTIONS
配置
在项目的settings.py
文件中的TEMPLATES
的配置项中,除了BACKEND
(指定模板引擎)、DIRS(模板的查找目录)
和APP_DIRS
(是否在已安装的app
应用中查找模板文件)这几个配置外还可以配置OPTIONS
(一些其他的可配置选项):
autoescape
:控制是否启用HTML自动转义的布尔值。 它默认为True
context_processors
: 用于在请求时可以在模板中使用上下文 ,这些上下文可以在所有的模板文件中使用debug
:打开/关闭模板调试模式的布尔值。如果是True
,模板出现错误,错误的详细信息将会呈现在浏览器页面中。错误信息包含模板的相关片段,并突出显示出错相应的行。它默认为DEBUG
设置(根据DEBUG
配置来确定是否打开/关闭debug
)。loaders
:各使Loader
类知道如何从特定源导入模板。或者,可以使用元组代替字符串。元组中的第一项应该是Loader
类名称和后续项将传递给Loader
初始化期间。默认值取决于DIRS
和APP_DIRS
string_if_invalid
:模板系统应用于出现错误(无效)变量的字符串输出。它默认为空字符串。file_charset
:用于读取模板文件的字符集。它默认为utf-8
libraries
:用于添加新库或为现有库提供备用标签。例如:
OPTIONS={
'libraries': {
'myapp_tags': 'path.to.myapp.tags',
'admin.urls': 'django.contrib.admin.templatetags.admin_urls',
},
}
通过将相应的字典键传递给 {{% load %}}
标签。
-
builtins
:可以使用内置库中的标记和筛选器,而无需首先调用{{% load %}}
,例如:
OPTIONS={
# 这样以后在模版中就可以直接使用static标签导入静态文件了,而不用手动的load了
'builtins': ['django.templatetags.static'],
}
以上可接受的OPTIONS
配置好多有默认值,除非我们需要修改其默认值,否则一般不需要配置(这些默认配置在开发过程中一般不会更改,除非特定需求)。
5.2 DTL
语法
5.2.1 变量
模板中可以包含变量,Django
在渲染模板的时候,可以传递变量对应的值过去进行替换。变量的命名规范和Python
非常类似,只能是阿拉伯数字和英文字符以及下划线的组合,不能出现标点符号等特殊字符。变量需要通过视图函数渲染,视图函数在使用render
或者render_to_string
的时候可以传递一个context
的参数,这个参数是一个字典类型。以后在模板中的变量就从这个字典中读取值的。示例代码如下:
# profile.html模板代码
<p>{{ username }}</p>
# views.py代码
def profile(request):
return render(request,'profile.html',context={'username':'张三'})
DTL
变量被 {{
和 }}
包围类似于python
中print()
输出一个变量的值,当变量无效或者出现错误时,DTL
将会使用空白字符进行填充,如果需要更改,可以在settings.py
文件中的TEMPLATES
的配置项中的OPTIONS
选项里的string_if_invalid
选项里进行相关配置。
模板中的变量同样也支持点(.)
的形式。在出现了点的情况,比如person.username
,模板是按照以下方式进行解析的:
- 如果
person
是一个字典,那么就会查找这个字典的username
这个key
对应的值。 - 如果
person
是一个对象,那么就会查找这个对象的username
属性,或者是username
这个方法。 - 如果出现的是
person.1
,会判断persons
是否是一个列表或者元组或者任意的可以通过下标访问的对象,如果是的话就取这个列表的第1个值。如果不是就获取到的是一个空的字符串。
不能通过中括号的形式访问字典和列表中的值,比如dict['key']
和list[1]
是不支持的!
因为使用点(.)语法获取对象值的时候,可以获取这个对象的属性,如果这个对象是一个字典,也可以获取这个字典的值。所以在给这个字典添加key
的时候,千万不能和字典中的一些属性重复。比如items
,items
是字典的方法,那么如果给这个字典添加一个items
作为key
,那么以后就不能再通过item
来访问这个字典的键值对了。
5.2.2 常用标签
DTL
的所有标签可查看文档,这里只讲解部分常用标签。
-
autoescape
标签:开启和关闭这个标签内元素的自动转义功能。自动转义是可以将一些特殊的字符。比如<
转义成html
语法能识别的字符,比如<
会被转义成<
,而>
会被自动转义成>
。模板中默认是已经开启了自动转义的。autoescape
的示例代码如下:# 传递的上下文信息 context = { "info":"<a href='www.baidu.com'>百度</a>" } # 模板中关闭自动转义 {% autoescape on %} {{ info }} {% endautoescape %}
那么就会显示百度的一个超链接。如果把
on
成off
,那么就会显示成一个普通的字符串。示例代码如下:
{% autoescape on %}
{{ info }}
{% endautoescape %}
-
csrf_token
:这个标签会生成一个隐藏的input
标签,input
标签会随机生成csrf_token
值# 模板中使用csrf_token {% csrf_token %} # csrf_token也可以使用变量来生成,不过变量只会生成值,并不会生成隐藏的input标签 {{ csrf_token }} # 页面渲染的HTML <input type='hidden' name='csrfmiddlewaretoken' value='A1F2AiL9k9gbrzyqi4sv9Q7Npdi08NzaXhqKoGcXVanV79TSkTTxgU7LM7wu5mwa' /> # 变量生成的csrf_token的值 nackYDzR554ziYEltsHuDqT1GMmFmWsLKqX2M10FG6bjYyZNvh8wKuTZ3GA9jvpL
if
标签:if
标签相当于Python
中的if
语句,有elif
和else
相对应,但是所有的标签都需要用标签符号({%%}
)进行包裹。if
标签中可以使用==、!=、<、<=、>、>=、in、not in、is、is not
等判断运算符。示例代码如下:
{% if "张三" in persons %}
<p>张三</p>
{% else %}
<p>李四</p>
{% endif %}
-
for...in...
标签:for...in...
类似于Python
中的for...in...
。可以遍历列表、元组、字符串、字典等一切可以遍历的对象。示例代码如下:
{% for person in persons %}
<p>{{ person.name }}</p>
{% endfor %}
如果想要反向遍历,那么在遍历的时候就加上一个reversed
。示例代码如下:
{% for person in persons reversed %}
<p>{{ person.name }}</p>
{% endfor %}
遍历字典的时候,需要使用items
、keys
和values
等方法。在DTL
中,执行一个方法不能使用圆括号的形式。遍历字典示例代码如下:
{% for key,value in person.items %}
<p>key:{{ key }}</p>
<p>value:{{ value }}</p>
{% endfor %}
在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
中的内容。示例代码如下:
{% for person in persons %}
<li>{{ person }}</li>
{% empty %}
暂时还没有任何人
{% endfor %}
-
with
标签:在模版中定义变量。有时候一个变量访问的时候比较复杂,那么可以先把这个复杂的变量缓存到一个变量上,以后就可以直接使用这个变量就可以了。示例代码如下:
context = {
"persons": ["张三","李四"]
}
{% with lisi=persons.1 %}
<p>{{ lisi }}</p>
{% endwith %}
有几点需要强烈的注意:
在
with
语句中定义的变量,只能在{%with%}{%endwith%}
中使用,不能在这个标签外面使用。定义变量的时候,不能在等号左右两边留有空格。比如
{% with lisi = persons.1%}
是错误的。-
还有另外一种写法同样也是支持的:
{% with persons.1 as lisi %} <p>{{ lisi }}</p> {% endwith %}
-
url
标签:在模版中,我们经常要写一些url
,比如某个a
标签中需要定义href
属性。当然如果通过硬编码的方式直接将这个url
写死在里面也是可以的。但是这样对于以后项目维护可能不是一件好事。因此建议使用这种反转的方式来实现,类似于django
中的reverse
一样。示例代码如下:
<a href="{% url 'book:list' %}">图书列表页面</a>
如果url
反转的时候需要传递参数,那么可以在后面传递。但是参数分位置参数和关键字参数。位置参数和关 键字参数不能同时使用。示例代码如下:
# path部分
path('detail/<book_id>/',views.book_detail,name='detail')
# url反转,使用位置参数
<a href="{% url 'book:detail' 1 %}">图书详情页面</a>
# url反转,使用关键字参数
<a href="{% url 'book:detail' book_id=1 %}">图书详情页面</a>
如果想要在使用url
标签反转的时候要传递查询字符串的参数,那么必须要手动在在后面添加。示例代码如下:
<a href="{% url 'book:detail' book_id=1 %}?page=1">图书详情页面</a>
如果需要传递多个参数,那么通过空格的方式进行分隔。示例代码如下:
<a href="{% url 'book:detail' book_id=1 page=2 %}">图书详情页面</a>
-
spaceless
标签:移除html
标签中的空白字符。包括空格、tab键、换行等。示例代码如下:
{% spaceless %}
<p>
<a href="foo/">Foo</a>
</p>
{% endspaceless %}
那么在渲染完成后,会变成以下的代码:
<p><a href="foo/">Foo</a></p>
spaceless
只会移除html
标签之间的空白字符。而不会移除标签与文本之间的空白字符。看以下代码:
{% spaceless %}
<strong>
Hello
</strong>
{% endspaceless %}
这个将不会移除strong
中的空白字符。
-
verbatim
标签:默认在DTL
模板中是会去解析那些特殊字符的。比如{%
和%}
以及{{
等。如果你在某个代码片段中不想使用DTL
的解析引擎。那么你可以把这个代码片段放在verbatim
标签中。示例代码下:
{% verbatim %}
{{if dying}}Still alive.{{/if}}
{% endverbatim %}
-
include
用于模板的包含# header.html <p>我是header</p> # footer.html <p>我是footer</p> # main.html {% include 'header.html' %} <p>我是main内容</p> {% include 'footer.html' %}
extends
用于模板继承
{% extends "base.html" %}
{% block title %}博客列表{% endblock %}
{% block content %}
{% for entry in blog_entries %}
<h2>{{ entry.title }}</h2>
<p>{{ entry.body }}</p>
{% endfor %}
{% endblock %}
-
block
用于模板继承定义接口<!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>
5.2.3 过滤器
在模版中,有时候需要对一些数据进行处理以后才能使用。一般在Python
中我们是通过函数的形式来完成的。而在模版中,则是通过过滤器来实现的。过滤器使用的是|
来使用。
DTL
的所有的自定义过滤器可查看文档,这里只讲解部分常用的过滤器。
-
add
:将传进来的参数添加到原来的值上面。这个过滤器会尝试将值和参数转换成整形然后进行相加。如果转换成整形过程中失败了,那么会将值和参数进行拼接。如果是字符串,那么会拼接成字符串,如果是列表,那么会拼接成一个列表。示例代码如下:
{{ value|add:"2" }}
如果value
是等于4
,那么结果将是6
。如果value
是等于一个普通的字符串,比如abc
,那么结果将是abc2
。
-
cut
:移除值中所有指定的字符串。类似于python
中的replace(args,"")
。示例代码如下:
{{ value|cut:" " }}
以上示例将会移除value
中所有的空格字符。
-
date
:将一个日期按照指定的格式,格式化成字符串。示例代码如下:
# 数据
context = {
"birthday": datetime.now()
}
# 模版
{{ birthday|date:"Y/m/d" }}
那么将会输出2020/02/02
。其中Y
代表的是四位数字的年份,m
代表的是两位数字的月份,d
代表的是两位数字的日。
还有更多时间格式化的方式。见下表。
-
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:
返回列表/元组/字符串中的第一个元素。示例代码如下:
{{ value|first }}
如果value
是等于['a','b','c']
,那么输出将会是a
。
-
last
:返回列表/元组/字符串中的最后一个元素。示例代码如下:
{{ value|last }}
如果value
是等于['a','b','c']
,那么输出将会是c
。
-
join:
类似与Python
中的join
,将列表/元组/字符串用指定的字符进行拼接。示例代码如下:
{{ value|join:"/" }}
如果value
是等于['a','b','c']
,那么以上代码将输出a/b/c
。
-
length
:获取一个列表/元组/字符串/字典的长度。示例代码如下:
{{ value|length }}
如果value
是等于['a','b','c']
,那么以上代码将输出3
。如果value
为None
,那么以上将返回0
。
-
lower
:将值中所有的字符全部转换成小写。示例代码如下:
{{ value|lower }}
如果value
是等于Hello World
。那么以上代码将输出hello world
。
upper
:类似于lower
,只不过是将指定的字符串全部转换成大写。random
:在被给的列表/字符串/元组中随机的选择一个值。示例代码如下:
{{ value|random }}
如果value
是等于['a','b','c']
,那么以上代码会在列表中随机选择一个。
-
safe:
标记一个字符串是安全的。也即会关掉这个字符串的自动转义。示例代码如下:
{{value|safe}}
如果value
是一个不包含任何特殊字符的字符串,比如 <a>
这种,那么以上代码就会把字符串正常的输入。如果value
是一串html
代码,那么以上代码将会把这个html
代码渲染到浏览器中。
-
slice:
类似于Python
中的切片操作。示例代码如下:
{{ some_list|slice:"2:" }}
以上代码将会给some_list
从2
开始做切片操作。
-
stringtags
:删除字符串中所有的html
标签。示例代码如下:
{{ value|striptags }}
如果value
是hello world
,那么以上代码将会输出hello world
。
-
truncatechars:
如果给定的字符串长度超过了过滤器指定的长度。那么就会进行切割,并且会拼接三个点来作为省略号。示例代码如下:
{{ value|truncatechars:5 }}
如果value
是等于北京欢迎您~
,那么输出的结果是北京...
。可能你会想,为什么不会北京欢迎您...
呢。因为三个点也占了三个字符,所以北京
+三个点的字符长度就是5。
-
truncatechars_html:
类似于truncatechars
,只不过是不会切割html
标签。示例代码如下:
{{ value|truncatechars:5 }}
如果value
是等于北京欢迎您~
,那么输出将是北京...
。
5.2.4 自定义过滤器
虽然DTL
给我们内置了许多好用的过滤器。但是有些时候还是不能满足我们的需求。因此Django
给我们提供了一个接口,可以让我们自定义过滤器,实现自己的需求。
模版过滤器必须要放在app
中,并且这个app
必须要在INSTALLED_APPS
中进行安装。然后再在这个app
下面创建一个Python包
叫做templatetags
。再在这个包下面创建一个python文件
。比如app
的名字叫做book
,那么项目结构如下:
- book
- views.py
- urls.py
- models.py
- templatetags
- my_filter.py
在创建了存储过滤器的文件后,接下来就是在这个文件中写过滤器了。过滤器实际上就是python中的一个函数,只不过是把这个函数注册到模板库中,以后在模板中就可以使用这个函数了。但是这个函数的参数有限制,第一个参数必须是这个过滤器需要处理的值,第二个参数可有可无,如果有,那么就意味着在模板中可以传递参数。并且过滤器的函数最多只能有两个参数。在写完过滤器后,再使用django.template.Library
对象注册进去。示例代码如下:
from django import template
# 创建模板库对象
register = template.Library()
# 过滤器函数
def mycut(value,mystr):
return value.replace(mystr)
# 将函数注册到模板库中
register.filter("mycut",mycut)
以后想要在模板中使用这个过滤器,就要在模板中load
一下这个过滤器所在的模块的名字(也就是这个python文件的名字)。示例代码如下:
{% load my_filter %}
自定义时间计算过滤器:
有时候经常会在朋友圈、微博中可以看到一条信息发表的时间,并不是具体的时间,而是距离现在多久。比如刚刚
,1分钟前
等。这个功能DTL
是没有内置这样的过滤器的,因此我们可以自定义一个这样的过滤器。示例代码如下:
# time_filter.py文件
from datetime import datetime
from django import template
register = template.Library()
def time_since(value):
"""
time距离现在的时间间隔
1. 如果时间间隔小于1分钟以内,那么就显示“刚刚”
2. 如果是大于1分钟小于1小时,那么就显示“xx分钟前”
3. 如果是大于1小时小于24小时,那么就显示“xx小时前”
4. 如果是大于24小时小于30天以内,那么就显示“xx天前”
5. 否则就是显示具体的时间 2017/10/20 16:15
"""
if isinstance(value,datetime):
now = datetime.now()
timestamp = (now - value).total_seconds()
if timestamp < 60:
return "刚刚"
elif timestamp >= 60 and timestamp < 60*60:
minutes = int(timestamp / 60)
return "%s分钟前" % minutes
elif timestamp >= 60*60 and timestamp < 60*60*24:
hours = int(timestamp / (60*60))
return "%s小时前" % hours
elif timestamp >= 60*60*24 and timestamp < 60*60*24*30:
days = int(timestamp / (60*60*24))
return "%s天前" % days
else:
return value.strftime("%Y/%m/%d %H:%M")
else:
return value
register.filter("time_since",time_since)
在模版中使用的示例代码如下:
{% load time_filter %}
...
{% value|time_since %}
...
为了更加方便的将函数注册到模版库中当作过滤器。也可以使用装饰器来将一个函数包装成过滤器。示例代码如下:
from django import template
register = template.Library()
@register.filter(name='mycut')
def mycut(value,mystr):
return value.replace(mystr,"")
5.2.5 模板结构优化
1. 引入模版
有时候一些代码是在许多模版中都用到的。如果我们每次都重复的去拷贝代码那肯定不符合项目的规范。一般我们可以把这些重复性的代码抽取出来,就类似于Python中的函数一样,以后想要使用这些代码的时候,就通过include
包含进来。这个标签就是include
。示例代码如下:
# header.html
<p>我是header</p>
# footer.html
<p>我是footer</p>
# main.html
{% include 'header.html' %}
<p>我是main内容</p>
{% include 'footer.html' %}
include
标签寻找路径的方式。也是跟render
渲染模板的函数是一样的。
默认include
标签包含模版,会自动的使用主模版中的上下文,也即可以自动的使用主模版中的变量。如果想传入一些其他的参数,那么可以使用with
语句。示例代码如下:
# header.html
<p>用户名:{{ username }}</p>
# main.html
{% include "header.html" with username='huangyong' %}
2. 模板继承
在前端页面开发中。有些代码是需要重复使用的。这种情况可以使用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中,否则将不会被渲染。
如果在某个block
中需要使用父模版的内容,那么可以使用{{block.super}}
来继承。比如上例,{%block title%}
,如果想要使用父模版的title
,那么可以在子模版的title block
中使用{{ block.super }}
来实现。
在定义block
的时候,除了在block
开始的地方定义这个block
的名字,还可以在block
结束的时候定义名字。比如{% block title %}{% endblock title %}
。这在大型模版中显得尤其有用,能让你快速的看到block
包含在哪里。
5.2.6 加载静态文件
在一个网页中,不仅仅只有一个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
下创建一个static
文件夹,还需要在这个static
下创建一个同app
名字的文件夹呢?原因是如果直接把静态文件放在static
文件夹下,那么在模版加载静态文件的时候就是使用zhiliao.jpg
,如果在多个app
之间有同名的静态文件,这时候可能就会产生混淆。而在static
文件夹下加了一个同名app
文件夹,在模版中加载的时候就是使用app/zhiliao.jpg
,这样就可以避免产生混淆。)-
如果有一些静态文件是不和任何
app
挂钩的。那么可以在settings.py
中添加STATICFILES_DIRS
,以后DTL
就会在这个列表的路径中查找静态文件。比如可以设置为:STATICFILES_DIRS = [ os.path.join(BASE_DIR,"static") ]
-
在模版中使用
load
标签加载static
标签。比如要加载在项目的static
文件夹下的style.css
的文件。那么示例代码如下:{% load static %} <link rel="stylesheet" href="{% static 'style.css' %}">
如果不想每次在模版中加载静态文件都使用
load
加载static
标签,那么可以在settings.py
中的TEMPLATES/OPTIONS
添加'builtins':['django.templatetags.static']
,这样以后在模版中就可以直接使用static
标签,而不用手动的load
了。-
如果没有在
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)