flask 原始碼解析：簡介

flask 簡介

Flask 官網上對它的定位是一個“微” python web 開發框架。

Flask is a micro web development framework for Python.

python 語言 web 框架很多：Django、Tornado、webpy、bottle……，flask 的特點是簡單可擴充套件。簡單有幾個方面，比如它只實現 web 框架最核心的功能，保持功能的簡潔；還有一個就是程式碼量少，核心程式碼 app.py 檔案只有 2k+ 行。可擴充套件就是允許第三方外掛來擴充功能，比如資料庫可以使用 Flask-SQLAlchemy，快取可以使用 Flask-Cache 等等。

下面這段程式碼是 flask 官方文件給出的 hello world 版本的 flask 應用：

要理解 flask 的原始碼，必須有一定的 python 基礎（對 decorator、magic method、iterator、generator 概念比較熟悉），不然的話，會有些吃力。另外一個必須理解的概念是 WSGI，簡單來說就是一套 web server 和 web 框架/web 應用之間的協議。可以閱讀我之前寫的 python wsgi 簡介 和翻譯的 什麼是 web 框架 ，或者自行搜尋相關資料，熟悉這部分的內容。

NOTE：本系列文章分析的 flask 版本號是 0.12，其他版本可能會有出入。

兩個依賴

flask 有兩個核心依賴庫：werkzeug 和 jinja，而 werkzeug 又是兩者中更核心的。

werkzeug 負責核心的邏輯模組，比如路由、請求和應答的封裝、WSGI 相關的函式等；jinja 負責模板的渲染，主要用來渲染返回給使用者的 html 檔案內容。

模板（template）是和 web 框架相對獨立的內容，比如 jinja 不是隻能用在 web 應用中，而 web 應用也可以不處理模板（比如返回 raw text 或者 json/xml 結構資料，而不是 html 頁面）。flask 直接使用 jinja2 而不是把這部分也做成可擴充套件的看起來有悖它的設計原則，我個人的理解是：flask 是個寫網頁的 web 框架，不像 flask-restful 可以專門做 json/xml 資料介面，必須提供模板功能，不然使用者就無法使用。而如果不繫結一個模板庫的話，有三種方法：自己寫一個模板引擎、封裝一個可擴充套件的模板層，使用者可以自己選擇具體的模板引擎、或者讓使用者自己處理模板。但是這些方法要麼增加實現的複雜度，要麼增加了使用的複雜度。

werkzeug

werkzeug 的定位並不是一個 web 框架，而是 HTTP 和 WSGI 相關的工具集，可以用來編寫 web 框架，也可以直接使用它提供的一些幫助函式。

Werkzeug is an HTTP and WSGI utility library for Python.

werkzeug 提供了 python web WSGI 開發相關的功能：

• 路由處理：怎麼根據請求中的 url 找到它的處理函式
• request 和 response 封裝：可以更好地讀取 request 的資料，也容易生成響應
• 一個自帶的 WSGI server，可以用來測試環境執行自己的應用

比如，我們可以使用 werkzeug 編寫一個簡單的 hello world 的 WSGI app：

除了和 web WSGI 相關的功能，werkzeug 還實現了很多非常有用的資料結構和函式。比如用來處理一個 key 對應多個值的 MultiDict，不支援修改的字典 ImmutableDict ，可以快取類屬性的 cache_property 等等。如果有機會，可以寫篇文章講講 werkzeug 的原始碼（好吧，我又挖坑了）。

Jinja2

官網上，對 Jinja 的 介紹已經很清晰，它就是一個 python 實現的模板引擎，功能非常豐富。

Jinja2 is a full featured template engine for Python. It has full unicode support, an optional integrated sandboxed execution environment, widely used and BSD licensed.

Jinja 功能比較豐富，支援 unicode 解析、自動 HTML escape 防止 XSS 攻擊、繼承、變數、過濾器、流程邏輯支援、python 程式碼邏輯整合等等。具體的功能和使用請參考官網的文件，這裡就不介紹了。

如何讀程式碼

閱讀原始碼是件耗時而又沒有直接產出的事情，所以必須要事先明確目的，不然會白白浪費時間。對於我來說，一般需要閱讀原始碼有幾個可能的原因：

1. 在學習語言的時候遇到瓶頸，想借鑑和學習優秀專案的風格、思路、經驗等。比如在剛學習一門語言的語法之後，會發現自己還是不能很好地使用它。這個時候，我一般會找一個專案來練手，然後閱讀一些優秀專案的程式碼來參考它們的實現
2. 工作中需要經常用到某個專案。比如你從事 web 開發， 經常使用 flask/Django 框架，熟悉它們的原始碼可以讓你在使用的時候更能得心應手和有的放矢，而且遇到問題之後也能更容易去定位
3. 自己想深入理解某個領域的知識。對某個領域非常感興趣，想理解它的內部實現原理，或者乾脆自己想造個輪子，那麼閱讀原始碼是很好的途徑

知道了自己要閱讀程式碼，那麼怎麼去讀程式碼呢？

1. 最重要的是不要畏懼！記得我剛開始工作的時候，總覺得那些專案都是非常優秀的人編寫的高質量程式碼，自己可望不可即，還沒有深入之前就認為自己肯定看不懂，更不用去修改程式碼了。但其實，只要是人寫的程式碼就會有 bug，也會有可以改進的地方，要有好的心態：欣賞好的程式碼設計，但也要學會識別不好的程式碼
2. 不要鉅細無遺！閱讀程式碼最怕的是在細節中糾纏不清，不僅拖慢進度也會大挫信心。所有的程式碼大概都是樹形的結構，開始最重要的是理清樹幹的結構，知道這個樹大概有幾個部分，分別負責什麼功能，它們之間的大概關係是啥就夠了。萬萬不可取的是盯著某個小樹葉研究半天，或者被藤蔓遮住了視線
3. 帶著問題去閱讀！這個建議不僅適用於程式碼，也適用於所有的閱讀。如果在閱讀之前有了明確的目的，比如想知道程式是怎麼啟動的、某個 bug 是什麼時候引入的、某個功能是怎麼實現的…… 帶著這些問題，目的性強，理解也更快
4. 簡化再簡化！如果程式碼的量級比較大，要學會簡化問題，找到程式碼的核心。有幾種方法：忽略細節，比如你知道某個資料夾是不同的驅動，那麼只要理解它們的介面和大致功能就行，把細節當做黑盒；執行最簡單的程式碼，通過一個 hello world 或者 quickstart 提供的例子作為入口和理解單位；找到之前的版本，有了版本控制和網路，很多專案很容易找到歷史版本，比如理解 linux 的話很多書會推薦 0.X 的版本，它的核心都在，理解也更方便
5. 雙管齊下！理解一個很大專案無外乎兩種方法——從上到下和從下到上。對於比較複雜的專案，靈活使用這兩種方法，從上到下容易找到脈絡，但有時候因為多型或者執行時載入的原因很難往下跟蹤；從下到上掌握東西更牢固，更有針對性，但會看不清專案的全貌，不容理解整體。兩種方法同時使用，直到它們出現交匯，做到融會貫通

希望說了這麼多，能對大家以後讀程式碼和工作有點幫助。那麼，從下一篇文章，我們就正式開始 flask 原始碼之旅了！