一炭晒、路由
路由通過使用Flask的app.route裝飾器來設(shè)置栋豫,這類似Java的Spring Web MVC木缝。
@app.route('/',methods=["POST","GET"])
def index():
return 'Index Page'
@app.route('/hello')
def hello():
return 'Hello, World'
route裝飾器會將其裝飾的視圖函數(shù)注冊到app的視圖函數(shù)集中沾乘,其主要有三個參數(shù):
1. 路徑變量
路由路徑也就是請求網(wǎng)址中不是固定的網(wǎng)址,而是含有變量的網(wǎng)址妖胀。
(注意,這里指的并不是網(wǎng)址惠勒?后面的get方式發(fā)送是參數(shù)赚抡,而是向www.example.com/1/test/中的1這個參數(shù),也可能是其他的數(shù)值纠屋。)路徑變量的語法是/path/<converter:varname>涂臣。在路徑變量前還可以使用可選的轉(zhuǎn)換器,有以下幾種轉(zhuǎn)換器售担。
轉(zhuǎn)換器 | 作用 |
---|---|
string | 默認(rèn)選項赁遗,接受除了斜杠之外的字符串 |
int | 接受整數(shù) |
float | 接受浮點數(shù) |
path | 和string類似,不過可以接受帶斜杠的字符串 |
any | 匹配任何一種轉(zhuǎn)換器 |
uuid | 接受UUID字符串 |
示例:
@app.route('/user/<username>')
def show_user_profile(username):
# show the user profile for that user
return 'User %s' % username
@app.route('/post/<int:post_id>')
def show_post(post_id): # 函數(shù)參數(shù)中接收傳遞的參數(shù)
# show the post with the given id, the id is an integer
return 'Post %d' % post_id
2. 查看URL
在Web程序中常常需要獲取某個試圖函數(shù)對應(yīng)的URL族铆,在Flask中需要使用url_for(‘方法名’)來構(gòu)造對應(yīng)方法的URL:
@app.route('/loginto')
def login():
print(url_for('login')) # 會打印出網(wǎng)址中主機(jī)名后的部分
return 'Hello world!'
3. HTTP參數(shù)獲取
使用route裝飾器的methods參數(shù)可以設(shè)置接收get或者post方法:
@app.route('/login', methods=['GET', 'POST'])
def login():
if request.method == 'POST':
print(request.form['userid']) # 獲取post穿過來的參數(shù)
dict = request.form.to_dict() # 將請求參數(shù)解析成字典
print(dict['userid'])
return 'POST'
else:
print(request.args['userid']) # 獲取get傳過來的參數(shù)
dict = request.args.to_dict() # 將請求參數(shù)解析成字典
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. 返回內(nèi)容
返回字符串箩做、元組等可以直接返回。
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') # 可以向模板傳遞參數(shù)
二妥畏、靜態(tài)文件
Web程序中常常需要處理靜態(tài)文件邦邦,在Flask中需要使用url_for函數(shù)并指定static端點名和文件名安吁。在上面的例子中url_for可以獲取函數(shù)名對應(yīng)的網(wǎng)址。下面的例子燃辖,url_for是寫在html模板中的鬼店,實際的文件應(yīng)是static/logo.png文件。
CSS:
h1 { margin: 0 0 30px 0; background: url({{ url_for('static', filename='logo.png') }}) }
三黔龟、模板生成
Flask默認(rèn)使用Jinja2作為模板妇智,F(xiàn)lask會自動配置Jinja 模板,所以我們不需要其他配置了氏身。默認(rèn)情況下巍棱,模板文件需要放在templates文件夾下。
使用 Jinja 模板蛋欣,只需要使用render_template函數(shù)并傳入模板文件名和參數(shù)名即可航徙。
from flask import render_template
@app.route('/hello/')
@app.route('/hello/<name>')
def hello(name=None):
return render_template('hello.html', name=name)
相應(yīng)的模板文件如下。
<!doctype html>
<title>Hello from Flask</title>
{% if name %}
<h1>Hello {{ name }}!</h1>
{% else %}
<h1>Hello, World!</h1>
{% endif %}
四陷虎、日志輸出
Flask 為我們預(yù)配置了一個 Logger到踏,我們可以直接在程序中使用。這個Logger是一個標(biāo)準(zhǔn)的Python Logger泻红,所以我們可以向標(biāo)準(zhǔn)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不存在
如果需要發(fā)送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函數(shù)用于重定向和返回錯誤頁面。
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()
默認(rèn)的錯誤頁面是一個空頁面惨恭,如果需要自定義錯誤頁面秉馏,可以使用errorhandler裝飾器。
from flask import render_template
@app.errorhandler(404)
def page_not_found(error):
return render_template('page_not_found.html'), 404
八脱羡、自定義響應(yīng)http頭
默認(rèn)情況下萝究,F(xiàn)lask會根據(jù)函數(shù)的返回值自動決定如何處理響應(yīng):如果返回值是響應(yīng)對象,則直接傳遞給客戶端锉罐;如果返回值是字符串帆竹,那么就會將字符串轉(zhuǎn)換為合適的響應(yīng)對象。我們也可以自己決定如何設(shè)置響應(yīng)對象脓规,方法也很簡單栽连,使用make_response函數(shù)即可。
@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 技術(shù)上的绢陌,不過在 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 '''
<form method="post">
<p><input type=text name=username>
<p><input type=submit value=Login>
</form>
'''
@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'