Django之模版层

模板层

1、什么模板层?为什么要有模板层?

在刚刚介绍完的视图层中我们提到,浏览器发送的请求信息会转发给视图函数进行处理,而视图函数在经过一系列处理后必须要有返回信息给浏览器。如果我们要返回html标签、css等数据给浏览器进行渲染,我们可以在视图函数中这么做:

def current_datetime(request):
    now = datetime.datetime.now()
    html = "<html><body>It is now %s.</body></html>" % now
    return HttpResponse(html)

上例所示,我们直接将HTML代码放到视图函数里,然后进行返回,这可以使我们很直观地看清楚浏览器从发送请求到看到前端界面内容的这个过程中视图函数的基本工作原理,但是这种将前端代码与后端代码耦合到了一起开发方式,会存在以下问题:
1、程序的可维护性可扩展性问题
前端界面一旦需要重新设计、修改,则必须对后端的Python代码进行相应的修改。 然而前端界面的修改往往比后端 Python 代码的修改要频繁得多,因此如果可以在不进行 Python 代码修改的情况下变更前端界面的设计,那将会方便得多。

2、开发效率问题
Python 代码编写和 HTML 设计是两项不同的工作,大多数专业的网站开发环境都将它们分配给不同的人员(甚至不同部门)来完成。 专门的程序员去编写 Python代码、专门的设计人员去制作模板,这两项工作同时进行,效率才是最高的。
基于上述原因,将前端页面和Python的代码分离是一种不错的开发模式。 为此 Django专门提供了模板系统 (Template System,即模板层)来实现这种模式,这就是本章要具体讨论的问题。
django的模板=HTML代码+模板语法

存放于templates目录下的html文件称之为模板文件,如果我们想要返回的html页面中的数据是动态的,那么必须在html页面中嵌入变量,这便用到了django的模板语法,具体来说,django的模板语法有以下重点

一、变量:{{ 变量名 }}
	1.1 深度查询:句点符的应用
    1.2 过滤器
二、标签:{% 标签名 %}
三、自定义标签和过滤器
四、模板的导入和继承

2、模板语法之变量

2.1 、变量的基本使用

如果html代码中的数据不是固定死的,而是动态变化的,则必须在html中嵌入变量,为此,模板语法提供了变量的概念,允许我们在html代码中嵌入变量,我们只需要在视图函数中用render方法为html文件中指定的变量赋值即可,具体用法如下:
test.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>

</head>
<body>
   <p>{{msg}}</p>
    <p>{{li}}</p>
    <p>{{tup}}</p>
    <p>{{dic}}</p>
    <p>{{obj}}</p>
</body>
</html>

view.py

from django.shortcuts import render

# Create your views here.

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

def test(request):
    msg="hello msg"
    li=['a','b','c','d']
    tup=(1,2,3,4,5,6,7)
    dic={'name':'lpc','age':'12'}
    obj=Person('jason',18)
    return  render(request,'test.html',context={'msg':msg,'li':li,'tup':tup,'dic':dic,'obj':obj})
# 注意:
# 1、render函数的第三个参数包含了要传给模板的变量值,是一个字典类型,该字典中的key必须与模板文件中的变量名相对应,render函数会去templates目录下找到模板文件,然后根据字典中的key对应到模板文件中的变量名进行赋值操作,最后将赋值后的模板文件内容返回给浏览器
# 2、可以将render函数的第三个参数简写为locals(),如下
    return render(request,'test.html',locals()) #locals()会将函数test内定义的名字与值转换为字典中的k与v

运行结果:

# 浏览器输入:http://127.0.0.1:8000/app03/test
hello msg

['a', 'b', 'c', 'd']

(1, 2, 3, 4, 5, 6, 7)

{'name': 'lpc', 'age': '12'}

<app03.views.Person object at 0x0000029B0A81C160>

2.2.1 总结

  • 传递到前端模板的数据类型可以是任何。字符串、列表、元组、字典、对象等。且数据类型为字典。
  • render函数通过字典当中的key找到模板文件夹下对应的变量名,并且复制。最后讲赋值后的模板文件内容返回给浏览器。
  • 传值内容过多时,可以使用local,会将函数内定义的变量名字作为字典中的key,值作为values来传递。

2.2 、深度查询句点符的使用

当视图函数传给模板的值中包含多个元素时,若想取出其中的单个元素,就必须使用句点符了。

句点符既可以引用容器类型的元素,也可以引用对象的方法,如下:

test.html

<div>
           <h3>取某个元组,或者是对某个元素进行操作</h3>
           <p>{{msg.upper}}</p> # 转成大写。
            <p>{{li.1}}</p>  # 取索引值为1的元素
            <p>{{tup.0}}</p> # 取索引值为0的元素
            <p>{{dic.name}}</p>取key为name
            <p>{{obj.age}}</p>
       </div>

测试结果:

 # 浏览器输入:http://127.0.0.1:8000/app03/test
HELLO MSG
b
1
lpc
18

2.3、过滤器

在Django的模板语言中,通过使用 过滤器 来改变变量的显示。

过滤器的语法: {{ value|filter_name:参数 }}

使用管道符"|"来应用过滤器。

例如:{{ name|lower }}会将name变量应用lower过滤器之后再显示它的值。lower在这里的作用是将文本全都变成小写。

注意事项:

  1. 过滤器支持“链式”操作。即一个过滤器的输出作为另一个过滤器的输入。
  2. 过滤器可以接受参数,例如:{{ sss|truncatewords:30 }},这将显示sss的前30个词。
  3. 过滤器参数包含空格的话,必须用引号包裹起来。比如使用逗号和空格去连接一个列表中的元素,如:{{ list|join:', ' }}
  4. '|'左右没有空格没有空格没有空格

2.3.1 default

如果一个变量是false或者是空,使用给定的默认值,否则,使用变量值.

   
   <p>{{tt|default:"123"}}</p>
   # 显示结果为
   123

2.3.2 length

返回值的长度,作用于字符串和列表.

 # msg='hello msg'
 <p>{{msg|length}}</p>

 # 显示结果为:
     9

2.3.3 filesizeformat

将值格式化为一个人类可读的文件尺寸如:13KB,4.1MB,102bytes

  # filesize=54354353
  
  <p>{{filesize|filesizeformat}}</p>

  # 显示结果为51.8MB.

2.3.4 slice 切片

  # msg='hello msg'
        +012345678
         987654321-
  <p>{{msg|slice:"0:2"}}</p>
  # 显示结果为:
    he
 <p>{{msg|slice:"2:-1"}}</p>
  # 显示结果为:
    llo ms

注意,顾头不顾尾

2.3.5 date格式化

# str_time=datetime.datetime.now()  June 12, 2023, 11:40 a.m.
<p>{{ str_time|date:'Y-m-d'}}</p>
# 显示结果为:
2023-06-12

<p>{{ str_time|date:'Y-m-d h:i:s'}}</p>
# 显示结果为: 2023-06-12 11:55:12  # 东八区时间要加8
2023-06-12

格式化字符 描述 示例输出
a 'a.m.''p.m.'(请注意,这与PHP的输出略有不同,因为这包括符合Associated Press风格的期间) 'a.m.'
A 'AM''PM' 'AM'
b 月,文字,3个字母,小写。 'jan'
B 未实现。
c ISO 8601格式。 (注意:与其他格式化程序不同,例如“Z”,“O”或“r”,如果值为naive datetime,则“c”格式化程序不会添加时区偏移量(请参阅datetime.tzinfo) 。 2008-01-02T10:30:00.000123+02:002008-01-02T10:30:00.000123如果datetime是天真的
d 月的日子,带前导零的2位数字。 '01''31'
D 一周中的文字,3个字母。 “星期五”
e 时区名称 可能是任何格式,或者可能返回一个空字符串,具体取决于datetime。 '''GMT''-500''US/Eastern'
E 月份,特定地区的替代表示通常用于长日期表示。 'listopada'(对于波兰语区域,而不是'Listopad'
f 时间,在12小时的小时和分钟内,如果它们为零,则分钟停留。 专有扩展。 '1''1:30'
F 月,文,长。 '一月'
g 小时,12小时格式,无前导零。 '1''12'
G 小时,24小时格式,无前导零。 '0''23'
h 小时,12小时格式。 '01''12'
H 小时,24小时格式。 '00''23'
i 分钟。 '00''59'
I 夏令时间,无论是否生效。 '1''0'
j 没有前导零的月份的日子。 '1''31'
l 星期几,文字长。 '星期五'
L 布尔值是否是一个闰年。 TrueFalse
m 月,2位数字带前导零。 '01''12'
M 月,文字,3个字母。 “扬”
n 月无前导零。 '1''12'
N 美联社风格的月份缩写。 专有扩展。 'Jan.''Feb.''March''May'
o ISO-8601周编号,对应于使用闰年的ISO-8601周数(W)。 对于更常见的年份格式,请参见Y。 '1999年'
O 与格林威治时间的差异在几小时内。 '+0200'
P 时间为12小时,分钟和'a.m。'/'p.m。',如果为零,分钟停留,特殊情况下的字符串“午夜”和“中午”。 专有扩展。 '1 am''1:30 pm' / t3>,'midnight','noon','12:30 pm' / T10>
r RFC 5322格式化日期。 'Thu, 21 Dec 2000 16:01:07 +0200'
s 秒,带前导零的2位数字。 '00''59'
S 一个月的英文序数后缀,2个字符。 'st''nd''rd''th'
t 给定月份的天数。 28 to 31
T 本机的时区。 'EST''MDT'
u 微秒。 000000 to 999999
U 自Unix Epoch以来的二分之一(1970年1月1日00:00:00 UTC)。
w 星期几,数字无前导零。 '0'(星期日)至'6'(星期六)
W ISO-8601周数,周数从星期一开始。 153
y 年份,2位数字。 '99'
Y 年,4位数。 '1999年'
z 一年中的日子 0365
Z 时区偏移量,单位为秒。 UTC以西时区的偏移量总是为负数,对于UTC以东时,它们总是为正。 -4320043200

2.3.6 safe

Django的模板中会对HTML标签和JS等语法标签进行自动转义,原因显而易见,这样是为了安全。但是有的时候我们可能不希望这些HTML元素被转义,比如我们做一个内容管理系统,后台添加的文章中是经过修饰的,这些修饰可能是通过一个类似于FCKeditor编辑加注了HTML修饰符的文本,如果自动转义的话显示的就是保护HTML标签的源文件。为了在Django中关闭HTML的自动转义有两种方式,如果是一个单独的变量我们可以通过过滤器“|safe”的方式告诉Django这段代码是安全的不必转义。

# value=<a href="#">点我</a>
 <p>{{ value|safe }}</p>
 # 显示为:
   点我,如果不加safe,那就是value=<a href="#">点我</a>

2.3.7 truncatechars

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

参数:截断的字符数

<p>{{msg|truncatechars:6}}</p>
# 显示为:
   hel...# 注意6个字符也包含末尾的3个点

2.3.8 truncatewords

在一定数量的字后截断字符串。

tt='hello my name is lpc what your name?'
<p>{{tt|truncatewords:3}}</p>
# 显示结果为:
hello my name ...  # 是按照单词截断,注意末尾的3个点不算作单词



2.3.8 cut

移除values中所有与给出的变量相同的字符串

tt='hello my name is lpc what your name?'
<p>{{tt|cut:'hello'}}</p>
# 显示结果为:
my name is lpc what your name? 


2.3.9 join

用指定分隔符连接列表

# li=['a','b','c','d']
<p>{{li|join:' '}}</p>
# 显示结果为:
   a b c d

2.3.10 timesince(自创建至今多少日子)

将日期格式设为自该日期起的时间(例如,“4天,6小时”)。

采用一个可选参数,它是一个包含用作比较点的日期的变量(不带参数,比较点为现在)。 例如,如果blog_date是表示2017年10月7日午夜的日期实例,并且comment_date是2018年6月7日的日期实例,则以下将返回“8 months”:

# blog_date=datetime.datetime(2017,10,7)
# comment_date=datetime.datetime(2018,6,7)

<p>{{ blog_date|timesince:comment_date}}</p>
# 显示结果为:
  8 months

2.3.11 timeuntil (还剩多少天到期)

似于timesince,除了它测量从现在开始直到给定日期或日期时间的时间。 例如,如果今天是2006年6月1日,而conference_date是保留2006年6月29日的日期实例,则{{ conference_date | timeuntil }}将返回“4周”。

# blog_date=datetime.datetime(2017,10,7)
# comment_date=datetime.datetime(2018,6,20)

<p>{{ comment_date|timesince:blog_date}}</p>
# 显示结果为:
  8 months, 2 weeks

2.3.11 自定义的filter

当内置的过滤器或标签无法满足我们需求时,我们可以自定义,具体操作步骤如下

1、在settings中的INSTALLED_APPS添加当前app的名字,不然django无法找到自定义的过滤器或标签

settings.py

'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'app01.apps.App01Config',
    'app03', # 添加当前app的名字

2、在文件夹app01中创建子文件夹(package)templatetags(文件夹名只能是templatetags)

3、在templatetags新建任意.py文件,如app03_filter.py,在该文件中自定义过滤器或标签,文件内容如下:

  from django import template

  register=template.Library() # 注意变量名必须为register,不可改变

  @register.filter(name='cut')
  def cut(value,arg): # 自定义的过滤器只能定义最多两个参数,针对{{ value1 | filter_multi:value2 }},参数传递为v1=value1,v2=value2
      return value.replace(arg,"")

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


test.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
    {% load app03_filter %}
</head>
<body>
						<p>{{ msg|addSB}}</p>
            <p>{{ msg|cut:'ll'}}</p>
</body>
</html>
# 显示结果为:
hello msg SB
heo msg

3、模板语法之标签

标签是为了在模板中完成一些特殊功能,语法为{% 标签名 %},一些标签还需要搭配结束标签 {% endtag %}

3.1 常用标签之for标签

1、遍历每一个元素:
{% for person in person_list %}
    <p>{{ person.name }}</p>
{% endfor %}

#2、可以利用{% for obj in list reversed %}反向循环。

#3、遍历一个字典:
{% for key,val in dic.items %}
    <p>{{ key }}:{{ val }}</p>
{% endfor %}

#4、循环序号可以通过{{ forloop }}显示 
forloop.counter            当前循环的索引值(从1开始)
forloop.counter0           当前循环的索引值(从0开始)
forloop.revcounter         当前循环的倒序索引值(从1开始)
forloop.revcounter0        当前循环的倒序索引值(从0开始)
forloop.first              当前循环是第一次循环则返回True,否则返回False
forloop.last               当前循环是最后一次循环则返回True,否则返回False
forloop.parentloop         本层循环的外层循环

#5、for标签可以带有一个可选的{% empty %} 从句,在变量person_list为空或者没有被找到时,则执行empty子句
{% for person in person_list %}
    <p>{{ person.name }}</p>

{% empty %}
    <p>sorry,no person here</p>
{% endfor %}

案例

url.py

from django.urls import re_path
from app01 import views

urlpatterns = [
    re_path(r'^test/',views.test)
]

view.py

def test(request):
    names=['egon','kevin']
    dic={'name':'egon','age':18,'sex':'male'}

    list1=[]

    return render(request,'test.html',locals())

test.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<hr>
{% for name in names %}
    <p>{{ forloop.counter0 }} {{ name }}</p>
{% endfor %}
<!--
输出结果为:
0 egon
1 kevin
-->

<hr>
{% for name in names reversed %}
    <p>{{ forloop.revcounter0 }} {{ name }}</p>
{% endfor %}
<!--
输出结果为:
1 kevin
0 egon
-->

<hr>
{% for k,v in dic.items %}
    <p>{{ forloop.counter }} {{ k }} {{ v }}</p>
{% endfor %}
<!--
输出结果为:
1 name egon
2 age 18
3 sex male
-->

<hr>
{% for item in list1 %}
    <p>{{ item }}</p>
    {% empty %}
        <p>sorry,no value here</p>
{% endfor %}
<!--
输出结果为:
sorry,no value here
-->

</body>
</html>

3.2 常用标签之if标签

# 1、注意:
{% if 条件 %}条件为真时if的子句才会生效,条件也可以是一个变量,if会对变量进行求值,在变量值为空、或者视图没有为其传值的情况下均为False

# 2、具体语法
{% if num > 100 or num < 0 %}
    <p>无效</p>
{% elif num > 80 and num < 100 %}
    <p>优秀</p>
{% else %}
    <p>凑活吧</p>
{% endif %}
#3、if语句支持 and 、or、==、>、<、!=、<=、>=、in、not in、is、is not判断。

案例
urls.py

from django.urls import path,register_converter,re_path
from app01 import views

urlpatterns = [
    # 输入http://127.0.0.1:8008/或者http://127.0.0.1:8008/index/都会转发给视图函数index
    re_path(r'^$',views.index),
    re_path(r'^index/$',views.index),
    
    re_path(r'^login/',views.login),

]

views.py

from django.shortcuts import render

def index(request):
    return render(request,'index.html')

def login(request):
    if request.method == 'GET':
        return render(request,'login.html')

    name=request.POST.get('name')
    pwd=request.POST.get('pwd')
    if name == 'egon' and pwd == '123':
        current_user=name
        return render(request,'index.html',locals())
    else:
        msg='账号或密码错误'
        return render(request,'login.html',locals())
在templates目录下新建模板文件index.html与login.html

index.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>首页</title>
</head>
<body>

<h3>首页</h3>
<!--
如果用户已经登录,则current_user变量有值,if判断结果为真,会打印变量current_user的值,为当前登录的用户名
如果用户没有登录,则current_user变量无值,if判断结果为假,会打印a标签要求用户先登录
-->
{% if current_user %}
    <p>当前登录用户为:{{ current_user }}</p>
{% else %}
    <p><a href="/login/">请先登录</a></p>
{% endif %}

</body>
</html>


login.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>登录页面</title>
</head>
<body>

<form action="" method="POST">
    {% csrf_token %}
    <p>用户名:<input type="text" name="name"></p>
    <p>密码:<input type="password" name="pwd"></p>
    <p><input type="submit" value="提交"></p>
</form>
<!--输错账号密码时的提示信息-->
<p style="color: red">{{ msg }}</p>
</body>
</html>

3.3 常用标签之with标签

with标签用来为一个复杂的变量名起别名,如果变量的值来自于数据库,在起别名后只需要使用别名即可,无需每次都向数据库发送请求来重新获取变量的值

{% with li.1.upper as v %}
    {{ v }}
{% endwith %}

3.4 常用标签之csrf_token标签

  # 当用form表单提交POST请求时必须加上标签{% csrf_token%},该标签用于防止跨站伪造请求
  <form action="" method="POST">
      {% csrf_token %}
      <p>用户名:<input type="text" name="name"></p>
      <p>密码:<input type="password" name="pwd"></p>
      <p><input type="submit" value="提交"></p>
  </form>
  # 具体工作原理为:
  # 1、在GET请求到form表单时,标签{% csrf_token%}会被渲染成一个隐藏的input标签,该标签包含了由服务端生成的一串随机字符串,如<input type="hidden" name="csrfmiddlewaretoken" value="dmje28mFo...OvnZ5">
  # 2、在使用form表单提交POST请求时,会提交上述随机字符串,服务端在接收到该POST请求时会对比该随机字符串,对比成功则处理该POST请求,否则拒绝,以此来确定客户端的身份

3.5 自定义标签

和自定义过滤器写在一起:
app03_filter.py

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

test.html

{% load app03_filter %}
{% plus 1 '2' 'abc' %}

3.6 自定义 mark_safe

自定义标签扩展之mark_safe
# 注释:我们可以用内置的标签safe来让标签内容有语法意义,如果我们想让自定义标签处理的结果也有语法意义,则不能使用内置标签safe了,需要使用mark_safe,可以实现与内置标签safe同样的功能
from django.utils.safestring import mark_safe

@register.simple_tag
def my_input_tag(id, name):
    res = "<input type='text' id='%s' name='%s' />" % (id, name)
    return mark_safe(res)

3.7 自定义 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/snippets/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 inclusion_tag_test %}

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

4、模板的继承和导入

在实际开发中,模板文件彼此之间可能会有大量冗余代码,为此django提供了专门的语法来解决这个问题,主要围绕三种标签的使用:include标签、extends标签、block标签,详解如下

4.1、 母板

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  
  {% block page-css %}
  
  {% endblock %}
</head>
<body>

<h1>这是母板的标题</h1>

{% block page-main %}

{% endblock %}
<h1>母板底部内容</h1>
{% block page-js %}

{% endblock %}
</body>
</html>


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

4.2、 继承母板

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

{% extends 'layouts.html' %}
{% block page-main %}

{% endblock %}
{% block page-js %}
  {{block.super}} # 继承父类里面的内容,接着添加

{% endblock %}

4.3 导入

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

{% include 'navbar.html' %}

4.4 总结

#1、标签extends必须放在首行,base.html中block越多可定制性越强

#2、include仅仅只是完全引用其他模板文件,而extends却可以搭配block在引用的基础上进行扩写

#3、变量{{ block.super }} 可以重用父类的内容,然后在父类基础上增加新内容,而不是完全覆盖

#4、为了提升可读性,我们可以给标签{% endblock %} 起一个名字 。例如:
    {% block content %}
    ...
    {% endblock content %}  
#5、在一个模版中不能出现重名的block标签

5、静态文件配置

我们在编写模板文件时,需要大量引用css、js、图片等静态文件,如果我们将这些文件在服务端存放的路径都固定写死那么将非常不利于后期的扩展,我们可以这么做

1、settings.py

STATIC_URL = '/static/' # 找到这一行,然后新增下述代码
STATICFILES_DIRS = [
    os.path.join(BASE_DIR, 'statics'),# 获取静态文件在服务端的绝对路径
]
#STATIC_URL = '/static/'就是为静态文件的绝对路径起了一个别名,以后我们只需要用路径/static/即可

2、在项目根目录下新增文件夹statics,为了更便于管理,可以在statics下新建子文件夹css、js、img等

3、新建模板文件index.html,在该文件中对静态文件的引用如下

# 方法一
<script src="/static/js/jquery-3.3.1.min.js"></script>
# 方法二
{% load static %}
<link rel="stylesheet" href="{% static 'css/my.css' %}">
# 方法三
{% load static %}
<script src="{% get_static_prefix %}js/jquery-3.3.1.min.js"></script>

posted @ 2023-06-14 21:15  FirstReed  阅读(38)  评论(0)    收藏  举报