004:pythonFlask框架学习
https://www.jianshu.com/p/6452596c4edb
Flask是由python实现的一个web微框架,让我们可以使用Python语言快速实现一个网站或Web服务。而且有对应的python3及python2版本。首先这边选择的是python3.6,虽然python3在网上好像名声不咋地,而且一度有文章说python3正在毁灭Python,但是反正是别人选的,也就将就了。
在网上看别人下载个flask很麻烦,反正我的很简单,windows环境下的
1.安装Flask
pip install flask
2.目录结构
通过别人的目录大致了解一下flask框架的目录结构。
flask
-demo
/
├ run
.py # 应用启动程序
├ config
.py # 环境配置
├ requirements
.txt # 列出应用程序依赖的所有Python包
├ tests
/# 测试代码包
│ ├ __init__
.py
│ └ test_
*.py # 测试用例
└ myapp
/
├ admin
/# 蓝图目录
├
static/
│ ├ css
/# css文件目录
│ ├ img
/# 图片文件目录
│ └ js
/# js文件目录
├ templates
/# 模板文件目录
├ __init__
.py
├ forms
.py # 存放所有表单,如果多,将其变为一个包
├ models
.py # 存放所有数据模型,如果多,将其变为一个包
└ views
.py # 存放所有视图函数,如果多,将其变为一个包
3.开始 Hello world
最简单的测试
fromflask
importFlask
app
=Flask
(__name__
)
@app
.route
('/')
defindex():
return
'Hello World'
if__name__
=='__main__':
app
.debug
=True
# 设置调试模式,生产模式的时候要关掉debug
app
.run
()
这是flask框架制作的一个最小的应用。使用python运行后访问localhost:5000就能看到网页显示Hello world。
这里首先引入了Flask类,然后给这个类创建了一个实例,name代表这个模块的名字。因为这个模块是直接被运行的所以此时name的值是main。然后用route()这个修饰器定义了一个路由,告诉flask如何访问该函数。最后用run()函数使这个应用在服务器上运行起来。
4.模板
Flask的模板功能是基于Jinja2模板引擎实现的。让我们来实现一个例子吧。创建一个新的Flask运行文件(你应该不会忘了怎么写吧),代码如下:
fromflask
importFlask
fromflask
importrender_template
app
=Flask
(__name__
)
@app
.route
('/hello')
@app
.route
('/hello/<name>')
defhello(
name
=None):
return
render_template
('hello.html',name
=name
)
if__name__
=='__main__':
app
.run
(host
='0.0.0.0',debug
=True)
这段代码”hello()”函数并不是直接返回字符串,而是调用了”render_template()”方法来渲染模板。方法的第一个参数”hello.html”指向你想渲染的模板名称,第二个参数”name”是你要传到模板去的变量,变量可以传多个。
那么这个模板”hello.html”在哪儿呢,变量参数又该怎么用呢?接下来我们创建模板文件。在当前目录下,创建一个子目录”templates”(注意,一定要使用这个名字)。然后在”templates”目录下创建文件”hello.html”,内容如下:
<!doctype html>
<title>Hello Sample
</title>
{% if name %}
<h1>
Hello {{ name }}!
</h1>
{% else %}
<h1>
Hello World!
</h1>
{% endif %}
这段代码是不是很像HTML?接触过其他模板引擎的朋友们肯定立马秒懂了这段代码。它就是一个HTML模板,根据”name”变量的值,显示不同的内容。变量或表达式由”{{ }}”修饰,而控制语句由”{% %}”修饰,其他的代码,就是我们常见的HTML。
让我们打开浏览器,输入”http://localhost:5000/hello/man”,页面上即显示大标题”Hello man!”。我们再看下页面源代码
<!doctype html>
<title>Hello from Flask
</title>
<h1>
Hello man!
</h1>
果然,模板代码进入了”Hello {{ name }}!”分支,而且变量”{{ name }}”被替换为了”man”。Jinja2的模板引擎还有更多强大的功能,包括for循环,过滤器等。模板里也可以直接访问内置对象如request, session等。对于Jinja2的细节,感兴趣的朋友们可以自己去查查。
5.模板继承
一般我们的网站虽然页面多,但是很多部分是重用的,比如页首,页脚,导航栏之类的。对于每个页面,都要写这些代码,很麻烦。Flask的Jinja2模板支持模板继承功能,省去了这些重复代码。让我们基于上面的例子,在”templates”目录下,创建一个名为”layout.html”的模板:
<!doctype html>
<title>Hello Sample
</title>
<link rel="stylesheet" type="text/css" href="{{ url_for('static', filename='style.css') }}">
<div class="page">
{% block body %}
{% endblock %}
</div>
再修改之前的”hello.html”,把原来的代码定义在”block body”中,并在代码一开始”继承”上面的”layout.html”:
{%extends
"layout.html"
%}
{%block body
%}
{%if
name
%}
<h1>Hello {{
name
}}!</h1>
{%else
%}
<h1>Hello World!</h1>
{%endif
%}
{% endblock
%}
打开浏览器,再看下”http://localhost:5000/hello/man”页面的源码。
<!doctype html>
<title>Hello Sample
</title>
<link rel="stylesheet" type="text/css" href="/static/style.css">
<div class="page">
<h1>
Hello man!
</h1>
</div>
你会发现,虽然”render_template()”加载了”hello.html”模板,但是”layout.html”的内容也一起被加载了。而且”hello.html”中的内容被放置在”layout.html”中”{% block body %}”的位置上。形象的说,就是”hello.html”继承了”layout.html”。
6. HTML自动转义
我们看下下面的代码:
@app.route
('/')
defindex():
return
'<div>Hello %s</div>'
%
'<em>Flask</em>'
打开页面,你会看到”Hello Flask”字样,而且”Flask”是斜体的,因为我们加了”em”标签。但有时我们并不想让这些HTML标签自动转义,特别是传递表单参数时,很容易导致HTML注入的漏洞。我们把上面的代码改下,引入”Markup”类:
fromflask
importFlask
,Markup
app
=Flask
(__name__
)
@app
.route
('/')
defindex():
return
Markup
('<div>Hello %s</div>')%
'<em>Flask</em>'
再次打开页面,”em”标签显示在页面上了。Markup还有很多方法,比如”escape()”呈现HTML标签, “striptags()”去除HTML标签。这里就不一一列举了。
7.Request 对象
from flask
importFlask
,url_for
,request
,render_template
@app.route('/login',methods
=['POST','GET'])
def
login():
if
request
.method
=='POST':
if
request
.form
['user']==
'admin':
return
'Admin login successfully!'
else:
return
'No such user!'
title
=request
.args
.get('title','Default')
return
render_template('login.html',
title
=title
)
if__name__
=="__main__":
app
.run(debug
=True
)
简单解释下,request中”method”变量可以获取当前请求的方法,即”GET”, “POST”, “DELETE”, “PUT”等;”form”变量是一个字典,可以获取Post请求表单中的内容,在上例中,如果提交的表单中不存在”user”项,则会返回一个”KeyError”,你可以不捕获,页面会返回400错误(想避免抛出这”KeyError”,你可以用request.form.get(“user”)来替代)。而”request.args.get()”方法则可以获取Get请求URL中的参数,该函数的第二个参数是默认值,当URL参数不存在时,则返回默认值。
在当前目录下,创建一个子目录”templates”(注意,一定要使用这个名字)。然后在”templates”目录下,添加
layout.html
<!doctype html>
<title>Hello Sample
</title>
<link rel="stylesheet" type="text/css" href="{{ url_for('static', filename='style.css') }}">
<div class="page">
{% block body %}
{% endblock %}
</div>
login.html
{%extends
"layout.html"
%}
{%block body
%}
<form name="login" action="/login" method="post">
Hello {{ title
}}, please login by:
<input type="text" name="user" />
</form>
{% endblock
%}
8.会话session
会话可以用来保存当前请求的一些状态,以便于在请求之前共享信息。
from flask
importFlask
,url_for
,request
,render_template
,redirect
,session
@app.route('/login',methods
=['POST','GET'])
def
login():
if
request
.method
=='POST':
if
request
.form
['user']==
'admin':
session
['user']=
request
.form
['user']
return
'Admin login successfully!'
else:
return
'No such user!'
if
'user'
in
session
:
return
'Hello %s!'
%
session
['user']
else:
title
=request
.args
.get('title','Default')
return
render_template('login.html',
title
=title
)
@app.route('/logout')
def
logout():
session
.pop('user',None
)
return
redirect(url_for('login'))
app
.secret_key
='123456'
if__name__
=="__main__":
app
.run(debug
=True
)
你可以看到,”admin”登陆成功后,再打开”login”页面就不会出现表单了。然后打开logout页面可以登出。session对象的操作就跟一个字典一样。特别提醒,使用session时一定要设置一个密钥”app.secret_key”,如上例。不然你会得到一个运行时错误,内容大致是”RuntimeError: the session is unavailable because no secret key was set”。密钥要尽量复杂,最好使用一个随机数,这样不会有重复,上面的例子不是一个好密钥。
9.构建响应
在之前的例子中,请求的响应我们都是直接返回字符串内容,或者通过模板来构建响应内容然后返回。其实我们也可以先构建响应对象,设置一些参数(比如响应头)后,再将其返回。修改下上例中的Get请求部分:
from flask
importFlask
,url_for
,request
,render_template
,redirect
,session
,make_response
@app.route('/login',methods
=['POST','GET'])
def
login():
if
request
.method
=='POST':
...
if
'user'
in
session
:
...
else:
title
=request
.args
.get('title','Default')
response
=make_response(render_template('login.html',
title
=title
),200)
response
.headers
['key']=
'value'
return
response
if__name__
=="__main__":
app
.run(debug
=True
)
打开浏览器调试,在Get请求用户未登录状态下,你会看到响应头中有一个”key”项。”make_response”方法就是用来构建response对象的,第二个参数代表响应状态码,缺省就是200。
10.Cookie的使用
提到了Session,当然也要介绍Cookie喽,毕竟没有Cookie,Session就根本没法用(不知道为什么?查查去)。Flask中使用Cookie也很简单:
fromflask
importFlask
,url_for
,request
,render_template
,redirect
,session
,make_response
import time
@app
.route
('/login',methods
=['POST','GET'])
deflogin():
response
=None
if
request
.method
=='POST':
if
request
.form
['user']==
'admin':
session
['user']=
request
.form
['user']
response
=make_response
('Admin login successfully!')
response
.set_cookie
('login_time',time
.strftime
('%Y-%m-%d %H:%M:%S'))
...
else:
if
'user'
in
session
:
login_time
=request
.cookies
.get
('login_time')
response
=make_response
('Hello %s, you logged in on %s'%
(
session
['user'],login_time
))
...
return
response
app
.secret_key
='123456'
if__name__
=="__main__":
app
.run
(debug
=True)
这次我们引入了”time”模块来获取当前系统时间。我们在返回响应时,通过”response.set_cookie()”函数,来设置Cookie项,之后这个项值会被保存在浏览器中。这个函数的第三个参数(max_age)可以设置该Cookie项的有效期,单位是秒,不设的话,在浏览器关闭后,该Cookie项即失效。
在请求中,”request.cookies”对象就是一个保存了浏览器Cookie的字典,使用其”get()”函数就可以获取相应的键值。
11.错误处理
使用”abort()”函数可以直接退出请求,返回错误代码:
rom flask
importFlask
,abort
app
=Flask
(__name__
)
@app
.route
('/error')
deferror():
abort
(404)
if__name__
=="__main__":
app
.run
(debug
=True)
上例会显示浏览器的404错误页面。有时候,我们想要在遇到特定错误代码时做些事情,或者重写错误页面,可以用下面的方法:
rom flask
importFlask
,abort
app
=Flask
(__name__
)
@app
.errorhandler
(404)
defpage_not_found(
error
):
return
render_template
('404.html'),404
if__name__
=="__main__":
app
.run
(debug
=True)
不过,在实际开发过程中,我们并不会经常使用”abort()”来退出,常用的错误处理方法一般都是异常的抛出或捕获。装饰器”@app.errorhandler()”除了可以注册错误代码外,还可以注册指定的异常类型。让我们来自定义一个异常:
classInvalidUsage(Exception):
status_code
=400
def
__init__(self,
message
,status_code
=400):
Exception.
__init__
(self)
self.
message
=message
self.
status_code
=status_code
@app.errorhandler
(InvalidUsage)
definvalid_usage(
error
):
response
=make_response
(error
.message
)
response
.status_code
=error
.status_code
return
response
@app.route
('/exception')
defexception():
raise
InvalidUsage('No privilege to access the resource',
status_code
=403)
if__name__
=="__main__":
app
.run
(debug
=True)
我们在上面的代码中定义了一个异常”InvalidUsage”,同时我们通过装饰器”@app.errorhandler()”修饰了函数”invalid_usage()”,装饰器中注册了我们刚定义的异常类。这也就意味着,一但遇到”InvalidUsage”异常被抛出,这个”invalid_usage()”函数就会被调用。
12.url重定向
Flask的URL规则是基于Werkzeug的路由模块。模块背后的思想是基于 Apache 以及更早的 HTTP 服务器主张的先例,保证优雅且唯一的 URL。
@app.route
('/projects/')
defprojects():
return
'The project page'
@app.route
('/about')
defabout():
return
'The about page'
访问第一个路由不带/时,Flask会自动重定向到正确地址。
访问第二个路由时末尾带上/后Flask会直接报404 NOT FOUND错误。
重定向”redirect()”函数的使用在上面例子中已有出现。作用就是当客户端浏览某个网址时,将其导向到另一个网址。常见的例子,比如用户在未登录时浏览某个需授权的页面,我们将其重定向到登录页要求其登录先。
redirect()”的第二个参数时HTTP状态码,可取的值有301, 302, 303, 305和307,默认即302(为什么没有304?留给大家去思考)。