一、路由
路由通过使用Flask的app.route装饰器来设置,这类似Java的Spring Web MVC。
@app.route('/',methods=["POST","GET"])
def index():
return 'Index Page'
@app.route('/hello')
def hello():
return 'Hello, World'
route装饰器会将其装饰的视图函数注册到app的视图函数集中,其主要有三个参数:
1. 路径变量
路由路径也就是请求网址中不是固定的网址,而是含有变量的网址。
(注意,这里指的并不是网址?后面的get方式发送是参数,而是向www.example.com/1/test/中的1这个参数,也可能是其他的数值。)路径变量的语法是/path/
转换器 | 作用 |
---|---|
string | 默认选项,接受除了斜杠之外的字符串 |
int | 接受整数 |
float | 接受浮点数 |
path | 和string类似,不过可以接受带斜杠的字符串 |
any | 匹配任何一种转换器 |
uuid | 接受UUID字符串 |
示例:
@app.route('/user/')
def show_user_profile(username):
# show the user profile for that user
return 'User %s' % username
@app.route('/post/')
def show_post(post_id): # 函数参数中接收传递的参数
# show the post with the given id, the id is an integer
return 'Post %d' % post_id
2. 查看URL
在Web程序中常常需要获取某个试图函数对应的URL,在Flask中需要使用url_for(‘方法名’)来构造对应方法的URL:
@app.route('/loginto')
def login():
print(url_for('login')) # 会打印出网址中主机名后的部分
return 'Hello world!'
3. HTTP参数获取
使用route装饰器的methods参数可以设置接收get或者post方法:
@app.route('/login', methods=['GET', 'POST'])
def login():
if request.method == 'POST':
print(request.form['userid']) # 获取post穿过来的参数
dict = request.form.to_dict() # 将请求参数解析成字典
print(dict['userid'])
return 'POST'
else:
print(request.args['userid']) # 获取get传过来的参数
dict = request.args.to_dict() # 将请求参数解析成字典
print(dict['userid'])
return 'GET'
4. 获取上传文件
利用Flask也可以方便的获取表单中上传的文件,只需要利用 request 的files属性即可,这也是一个字典,包含了被上传的文件。如果想获取上传的文件名,可以使用filename属性,不过需要注意这个属性可以被客户端更改,所以并不可靠。更好的办法是利用werkzeug提供的secure_filename方法来获取安全的文件名。
from flask import request
from werkzeug.utils import secure_filename
@app.route('/upload', methods=['GET', 'POST'])
def upload_file():
if request.method == 'POST':
f = request.files['the_file']
f.save('/var/www/uploads/' + secure_filename(f.filename))
5. 返回内容
返回字符串、元组等可以直接返回。
1)返回字典使用
from flask import jsonify
@app.route('/test', methods=['GET', 'POST'])
def test():
dict={'a':'a','b':'aaa'}
return jsonify(dict)
2) 返回模板
from flask import render_template
@app.route('/test', methods=['GET', 'POST'])
def test():
return render_template('index.html',name='aaa') # 可以向模板传递参数
二、静态文件
Web程序中常常需要处理静态文件,在Flask中需要使用url_for函数并指定static端点名和文件名。在上面的例子中url_for可以获取函数名对应的网址。下面的例子,url_for是写在html模板中的,实际的文件应是static/logo.png文件。
CSS:
h1 { margin: 0 0 30px 0; background: url({{ url_for('static', filename='logo.png') }}) }
三、模板生成
Flask默认使用Jinja2作为模板,Flask会自动配置Jinja 模板,所以我们不需要其他配置了。默认情况下,模板文件需要放在templates文件夹下。
使用 Jinja 模板,只需要使用render_template函数并传入模板文件名和参数名即可。
from flask import render_template
@app.route('/hello/')
@app.route('/hello/')
def hello(name=None):
return render_template('hello.html', name=name)
相应的模板文件如下。
Hello from Flask
{% if name %}
Hello {{ name }}!
{% else %}
Hello, World!
{% endif %}
四、日志输出
Flask 为我们预配置了一个 Logger,我们可以直接在程序中使用。这个Logger是一个标准的Python Logger,所以我们可以向标准Logger那样配置它。
app.logger.debug('A value for debugging')
app.logger.warning('A warning occurred (%d apples)', 42)
app.logger.error('An error occurred')
六、Cookies
Flask也可以方便的处理Cookie。使用方法很简单,直接看官方的例子就行了。下面的例子是如何获取cookie。
from flask import request
@app.route('/')
def index():
username = request.cookies.get('username')
# 使用 cookies.get(key) 代替 cookies[key] 避免
# 得到 KeyError 如果cookie不存在
如果需要发送cookie给客户端:
from flask import make_response
@app.route('/')
def index():
resp = make_response(render_template(...))
resp.set_cookie('username', 'the username')
return resp
七、重定向和错误
redirect和abort函数用于重定向和返回错误页面。
from flask import abort, redirect, url_for
@app.route('/')
def index():
return redirect(url_for('login'))
@app.route('/login')
def login():
abort(401)
this_is_never_executed()
默认的错误页面是一个空页面,如果需要自定义错误页面,可以使用errorhandler装饰器。
from flask import render_template
@app.errorhandler(404)
def page_not_found(error):
return render_template('page_not_found.html'), 404
八、自定义响应http头
默认情况下,Flask会根据函数的返回值自动决定如何处理响应:如果返回值是响应对象,则直接传递给客户端;如果返回值是字符串,那么就会将字符串转换为合适的响应对象。我们也可以自己决定如何设置响应对象,方法也很简单,使用make_response函数即可。
@app.errorhandler(404)
def not_found(error):
resp = make_response(render_template('error.html'), 404)
resp.headers['X-Something'] = 'A value'
return resp
九、Sessions
我们可以使用全局对象session来管理用户会话。Sesison 是建立在 Cookie 技术上的,不过在 Flask 中,我们还可以为 Session 指定密钥,这样存储在 Cookie 中的信息就会被加密,从而更加安全。
from flask import Flask, session, redirect, url_for, escape, request
app = Flask(__name__)
@app.route('/')
def index():
if 'username' in session:
return 'Logged in as %s' % escape(session['username'])
return 'You are not logged in'
@app.route('/login', methods=['GET', 'POST'])
def login():
if request.method == 'POST':
session['username'] = request.form['username']
return redirect(url_for('index'))
return '''
'''
@app.route('/logout')
def logout():
# remove the username from the session if it's there
session.pop('username', None)
return redirect(url_for('index'))
# set the secret key. keep this really secret:
app.secret_key = 'A0Zr98j/3yX R~XHH!jmN]LWX/,?RT'