Django框架模板的使用和介绍

模板介绍

模板是一个文本，用于分离文档的表现形式和内容。

DTL是Django Template Language三个单词的缩写，也就是Django自带的模板语言，也可以配置jinja2等其他模板

DTL与普通的HTML文件的区别

DTL模板是一种带有特殊语法的HTML文件，这个HTML文件可以被Django编译，可以传递参数进去，实现数据动态化。在编译完成后，生成一个普通的HTML文件，然后发送给客户端。

渲染模板
1.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):
    html = render_to_string("index.html")
    return HttpResponse(html)

'''
错误信息：django.template.exceptions.TemplateDoesNotExist: index.html
解决办法:需要在settings.py里面设置：'DIRS': [os.path.join(BASE_DIR, 'templates')],
'''

2.但是django还提供了一个更加简便的方式，直接将模板渲染成字符串和包装成HttpResponse对象一步到位完成。

from django.shortcuts import render
def book_list(request):
    return render(request,'index.html')

模板查找路径配置

在项目的settings.py文件中。有一个TEMPLATES配置，这个配置包含了模板引擎的配置，模板查找路径的配置，模板上下文的配置等。模板路径可以在两个地方配置。

1.DIRS：这是一个列表，在这个列表中可以存放所有的模板路径，以后在视图中使用render或者render_to_string渲染模板的时候，会在这个列表的路径中查找模板。

2.APP_DIRS：默认为True，这个设置为True后，会在INSTALLED_APPS的安装了的APP下的templates文件加中查找模板。settings.py中INSTALLED_APPS数组中添加你的app名字。

3.查找顺序：比如代码render(‘list.html’)。先会在DIRS这个列表中依次查找路径下有没有这个模板，如果有，就返回。如果DIRS列表中所有的路径都没有找到，那么会先检查当前这个视图所处的app是否已经安装，如果已经安装了，那么就先在当前这个app下的templates文件夹中查找模板，如果没有找到，那么会在其他已经安装了的app中查找。如果所有路径下都没有找到，那么会抛出一个TemplateDoesNotExist的异常。

模板变量

DTL模板语法
模板中可以包含变量，Django在渲染模板的时候，可以传递变量对应的值过去进行替换。变量的命名规范和Python非常类似，只能是阿拉伯数字和英文字符以及下划线的组合，不能出现标点符号等特殊字符。变量需要通过视图函数渲染，视图函数在使用render或者render_to_string的时候可以传递一个context的参数，这个参数是一个字典类型

# views.py代码
def profile(request):
    return render(request,'profile.html',context={'username':'lizheha'})
    
class Person(object):
    def __init__(self,username):
        self.username = username
def index(request):

    p = Person("lizhe")
    content = {
        'person':p
    }
    
    content = {
        'persons':[
            'a',
            'b',
            'c'
        ]
    }
    return render(request,"index.html",context=content)

# profile.html模板代码
<h1>{{ username }}</h2>
<h2>{{person.username}}</h2>
<h3>{{ persons.0 }}</h3>

模板中的变量同样也支持点(.)的形式。在出现了点的情况，比如person.username，模板是按照以下方式进行解析的：

1.如果person是一个字典，那么就会查找这个字典的username这个key对应的值。
2.如果person是一个对象，那么就会查找这个对象的username属性，或者是username这个方法。
3.如果出现的是person.1，会判断persons是否是一个列表或者元组或者任意的可以通过下标访问的对象,
如果是的话就取这个列表的第1个值。如果不是就获取到的是一个空的字符串。

注意点

不能通过中括号的形式访问字典和列表中的值，比如dict[‘key’]和list[1]是不支持的！

因为使用点（.）语法获取对象值的时候，可以获取这个对象的属性，如果这个对象是一个字典，也可以获取这个字典的值。所以在给这个字典添加key的时候，千万不能和字典中的一些属性重复。比如items，items是字典的方法，那么如果给这个字典添加一个items作为key，那么以后就不能再通过item来访问这个字典的键值对了。

常用标签

常用模板标签
1.if标签：if标签相当于Python中的if语句，有elif和else相对应，但是所有的标签都需要用标签符号（{%%}）进行包裹。if标签中可以使用==、!=、<、<=、>、>=、in、not in、is、is not等判断运算符。

{% if age > 18 %}
    <p>您是成年人了</p>
{% elif age == 18 %}
    <p>您刚满18岁</p>
{% else %}
    <p>您是未成年人</p>
{% endif %}
{% if "张三" in persons %}
    <p>张三</p>
{% else %}
    <p>李四</p>
{% endif %}

2.for…in…标签：for…in…类似于Python中的for…in…。可以遍历列表、元组、字符串、字典等一切可以遍历的对象。

{% for book in books %}
    <p>{{ book }}</p>
{% endfor %}
# 反向遍历
{% for book in books reversed %}
    <p>{{ book }}</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循环。

3.for…in…empty标签：这个标签使用跟for…in…是一样的，只不过是在遍历的对象如果没有元素的情况下，会执行empty中的内容。

{% for person in persons %}
    <li>{{ person }}</li>
{% empty %}
    暂时还没有任何人
{% endfor %}

注意:在for循环中，break，continue语句是用不了的。
4.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>

更多标签参考django官方文档:
https://docs.djangoproject.com/en/2.0/ref/templates/builtins/

模板常用的过滤器

过滤器
有时候，需要对一些数据进行处理才能使用，在python中通过函数来实现，模板中使用过滤器来实现，用| 来使用

add
将传进来的参数添加到原来的值上面。这个过滤器会尝试将值和参数转换成整形然后进行相加。如果转换成整形过程中失败了，那么会将值和参数进行拼接。如果是字符串，那么会拼接成字符串，如果是列表，那么会拼接成一个列表。

{{ value|add:"2" }}

如果value是等于4，那么结果将是6。如果value是等于一个普通的字符串，比如abc，那么结果将是abc2。
cut
移除值中所有指定的字符串。类似于python中的replace(args,"")。

{{ value|cut:" " }}

date
将一个日期按照指定的格式，格式化成字符串。

# 数据
context = {
    "birthday": datetime.now()
}
# 模版
{{ birthday|date:"Y/m/d" }}

那么将会输出2018/02/01。其中Y代表的是四位数字的年份，m代表的是两位数字的月份，d代表的是两位数字的日。

Y			四位数字的年份		2018
m			两位数字的月份		01-12
n			月份，1-9前面没有0前缀     1-12
d			两位数字的天			01-31
j			天，1-9前面没有0		1-31
g			小时，12小时格式1-9没0前缀       	1-12
h			小时，12小时格式1-9有0前缀			01-12
G			小时，24小时格式1-9没0前缀				1-23
H			小时，24小时格式1-9有0前缀				01-23
i			分钟，1-9前面有0前缀			00-59
s			秒，1-9前面有0前缀				00-59

default

如果值被评估为False。比如[]，""，None，{}等这些在if判断中为False的值，都会使用default过滤器提供的默认值。

{{ value|default:"nothing" }}

如果value是等于一个空的字符串。比如""，那么以上代码将会输出nothing。
first
返回列表/元组/字符串中的第一个元素。

{{ value|first }}

last
返回列表/元组/字符串中的最后一个元素。

{{ value|last }}

floatformat
使用四舍五入的方式格式化一个浮点类型。如果这个过滤器没有传递任何参数。那么只会在小数点后保留一个小数，如果小数后面全是0，那么只会保留整数。当然也可以传递一个参数，标识具体要保留几个小数。

<li>{{ 34.32|floatformat }}</li>        34.3
<li>{{ 34.35|floatformat }}</li>        34.4
<li>{{ 34.353333|floatformat:3}}</li>   34.353

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

upper
类似于lower，只不过是将指定的字符串全部转换成大写。
random
在被给的列表/字符串/元组中随机的选择一个值。

{{ value|random }}

safe
标记一个字符串是安全的。也即会关掉这个字符串的自动转义。

{{value|safe}}

如果value是一个不包含任何特殊字符的字符串，比如这种，那么以上代码就会把字符串正常的输入。如果value是一串html代码，那么以上代码将会把这个html代码渲染到浏览器中。
slice
类似于Python中的切片操作。

{{ some_list|slice:"2:" }}

striptags
删除字符串中所有的html标签。

{{ value|striptags }}
truncatechars

如果给定的字符串长度超过了过滤器指定的长度。那么就会进行切割，并且会拼接三个点来作为省略号。

{{ value|truncatechars:5 }}

更多可以查看Django源码

from django.template import defaultfilters,defaulttags

模板结构优化

引入模板
有一些代码在许多模板中都能用到，每次都重复去拷贝代码不符合项目的规范，我们可以把这些重复性的代码抽取出来，类似于函数一样，通过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='juran' %}

模板继承
在前端页面开发中。有些代码是需要重复使用的。这种情况可以使用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包含在哪里。

加载静态文件

在一个网页中，不仅仅只有一个html骨架，还需要css样式文件，js执行文件以及一些图片等。因此在DTL中加载静态文件是一个必须要解决的问题。在DTL中，使用static标签来加载静态文件。要使用static标签，首先需要{% load static %}。
1.首先确保django.contrib.staticfiles已经添加到settings.INSTALLED_APPS中。
2.确保在settings.py中设置了STATIC_URL。
3.先注册app，在已经安装了的app下创建一个文件夹叫做static，然后再在这个static文件夹下创建一个当前app的名字的文件夹，再把静态文件放到这个文件夹下。
例如你的app叫做book，有一个静态文件叫做logo.jpg，那么路径为book/static/book/logo.jpg。（为什么在app下创建一个static文件夹，还需要在这个static下创建一个同app名字的文件夹呢？原因是如果直接把静态文件放在static文件夹下，那么在模版加载静态文件的时候就是使用logo.jpg，如果在多个app之间有同名的静态文件，这时候可能就会产生混淆。而在static文件夹下加了一个同名app文件夹，在模版中加载的时候就是使用app/logo.jpg，这样就可以避免产生混淆。）
4.如果有一些静态文件是不和任何app挂钩的。那么可以在settings.py中添加STATICFILES_DIRS，以后DTL就会在这个列表的路径中查找静态文件。

 STATICFILES_DIRS = [
     os.path.join(BASE_DIR,"static")
 ]

5.在模版中使用load标签加载static标签。比如要加载在项目的static文件夹下的style.css的文件。

 {% load static %}
 <link rel="stylesheet" href="{% static 'style.css' %}">

6.如果不想每次在模版中加载静态文件都使用load加载static标签，那么可以在settings.py中的TEMPLATES/OPTIONS添加’builtins’:[‘django.templatetags.static’]，这样以后在模版中就可以直接使用static标签，而不用手动的load了。
7.如果没有在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.STATICFILES_DIRS[0])