全棧工程師開(kāi)發(fā)手冊 （作者：欒鵬）
架構系列文章

在python web框架的世界里充滿(mǎn)了選擇。有Django，Flask，Pyramid，Tornado，Bottle，Diesel，Pecan，Falcon等等的來(lái)吸引開(kāi)發(fā)者的注意。作為一個(gè)開(kāi)發(fā)者，你想要從中選擇一個(gè)框架來(lái)幫你完成項目，并且能繼續做大事情。

關(guān)于讀者該選擇哪個(gè)框架，這里不做選擇，本文帶大家入門(mén)flask框架。

安裝Flask

pip install flask

完整的flask開(kāi)發(fā)環(huán)境可能需要內容組件比較多, 這里可以先安裝下面的組件
將所有相關(guān)的包放置在一個(gè)txt文件，如：requires.txt,內容如下：

alembicamqpbilliardcelerycertifichardetFlaskFlask-MigrateFlask-ScriptFlask-SessionFlask-SQLAlchemyFlask-WTFJinja2kombuMako

然后直接安裝pip install -r requires.txt

hello world

打開(kāi)一個(gè)Python文件，輸入下面的內容并運行該文件。然后訪(fǎng)問(wèn)localhost:5000，我們應當可以看到瀏覽器上輸出了Hello Flask!。

from flask import Flaskapp = Flask(__name__)@app.route('/')def hello_world():    return 'Hello Flask!'if __name__ == '__main__':    app.run(debug=True)      # 設置debug=True是為了讓代碼修改實(shí)時(shí)生效，而不用每次重啟加載

app初始化簡(jiǎn)介

# Flask實(shí)例的源碼：class Flask(_PackageBoundObject):    def __init__(self, import_name,  # 指定應用的名字和工程目錄，默認為_(kāi)_name__                static_path=None,  #  是靜態(tài)文件存放的路徑，會(huì )賦值給static_url_path參數                static_url_path=None,  # 設置靜態(tài)文件路由的前綴，默認為“/static”                static_folder='static', # 靜態(tài)文件的存放目錄， 默認值為"static"                template_folder='templates', # 模板文件的存放目錄，默認值為"templates"                instance_path=None, # 設置配置文件的路徑，在instance_relative_config=True情況下生效                instance_relative_config=False # 設置為T(mén)rue表示配置文件相對于實(shí)例路徑而不是根路徑                root_path=None) # #  應用程序的根路徑

運行測試app程序

app.run(host=None, # 設置ip，默認127.0.0.1        port=None, # 設置端口，默認5000        debug=None)  # 設置是否開(kāi)啟調試，默認false

app的配置參數詳解

flask實(shí)例化后會(huì )加載默認的配置參數，我們也可以手動(dòng)設置參數更新默認的配置，常用的參數選項有：

DEBUG:是否啟用debug模式，默認false。TESTING :啟用/禁止測試模式SECRET_KEY :密鑰,在啟用session等很重要SESSION_COOKIE_NAME :設置保存的session在 cookie 的名稱(chēng)SESSION_COOKIE_DOMAIN：設置會(huì )話(huà)的域，默認是當前的服務(wù)器，因為Session是一個(gè)全局的變量，可能應用在多個(gè)app中；設置這個(gè)參數必須設置SERVER_NAME,否則報錯PERMANENT_SESSION_LIFETIME：session失效時(shí)間，作為一個(gè) datetime.timedelta 對象，也可以用秒表示；LOGGER_NAME:日志記錄器的名稱(chēng)，默認__name__;SERVER_NAME:服務(wù)器的名稱(chēng)以及端口，需要它為了支持子域名 (如: 'myapp.dev:5000')MAX_CONTENT_LENGTH:設置一個(gè)請求所允許的最大的上傳數據量，單位字節；SEND_FILE_MAX_AGE_DEFAULT:  設置調用send_file發(fā)送文件的緩存時(shí)間；TRAP_HTTP_EXCEPTIONS:如果這個(gè)值被設置為 True ， Flask 不會(huì )執行 HTTP 異常的錯誤處理， 而是像對待其它異常一樣，通過(guò)異常棧讓它冒泡;PREFERRED_URL_SCHEME:設置URL 模式用于 URL 生成。如果沒(méi)有設置 URL 模式，默認將為 http 。JSON_AS_ASCII：默認情況下 Flask 序列化對象成 ascii 編碼的 JSON。 如果不對該配置項就行設置的話(huà)，Flask 將不會(huì )編碼成 ASCII 保持字符串原樣，并且返回 unicode 字符串。jsonfiy 會(huì )自動(dòng)按照 utf-8 進(jìn)行編碼并且傳輸。JSON_SORT_KEYS：默認情況下 Flask 將會(huì )依鍵值順序的方式序列化 JSON。 這樣做是為了確保字典哈希種子的獨立性，返回值將會(huì )一致不會(huì )造成 額外的 HTTP 緩存。通過(guò)改變這個(gè)變量可以重載默認行為。 這是不推薦也許會(huì )帶來(lái)緩存消耗的性能問(wèn)題。JSONIFY_PRETTYPRINT_REGULAR：如果設置成 True (默認下)，jsonify 響應對象將會(huì )完美地打印。

通過(guò)加載文件設置參數

app.config.from_pyfile("./config.cfg") # 指定參數的路徑，內容按行書(shū)寫(xiě),配置文件放置在與app的同目錄下def from_pyfile(self, filename, silent=False):    filename = os.path.join(self.root_path, filename)    pass

通過(guò)類(lèi)設置參數
注意所有的參數必須大寫(xiě)，否則無(wú)效。

class Config(object):  # 該類(lèi)可以定義在一個(gè)py文件中然后導入py文件    """配置參數"""    DEBUG = Trueapp.config.from_object(Config)

通過(guò)json格式的文件配置

# config.json{    'DEBUG' = True}app.config.from_json('config.json') # 配置文件放置在與app的同目錄下

直接操作app.config對象進(jìn)行設置

app.config["DEBUG"] = True或者app.config.update({    "DEBUG":True,})

獲取配置參數的方法

app.config.get("DEBUG")或者current_app.config.get("DEBUG")

路由

路由通過(guò)使用Flask的app.route裝飾器來(lái)設置，這類(lèi)似Java的Spring Web MVC

@app.route('/',methods=["POST","GET"])def index():    return 'Index Page'@app.route('/hello')def hello():    return 'Hello, World'

route裝飾器會(huì )將其裝飾的視圖函數注冊到app的視圖函數集中，其主要有三個(gè)參數：
路徑變量

路由路徑也就是請求網(wǎng)址中不是固定的網(wǎng)址，而是含有變量的網(wǎng)址。（注意，這里指的并不是網(wǎng)址？后面的get方式發(fā)送是參數，而是向www.example.com/1/test/中的1這個(gè)參數，也可能是其他的數值。）路徑變量的語(yǔ)法是/path/<converter:varname>。在路徑變量前還可以使用可選的轉換器，有以下幾種轉換器。

下面是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):   # 函數參數中接收傳遞的參數    # show the post with the given id, the id is an integer    return 'Post %d' % post_id

查看URL

在Web程序中常常需要獲取某個(gè)試圖函數對應的URL，在Flask中需要使用url_for(‘方法名’)來(lái)構造對應方法的URL

@app.route('/loginto')def login():    print(url_for('login'))   # 會(huì )打印出網(wǎng)址中主機名后的部分    return 'Hello world!'

HTTP參數獲取

使用route裝飾器的methods參數可以設置接收get或者post方法

@app.route('/login', methods=['GET', 'POST'])def login():    if request.method == 'POST':        print(request.form['userid'])  # 獲取post穿過(guò)來(lái)的參數        dict = request.form.to_dict()  # 將請求參數解析成字典        print(dict['userid'])        return 'POST'    else:        print(request.args['userid'])   # 獲取get傳過(guò)來(lái)的參數        dict = request.args.to_dict()  # 將請求參數解析成字典        print(dict['userid'])        return 'GET'

獲取上傳文件

利用Flask也可以方便的獲取表單中上傳的文件，只需要利用 request 的files屬性即可，這也是一個(gè)字典，包含了被上傳的文件。如果想獲取上傳的文件名，可以使用filename屬性，不過(guò)需要注意這個(gè)屬性可以被客戶(hù)端更改，所以并不可靠。更好的辦法是利用werkzeug提供的secure_filename方法來(lái)獲取安全的文件名。

from flask import requestfrom 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')  # 可以向模板傳遞參數

靜態(tài)文件

Web程序中常常需要處理靜態(tài)文件，在Flask中需要使用url_for函數并指定static端點(diǎn)名和文件名。在上面的例子中url_for可以獲取函數名對應的網(wǎng)址。下面的例子，url_for是寫(xiě)在html模板中的，實(shí)際的文件應是static/logo.png文件。

h1 { margin: 0 0 30px 0; background: url({{ url_for('static', filename='logo.png') }}) }

模板生成

Flask默認使用Jinja2作為模板，Flask會(huì )自動(dòng)配置Jinja 模板，所以我們不需要其他配置了。默認情況下，模板文件需要放在templates文件夾下。

使用 Jinja 模板，只需要使用render_template函數并傳入模板文件名和參數名即可。

from flask import render_template@app.route('/hello/')@app.route('/hello/<name>')def hello(name=None):    return render_template('hello.html', name=name)

相應的模板文件如下。

<!doctype html><title>Hello from Flask</title>{% if name %}  <h1>Hello {{ name }}!</h1>{% else %}  <h1>Hello, World!</h1>{% endif %}

日志輸出

Flask 為我們預配置了一個(gè) Logger，我們可以直接在程序中使用。這個(gè)Logger是一個(gè)標準的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。使用方法很簡(jiǎn)單，直接看官方的例子就行了。下面的例子是如何獲取cookie。

from flask import request@app.route('/')def index():    username = request.cookies.get('username')    # 使用 cookies.get(key) 代替 cookies[key] 避免    # 得到 KeyError 如果cookie不存在

如果需要發(fā)送cookie給客戶(hù)端，參考下面的例子。

from flask import make_response@app.route('/')def index():    resp = make_response(render_template(...))    resp.set_cookie('username', 'the username')    return resp

重定向和錯誤

redirect和abort函數用于重定向和返回錯誤頁(yè)面。

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()

默認的錯誤頁(yè)面是一個(gè)空頁(yè)面，如果需要自定義錯誤頁(yè)面，可以使用errorhandler裝飾器。

from flask import render_template@app.errorhandler(404)def page_not_found(error):    return render_template('page_not_found.html'), 404

自定義響應http頭

默認情況下，Flask會(huì )根據函數的返回值自動(dòng)決定如何處理響應：如果返回值是響應對象，則直接傳遞給客戶(hù)端；如果返回值是字符串，那么就會(huì )將字符串轉換為合適的響應對象。我們也可以自己決定如何設置響應對象，方法也很簡(jiǎn)單，使用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來(lái)管理用戶(hù)會(huì )話(huà)。Sesison 是建立在 Cookie 技術(shù)上的，不過(guò)在 Flask 中，我們還可以為 Session 指定密鑰，這樣存儲在 Cookie 中的信息就會(huì )被加密，從而更加安全。直接看 Flask 官方的例子吧。

from flask import Flask, session, redirect, url_for, escape, requestapp = 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'

模板簡(jiǎn)介

這里簡(jiǎn)單的介紹一下Jinja 模板的使用方法

模板標簽

其實(shí)Jinja 模板和其他語(yǔ)言和框架的模板類(lèi)似，反正都是通過(guò)某種語(yǔ)法將HTML文件中的特定元素替換為實(shí)際的值。如果使用過(guò)JSP、Thymeleaf 等模板，應該可以非常容易的學(xué)會(huì )使用 Jinja模板。

其實(shí)從上面的例子中我們應該可以看到Jinja 模板的基本語(yǔ)法了。代碼塊需要包含在{% %}塊中，例如下面的代碼。

{% extends 'layout.html' %}{% block title %}主頁(yè){% endblock %}{% block body %}    <div class="jumbotron">        <h1>主頁(yè)</h1>    </div>{% endblock %}

雙大括號中的內容不會(huì )被轉義，所有內容都會(huì )原樣輸出，它常常和其他輔助函數一起使用。下面是一個(gè)例子。

<a class="navbar-brand" href={{ url_for('index') }}>Flask小例子</a>

繼承

模板可以繼承其他模板，我們可以將布局設置為父模板，讓其他模板繼承，這樣可以非常方便的控制整個(gè)程序的外觀(guān)。

例如這里有一個(gè)layout.html模板，它是整個(gè)程序的布局文件。

<!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>這是頁(yè)腳</p></div><script src="{{ url_for('static',filename='js/jquery.js') }}"></script><script src="{{ url_for('static',filename='js/bootstrap.js') }}"></script></body></html>

其他模板可以這么寫(xiě)。對比一下面向對象編程的繼承概念，我們可以很容易的理解。

{% extends 'layout.html' %}{% block title %}主頁(yè){% endblock %}{% block body %}    <div class="jumbotron">        <h1>主頁(yè)</h1>        <p>本項目演示了Flask的簡(jiǎn)單使用方法，點(diǎn)擊導航欄上的菜單條查看具體功能。</p>    </div>{% endblock %}

控制流

條件判斷可以這么寫(xiě)，類(lèi)似于JSP標簽中的Java 代碼，{% %}中也可以寫(xiě)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)的話(huà)可以這么寫(xiě)，和在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代碼都可以寫(xiě)在模板里，如果希望從模板中引用其他文件的函數，需要顯式將函數注冊到模板中

寫(xiě)在最后

順便說(shuō)，通過(guò)Flask 我也了解了Python 語(yǔ)言的執行速度。我們都知道編譯器編譯出來(lái)的代碼執行起來(lái)要比解釋器解釋代碼要快大約幾十倍到幾千倍不等。以前學(xué)Java的時(shí)候，感覺(jué)Java 慢，主要原因就是等待編譯時(shí)間比較長(cháng)。相對來(lái)說(shuō)用Python寫(xiě)腳本就很塊了，因為沒(méi)有編譯過(guò)程。

但是從Flask的運行速度來(lái)看，我切身感受到了Python 執行確實(shí)不快。舉個(gè)例子，在Spring中寫(xiě)一個(gè)控制器，接受HTTP參數，并顯示到頁(yè)面上，如果程序編譯完之后，這個(gè)顯示過(guò)程基本是瞬時(shí)的。但是同樣的需求在Flask中，我居然可以感覺(jué)到明顯的延遲（大概幾百毫秒的等待時(shí)間）。所以，如果你想寫(xiě)一個(gè)比較快的Web程序，還是用Java或者JVM語(yǔ)言吧，雖然看著(zhù)土，性能確實(shí)杠杠的 。