在python web框架的世界里充滿了選擇,。有Django,,F(xiàn)lask,,Pyramid,,Tornado,Bottle,,Diesel,,Pecan,F(xiàn)alcon等等的來吸引開發(fā)者的注意,。作為一個開發(fā)者,,你想要從中選擇一個框架來幫你完成項目,并且能繼續(xù)做大事情,。 關(guān)于讀者該選擇哪個框架,,這里不做選擇,本文帶大家入門flask框架,。 安裝Flask
完整的flask開發(fā)環(huán)境可能需要內(nèi)容組件比較多, 這里可以先安裝下面的組件
然后直接安裝 hello world打開一個Python文件,,輸入下面的內(nèi)容并運行該文件。然后訪問localhost:5000,,我們應(yīng)當可以看到瀏覽器上輸出了Hello Flask!,。
app初始化簡介
運行測試app程序
app的配置參數(shù)詳解flask實例化后會加載默認的配置參數(shù),,我們也可以手動設(shè)置參數(shù)更新默認的配置,常用的參數(shù)選項有:
通過加載文件設(shè)置參數(shù)
通過類設(shè)置參數(shù)
通過json格式的文件配置
直接操作app.config對象進行設(shè)置
獲取配置參數(shù)的方法
路由路由通過使用Flask的app.route裝飾器來設(shè)置,,這類似Java的Spring Web MVC
route裝飾器會將其裝飾的視圖函數(shù)注冊到app的視圖函數(shù)集中,其主要有三個參數(shù):
|
轉(zhuǎn)換器 | 作用 |
---|---|
string | 默認選項,,接受除了斜杠之外的字符串 |
int | 接受整數(shù) |
float | 接受浮點數(shù) |
path | 和string類似,不過可以接受帶斜杠的字符串 |
any | 匹配任何一種轉(zhuǎn)換器 |
uuid | 接受UUID字符串 |
下面是Flask官方的例子,。
@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
在Web程序中常常需要獲取某個試圖函數(shù)對應(yīng)的URL,,在Flask中需要使用url_for(‘方法名’)來構(gòu)造對應(yīng)方法的URL
@app.route('/loginto')
def login():
print(url_for('login')) # 會打印出網(wǎng)址中主機名后的部分
return 'Hello world!'
使用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'
利用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))
返回字符串,、元組等可以直接返回。
返回字典使用
from flask import jsonify
@app.route('/test', methods=['GET', 'POST'])
def test():
dict={'a':'a','b':'aaa'}
return jsonify(dict)
返回模板
from flask import render_template
@app.route('/test', methods=['GET', 'POST'])
def test():
return render_template('index.html',name='aaa') # 可以向模板傳遞參數(shù)
Web程序中常常需要處理靜態(tài)文件,,在Flask中需要使用url_for函數(shù)并指定static端點名和文件名,。在上面的例子中url_for可以獲取函數(shù)名對應(yīng)的網(wǎng)址,。下面的例子,,url_for是寫在html模板中的,實際的文件應(yīng)是static/logo.png文件,。
h1 { margin: 0 0 30px 0; background: url({{ url_for('static', filename='logo.png') }}) }
Flask默認使用Jinja2作為模板,,F(xiàn)lask會自動配置Jinja 模板,所以我們不需要其他配置了,。默認情況下,模板文件需要放在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是一個標準的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')
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()
默認的錯誤頁面是一個空頁面,,如果需要自定義錯誤頁面,,可以使用errorhandler裝飾器。
from flask import render_template
@app.errorhandler(404)
def page_not_found(error):
return render_template('page_not_found.html'), 404
默認情況下,,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
我們可以使用全局對象session來管理用戶會話,。Sesison 是建立在 Cookie 技術(shù)上的,不過在 Flask 中,,我們還可以為 Session 指定密鑰,,這樣存儲在 Cookie 中的信息就會被加密,從而更加安全,。直接看 Flask 官方的例子吧,。
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'
這里簡單的介紹一下Jinja 模板的使用方法
模板標簽
其實Jinja 模板和其他語言和框架的模板類似,反正都是通過某種語法將HTML文件中的特定元素替換為實際的值,。如果使用過JSP,、Thymeleaf 等模板,應(yīng)該可以非常容易的學(xué)會使用 Jinja模板,。
其實從上面的例子中我們應(yīng)該可以看到Jinja 模板的基本語法了,。代碼塊需要包含在{% %}塊中,例如下面的代碼,。
{% extends 'layout.html' %}
{% block title %}主頁{% endblock %}
{% block body %}
<div class="jumbotron">
<h1>主頁</h1>
</div>
{% endblock %}
雙大括號中的內(nèi)容不會被轉(zhuǎn)義,,所有內(nèi)容都會原樣輸出,它常常和其他輔助函數(shù)一起使用,。下面是一個例子,。
<a class="navbar-brand" href={{ url_for('index') }}>Flask小例子</a>
繼承
模板可以繼承其他模板,我們可以將布局設(shè)置為父模板,,讓其他模板繼承,,這樣可以非常方便的控制整個程序的外觀。
例如這里有一個layout.html模板,,它是整個程序的布局文件。
<!DOCTYPE html>
<html>
<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>{% block title %}{% endblock %}</title>
<link rel="stylesheet" href="{{ url_for('static',filename='css/bootstrap.css') }}"/>
<link rel="stylesheet" href="{{ url_for('static',filename='css/bootstrap-theme.css') }}"/>
</head>
<body>
<div class="container body-content">
{% block body %}{% endblock %}
</div>
<div class="container footer">
<hr>
<p>這是頁腳</p>
</div>
<script src="{{ url_for('static',filename='js/jquery.js') }}"></script>
<script src="{{ url_for('static',filename='js/bootstrap.js') }}"></script>
</body>
</html>
其他模板可以這么寫,。對比一下面向?qū)ο缶幊痰睦^承概念,我們可以很容易的理解,。
{% extends 'layout.html' %}
{% block title %}主頁{% endblock %}
{% block body %}
<div class="jumbotron">
<h1>主頁</h1>
<p>本項目演示了Flask的簡單使用方法,點擊導(dǎo)航欄上的菜單條查看具體功能,。</p>
</div>
{% endblock %}
控制流
條件判斷可以這么寫,,類似于JSP標簽中的Java 代碼,{% %}中也可以寫Python代碼,。下面是Flask官方文檔的例子。
<div class=metanav>
{% if not session.logged_in %}
<a href="{{ url_for('login') }}">log in</a>
{% else %}
<a href="{{ url_for('logout') }}">log out</a>
{% endif %}
</div>
循環(huán)的話可以這么寫,,和在Python中遍歷差不多,。
<tbody>
{% for key,value in data.items() %}
<tr>
<td>{{ key }}</td>
<td>{{ value }}</td>
</tr>
{% endfor %}
<tr>
<td>文件</td>
<td></td>
</tr>
</tbody>
需要注意不是所有的Python代碼都可以寫在模板里,,如果希望從模板中引用其他文件的函數(shù),需要顯式將函數(shù)注冊到模板中
順便說,,通過Flask 我也了解了Python 語言的執(zhí)行速度,。我們都知道編譯器編譯出來的代碼執(zhí)行起來要比解釋器解釋代碼要快大約幾十倍到幾千倍不等。以前學(xué)Java的時候,,感覺Java 慢,,主要原因就是等待編譯時間比較長。相對來說用Python寫腳本就很塊了,,因為沒有編譯過程。
但是從Flask的運行速度來看,,我切身感受到了Python 執(zhí)行確實不快。舉個例子,,在Spring中寫一個控制器,接受HTTP參數(shù),,并顯示到頁面上,,如果程序編譯完之后,這個顯示過程基本是瞬時的,。但是同樣的需求在Flask中,我居然可以感覺到明顯的延遲(大概幾百毫秒的等待時間),。所以,,如果你想寫一個比較快的Web程序,還是用Java或者JVM語言吧,,雖然看著土,,性能確實杠杠的 。
|