Django—模板
索引
模板
作为web框架,django提供了模板,用于编写html代码,还可以嵌入模板代码更快更方便的完成页面开发,再通过在视图中渲染模板,将生成最终的html字符串返回给客户端浏览器。模版致力于表达外观,而不是程序逻辑。模板的设计实现了业务逻辑view与显示内容template的分离,一个视图可以使用任意一个模板,一个模板可以供多个视图使用。
模板包含两部分:
-
静态部分,包含html、css、js。
-
动态部分,就是模板语言。
django模板语言,简写dtl,定义在django.template包中。 创建项目后,在"项目名称/settings.py"文件中定义了关于模板的配置。
dirs定义一个目录列表,模板引擎按列表顺序搜索这些目录以查找模板文件,通常是在项目的根目录下创建templates目录。
django处理模板分为两个阶段:
- 1.加载:根据给定的路径找到模板文件,编译后放在内存中。
- 2.渲染:使用上下文数据对模板插值并返回生成的字符串。
为了减少开发人员重复编写加载、渲染的代码,django提供了简写函数render,用于调用模板。
一、模板语言
模板语言包括4种类型,分别是:
- 变量
- 标签
- 过滤器
- 注释
接下来逐个介绍4种类型。
1.1 模板变量
模板变量的作用是计算并输出,变量名必须由字母、数字、下划线(不能以下划线开头)和点组成。
语法如下:
{{变量}}
当模版引擎遇到点如book.title,会按照下列顺序解析:
-
1.字典book['title']
-
2.先属性后方法,将book当作对象,查找属性title,如果没有再查找方法title()
-
3.如果是格式为book.0则解析为列表book[0]
如果变量不存在则插入空字符串''。
在模板中调用方法时不能传递参数。
示例
1)打开booktest/views.py文件,创建视图temp_var。
def temp_var(request): dict = {"title": "字典键值"} book = bookinfo() book.btitle = "对象属性" return render(request, 'booktest/temp_var.html', {"dict": dict, "book": book})
2)打开booktest/urls.py文件,配置url。
url(r'^temp_var$', views.temp_var),
3)修改在templates/booktest下创建temp_var.html。
<html> <head> <title></title> </head> <body> 模板变量:<br/> {{dict.title}}<br/> {{book.btitle}}<br/> </body> </html>
4)运行服务器,在浏览器中访问网址,浏览效果如下图。
1.2 标签
语法如下:
{%代码段%}
for标签语法如下:
{%for item in 列表%} 循环逻辑 {{forloop.counter}}表示当前是第几次循环,从1开始 {%empty%} 列表为空或不存在时执行此逻辑 {%endfor%}
if标签语法如下:
{%if ...%} 逻辑1 {%elif ...%} 逻辑2 {%else%} 逻辑3 {%endif%}
比较运算符如下:
注意:运算符左右两侧不能紧挨变量或常量,必须有空格。
== != < > <= >=
布尔运算符如下:
and or not
示例
1)打开booktest/views.py文件,创建视图temp_tag。
def temp_tag(request): book_list = bookinfo.objects.all() return render(request, 'booktest/temp_var.html', {"book_list": book_list})
2)打开booktest/urls.py文件,配置url。
url(r'^temp_tag/$', views.temp_tags),
3)在templates/booktest下修改temp_var.html。
图书列表:<br/> <ul> {% for book in book_list %} {% if book.id <= 4 %} <li style="background-color: red">{{ book.btitle }}</li> {% elif book.id == 6 %} <li style="background-color: green">{{ book.btitle }}</li> {% else %} <li style="background-color: yellow">{{ book.btitle }}</li> {% endif %} {% empty %} 没有更多图书 {% endfor %} </ul>
4)运行服务器,在浏览器中访问网址,浏览效果如下图:
1.3 过滤器
语法如下:
- 使用管道符号|来应用过滤器,用于进行计算、转换操作,可以使用在变量、标签中。
- 如果过滤器需要参数,则使用冒号:传递参数。
变量|过滤器:参数
长度length,返回字符串包含字符的个数,或列表、元组、字典的元素个数。
默认值default,如果变量不存在时则返回默认值。
data|default:'默认值'
日期date,用于对日期类型的值进行字符串格式化,常用的格式化字符如下:
-
y表示年,格式为4位,y表示两位的年。
-
m表示月,格式为01,02,12等。
-
d表示日, 格式为01,02等。
-
j表示日,格式为1,2等。
-
h表示时,24进制,h表示12进制的时。
-
i表示分,为0-59。
-
s表示秒,为0-59。
value|date:"y年m月j日 h时i分s秒"
示例
1)打开booktest/views.py文件,创建视图temp_filter。
def temp_filter(request): book_list = bookinfo.objects.all() return render(request, 'booktest/temp_var.html', {"book_list": book_list})
2)打开booktest/urls.py文件,配置url。
url(r'^temp_filter/$', views.temp_filter),
3)在templates/booktest下修改temp_var.html。
图书列表:<br/> <ul> {% for book in book_list %} {% if book.btitle|length <= 4 %} <li style="background-color: red"> {{ book.btitle }} ---默认时间格式为: {{ book.bpub_date }} </li> {% else %} <li style="background-color: green"> {{book.btitle}} ---格式化时间为: {{book.bpub_date|date:"y-m-j"}} </li> {% endif %} {% endfor %} </ul>
4)运行服务器,在浏览器访问网址,浏览效果如下图:
1.4 自定义过滤器
过滤器就是python中的函数,注册后就可以在模板中当作过滤器使用,下面以求余为例开发一个自定义过滤器mod。
示例
1)在应用中创建templatetags目录,当前示例为"booktest/templatetags",创建_init_文件,内容为空。
2)在"booktest/templatetags"目录下创建filters.py文件,代码如下:
#导入library类 from django.template import library #创建一个library类对象 register=library() #使用装饰器进行注册 @register.filter(name='mod') #定义求余函数mod,将value对2求余 def mod(value): return value%2 == 0
3)在templates/booktest/temp_var.html中,使用自定义过滤器。
- 首先使用load标签引入模块。
{%load filters%}
- 在遍历时根据编号判断奇偶,代码改为如下:
图书列表:<br/> {% load filters %} <ul> {% for book in book_list %} {% if book.id|mod %} <li style="background-color: red;">{{ book.btitle }}-----{{ book.bpub_date }}</li> {% else %} <li style="background-color: green;">{{ book.btitle }}-----{{ book.bpub_date }}</li> {% endif %} {% endfor %} </ul>
4)运行服务器,浏览效果如下:
过滤器可以接收参数,将booktest/templatetags/filters.py中增加mod_num函数。
#使用装饰器进行注册 @register.filter #定义求余函数mod_num,将value对num求余 def mod_num(value,num): return value%num
5)在templates/booktest/temp_filter.html中修改遍历时判断代码。
图书列表:<br/> {% load filters %} <ul> {% for book in book_list %} {% if book.id|mod_num:3 %} <li style="background-color: red;">{{ book.btitle }}-----{{ book.bpub_date }}</li> {% else %} <li style="background-color: green;">{{ book.btitle }}-----{{ book.bpub_date }}</li> {% endif %} {% endfor %} </ul>
6)运行服务器,浏览效果如下:
1.5 注释
在模板中使用如下模板注释,这段代码不会被编译,不会输出到客户端;html注释只能注释html内容,不能注释模板语言。
1)单行注释语法如下:
{#...#}
注释可以包含任何模版代码,有效的或者无效的都可以。
{# { % if foo % }bar{ % else % } #}
2)多行注释使用comment标签,语法如下:
{%comment%} ... {%endcomment%}
二、模板继承
模板继承和类的继承含义是一样的,主要是为了提高代码重用,减轻开发人员的工作量。
典型应用:网站的头部、尾部信息。
父模板
如果发现在多个模板中某些内容相同,那就应该把这段内容定义到父模板中。
标签block:用于在父模板中预留区域,留给子模板填充差异性的内容,名字不能相同。 为了更好的可读性,建议给endblock标签写上名字,这个名字与对应的block名字相同。父模板中也可以使用上下文中传递过来的数据。
{%block 名称%} 预留区域,可以编写默认内容,也可以没有默认内容 {%endblock 名称%}
子模板
标签extends:继承,写在子模板文件的第一行。
{% extends "父模板路径"%}
子模版不用填充父模版中的所有预留区域,如果子模版没有填充,则使用父模版定义的默认值。
填充父模板中指定名称的预留区域。
{%block 名称%} 实际填充内容 {{block.super}}用于获取父模板中block的内容 {%endblock 名称%}
示例
1)打开booktest/views.py文件,创建视图temp_inherit。
def temp_inherit(request): return render(request, 'booktest/temp_inherit.html', {'book_list':bookinfo.objects.all()})
2)打开booktest/urls.py文件,配置url。
url(r'^temp_inherit$', views.temp_inherit),
3)在templates下创建inherit_base.html。
<h2>这是头</h2> <hr> {%block qu1%} 这是区域一,有默认值 {%endblock qu1%} <hr> {%block qu2%} {%endblock qu2%} <hr> <h2>这是尾</h2>
4)在templates/booktest下创建temp_inherit.html。
{%extends 'booktest/inherit_base.html'%} {%block qu2%} <ul> {%for book in list%} <li>{{book.btitle}}</li> {%endfor%} </ul> {%endblock qu2%}
5)运行服务器,在浏览器中浏览效果如下图。
三、html转义
模板对上下文传递的字符串进行输出时,会对以下字符自动转义。
小于号< 转换为 < 大于号> 转换为 > 单引号' 转换为 ' 双引号" 转换为 " 与符号& 转换为 &
示例
1)打开booktest/views.py文件,创建视图html_escape。
def html_escape(request): return render(request, 'booktest/html_escape.html', {'content':"<h1>html转义</h1>"})
2)打开booktest/urls.py文件,配置url。
url(r'^html_escape$', views.html_escape),
3)在templates/booktest/目录下创建html_escape.html。
{{ content }}
4)运行服务器,在浏览器浏览效果如下图:
转义后标记代码不会被直接解释执行,而是被直接呈现,防止客户端通过嵌入js代码攻击网站.
关闭转义
过滤器escape可以实现对变量的html转义,默认模板就会转义,一般省略。
{{t1|escape}}
过滤器safe:禁用转义,告诉模板这个变量是安全的,可以解释执行。
{{data|safe}}
1)修改templates/booktest/html_escape.html代码如下。
自动转义:{{ content }}<br> 通过safe关闭转移::{{ content|safe }}
刷新浏览器后效果如下图:
标签autoescape:设置一段代码都禁用转义,接受on、off参数。
{%autoescape off%} ... {%endautoescape%}
1)修改templates/booktest/html_escape.html代码如下。
自动转义:{{ content }}<br> 通过safe关闭转移::{{ content|safe }}<br> 标签autoescape关闭转义: {%autoescape off%} {{content}} {%endautoescape%}
刷新浏览器后效果如下图:
字符串字面值
对于在模板中硬编码的html字符串,不会转义。
1)修改templates/booktest/html_escape.html代码如下:
自动转义:{{ content }}<br> 通过safe关闭转移::{{ content|safe }}<br> 标签autoescape关闭转义: {%autoescape off%} {{content}} {%endautoescape%} <hr> 模板硬编码不转义:{{data|default:'<b>hello</b>'}}
2)刷新浏览器后效果如下图:
如果希望出现转义的效果,则需要手动编码转义。
1)修改templates/booktest/html_escape.html代码如下:
自动转义:{{ content }}<br> 通过safe关闭转移::{{ content|safe }}<br> 标签autoescape关闭转义: {%autoescape off%} {{content}} {%endautoescape%} <hr> 模板硬编码不转义:{{data|default:'<b>hello</b>'}} <br> 模板硬编码手动转义:{{data|default:"<b>123</b>"}}
2)刷新浏览器后效果如下图:
四、csrf
csrf全拼为cross site request forgery,译为跨站请求伪造。csrf指攻击者盗用了你的身份,以你的名义发送恶意请求。csrf能够做的事情包括:以你名义发送邮件,发消息,盗取你的账号,甚至于购买商品,虚拟货币转账......造成的问题包括:个人隐私泄露以及财产安全。
csrf示意图如下:
如果想防止csrf,首先是重要的信息传递都采用post方式而不是get方式,接下来就说post请求的攻击方式以及在django中的避免。
示例
1)打开booktest/views.py文件,创建视图login,login_check, post和post_action。
def login(reqeust): return render(reqeust, 'booktest/login.html') def login_check(request): username = request.post.get('username') #获取用户名 password = request.post.get('password') #获取密码 # 校验 if username == 'smart' and password == '123': request.session['username']=name #记住登录用户名 request.session['islogin']=true #判断用户是否已登录 return redirect('/post/') else: return redirect('/login/') def post(request): return render(request, 'booktest/post.html') def post_action(request): if request.session['islogin']: username = request.session['username'] return httpresponse('用户'+username+'发了一篇帖子') else: return httpresponse('发帖失败')
2)打开booktest/urls.py文件,配置url。
url(r'^login/$', views.login), url(r'^login_check/$', views.login_check), url(r'^post/$', views.post), url(r'^post_action/$',views.post_action),
3)在templates/booktest/目录下创建login.html和post.html。
<!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>登录案例</title> </head> <body> <form method="post" action="/login_check/"> 用户名:<input type="text" name="username"/><br/> 密码:<input type="password" name="password"/><br/> <input type="submit" value="提交"/> </form> </body> </html> <!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>发帖页</title> </head> <body> <form method="post" action="/post_action/"> 标题:<input type="text" name="title"/><br/> 内容:<textarea name="content"></textarea> <input type="submit" value="发帖"/> </form> </body> </html>
4)启动运行服务器,采用ip的方式,因为要演示其它ip的请求。
python manage.py runserver 172.16.179.130:8000 (用自己的ip在pycharm终端用命令启动)
5)回到windows中,在浏览器中输入如下网址,将这个标签称为网站a。
http://172.16.179.130:8000/login/
浏览效果如下图:
输入用户名和密码,点击登录,效果如下图:
6)下面使用windows中的iis服务器模拟另外一个网站,创建post.html,复制templates/booktest/post.html内容,并修改action路径。
<html> <head> <title>发帖页</title> </head> <body> <form method="post" action="http://172.16.179.130:8000/post_action/"> 标题:<input type="text" name="title"/><br/> 内容:<textarea name="content"></textarea> <input type="submit" value="发帖"/> </form> </body> </html>
7)在windows中浏览器查看效果如下图,将这个标签称为网站b。
8)django项目中默认启用了csrf保护,现在先禁用,打开项目settings.py文件,注释掉csrf中间件。
9)点击浏览器的第一个标签即网站a,点击"发帖"按钮后如下图:
10)点击游览器的第二个标签即iis网站b,点击“发帖”按钮后如下图:
对比上面两张图,发现无论从网站a还是网站b都可以访问网站a的post_action视图,这就是不安全的。
防止csrf
1)django提供了csrf中间件用于防止csrf攻击,只需要在项目的settings.py中启用csrf中间件即可。
2)回到windows浏览器中,分别在网站a、网站b中点击“提交”按钮,效果一样,如下图:
3)这下麻烦了,因为网站a自己也不能访问了,接下来templates/booktest/post.html内容,在form表单中使用标签csrf_token。
<!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>发帖页</title> </head> <body> <form method="post" action="/post_action/"> {% csrf_token %} 标题:<input type="text" name="title"/><br/> 内容:<textarea name="content"></textarea> <input type="submit" value="发帖"/> </form> </body> </html>
4)回到windows浏览器中,在网站a中点击“提交”按钮,效果如下图:
5)回到windows浏览器中,在网站b中点击“提交”按钮,效果如下图:
好了,django中成功完成csrf防护。
总结
- 以上的演示过程了解即可,不需要重现,以下的内容是重点,必须记住
- 重要信息如金额、积分等,采用post方式传递
- 启用csrf中间件,默认启用
- 在form表单中post提交时加入标签csrf_token
保护原理
加入标签后,可以查看post.html的源代码,发现多了一个隐藏域。
在浏览器的“开发者工具”中查看cookie信息。
说明:当启用中间件并加入标签csrf_token后,会向客户端浏览器中写入一条cookie信息,这条信息的值与隐藏域input元素的value属性是一致的,提交到服务器后会先由csrf中间件进行验证,如果对比失败则返回403页面,而不会进行后续的处理。
五、验证码
在用户注册、登录页面,为了防止暴力请求,可以加入验证码功能,如果验证码错误,则不需要继续处理,可以减轻业务服务器、数据库服务器的压力。
手动实现验证码
接下来的代码不要求手动写出来,因为这种代码在网上可以搜到很多。
1)安装包pillow。
pip install pillow
2)在booktest/views.py文件中,创建视图verify_code。
- 提示1:随机生成字符串后存入session中,用于后续判断。
- 提示2:视图返回mime-type为image/png。
from pil import image, imagedraw, imagefont from django.utils.six import bytesio def verify_code(request): #引入随机函数模块 import random #定义变量,用于画面的背景色、宽、高 bgcolor = (random.randrange(20, 100), random.randrange( 20, 100), 255) width = 100 height = 25 #创建画面对象 im = image.new('rgb', (width, height), bgcolor) #创建画笔对象 draw = imagedraw.draw(im) #调用画笔的point()函数绘制噪点 for i in range(0, 100): xy = (random.randrange(0, width), random.randrange(0, height)) fill = (random.randrange(0, 255), 255, random.randrange(0, 255)) draw.point(xy, fill=fill) #定义验证码的备选值 str1 = 'abcd123efghijk456lmnopqrs789tuvwxyz0' #随机选取4个值作为验证码 rand_str = '' for i in range(0, 4): rand_str += str1[random.randrange(0, len(str1))] #构造字体对象,ubuntu的字体路径为“/usr/share/fonts/truetype/freefont” font = imagefont.truetype("symbol.ttf", 16, encoding="symb") #构造字体颜色 fontcolor = (255, random.randrange(0, 255), random.randrange(0, 255)) #绘制4个字 draw.text((5, 2), rand_str[0], font=font, fill=fontcolor) draw.text((25, 2), rand_str[1], font=font, fill=fontcolor) draw.text((50, 2), rand_str[2], font=font, fill=fontcolor) draw.text((75, 2), rand_str[3], font=font, fill=fontcolor) #释放画笔 del draw #存入session,用于做进一步验证 request.session['verifycode'] = rand_str #内存文件操作 buf = bytesio() #将图片保存在内存中,文件类型为png im.save(buf, 'png') #将内存中的图片数据返回给客户端,mime类型为图片png return httpresponse(buf.getvalue(), 'image/png')
3)打开booktest/urls.py文件,配置url。
url(r'^verify_code$', views.verify_code),
4)运行服务器,在浏览器中浏览效果如下图:
调用验证码
1)在booktest/views.py文件中,创建视图verify_show。
def verify_show(request): return render(request,'booktest/verify_show.html')
2)打开booktest/urls.py文件,配置url。
url(r'^verify_show$', views.verify_show),
3)在templates/booktest/目录下创建verify_show.html。
<form method="post" action="/verify_yz"> {%csrf_token%} <input type="text" name="yzm"> <img id="yzm" src="/verify_code"/> <span id="change">看不清,换一个</span> <br> <input type="submit" value="提交"> </form>
4)运行服务器,在浏览器中浏览效果如下图:
验证
1)在booktest/views.py文件中,创建视图verify_yz。
def verify_yz(request): yzm=request.post.get('yzm') verifycode=request.session['verifycode'] response=httpresponse('no') if yzm==verifycode: response=httpresponse('ok') return response
2)打开booktest/urls.py文件,配置url。
url(r'^verify_yz$', views.verify_yz),
3)回到浏览器后刷新,在文本框中填写验证码,点击提交按钮。
4)浏览效果如下图:
验证码换一张js代码:
<script type="text/javascript"> $(function(){ $('#change').css('cursor','pointer').click(function() { $('#yzm').attr('src',$('#yzm').attr('src')+1) }); }); </script> ... <img id="yzm" src="/verify_code/?1"/> <span id="change">看不清,换一个</span>
六、反向解析
1) 打开booktest/views.py文件,创建视图fan1、fan2。
def fan1(request): return render(request,'booktest/fan1.html') def fan2(request): return httpresponse('fan2')
2)打开booktest/urls.py文件,配置url。
url(r'^fan1$', views.fan1), url(r'^fan2$', views.fan2),
3)在templates/booktest/目录下创建fan1.html。
普通链接:<a href="/fan2/">fan2</a>
4)运行服务器,在浏览器中,浏览效果如下图:
5)点击链接后转向fan2,效果如下图:
6)打开booktest/urls.py文件,修改"fan2"的正则表达式为"fan_show"。
url(r'^fan_show$', views.fan2),
7)打开浏览器,后退一下,刷新后再次点击链接,浏览如下图:
问题就来了:随着功能的增加会出现更多的视图,可能之前配置的正则表达式不够准确,于是就要修改正则表达式,但是正则表达式一旦修改了,之前所有对应的超链接都要修改,真是一件麻烦的事情,而且可能还会漏掉一些超链接忘记修改,有办法让链接根据正则表达式动态生成吗? 答:反向解析。
反向解析应用在两个地方:模板中的超链接,视图中的重定向。
反向解析
要实现反向解析功能,需要如下步骤:
1)在项目的urls.py中为include定义namespace属性。
url(r'^index/',include('booktest.urls',namespace='book')),
2)在booktest/urls.py中为url定义name属性,并修改为fan2。
url(r'^fan2$', views.fan2,name='fan2'),
3)在模板中使用url标签做超链接,此处为templates/booktest/fan1.html文件。
普通链接:<a href="/fan2">fan2</a> <hr> 反向解析:<a href="{%url 'booktest:fan2'%}">fan2</a>
4)回到浏览器中,后退,刷新,查看源文件如下图,两个链接地址一样。
5)在booktest/urls.py中,将fan2修改为fan_show。
url(r'^fan_show$', views.fan2,name='fan2'),
6)回到浏览器中,刷新,查看源文件如下图,两个链接地址不一样。
7)反向解析也可以应用在视图的重定向中。
from django.shortcuts import redirect from django.core.urlresolvers import reverse return redirect(reverse('book:fan2'))
总结:在定义url时,需要为include定义namespace属性,为url定义name属性,使用时,在模板中使用url标签,在视图中使用reverse函数,根据正则表达式动态生成地址,减轻后期维护成本。
url的参数
有些url配置项正则表达式中是有参数的,接下来讲解如何传递参数。
情况一:位置参数
1)在booktest/urls.py中,修改fan2如下:
url(r'^fan(\d+)_(\d+)$', fan3, name='fan2'),
2)在booktest/views中,定义视图fan3如下:
def fan3(request, a, b): return httpresponse(a+b)
3)修改templates/booktest/fan1.html文件如下:
普通链接:<a href="/book/fan2_3">fan2</a> <hr> 反向解析:<a href="{%url 'book:fan2' 2 3%}">fan2</a>
4)回到浏览器中,刷新,查看源文件如下图:
使用重定向传递位置参数格式如下:
return redirect(reverse('book:fan2', args=(2,3)))
情况二:关键字参数
1)在booktest/urls.py中,修改fan2如下:
url(r'^fan(?p<id>\d+)_(?p<age>\d+)$',fan4, name='fan2'),
2)在booktest/views中,定义视图fan4如下:
def fan4(request, id, age): return httpresponse(id+age)
3)修改templates/booktest/fan1.html文件如下:
普通链接:<a href="/book/fan100_18">fan2</a> <hr> 反向解析:<a href="{%url 'book:fan2' id=100 age=18%}">fan2</a>
4)回到浏览器中,刷新,查看源文件如下图:
使用重定向传递关键字参数格式如下:
return redirect(reverse('book:fan2', kwargs={'id':100,'age':18}))