Flask 是一個 Python 實現(xiàn)的 Web 開發(fā)微框架, 有豐富的生態(tài)資源侍芝。本文從一段官方的示例代碼通過一步步打斷點方式解釋 Flask 內(nèi)部的運行機(jī)制储笑,在一些關(guān)鍵概念會有相關(guān)解釋呐粘,這些前提概念對整體理解 Flask框架十分重要澈侠,本文基于flask 0.1 版本進(jìn)行相應(yīng)的分析打肝。
官方demo示例
from flask import Flask
app = Flask(__name__)
@app.route('/')
def hello_world():
return 'Hello World!'
if __name__ == '__main__':
app.run()
第一行import Flask 類對象惭蹂,這個無需解釋。跳到第二行罚缕,使用當(dāng)前模塊的名字傳入Flask類中艇纺,并實例化Flask對象,我們在這個地方打個斷點邮弹,看看Flask類別里有什么黔衡。
上圖可以看出,F(xiàn)lask類中定義jinia_options腌乡、request_class盟劫、response_class等屬性,這里我們不關(guān)系具體作用与纽,先看看源碼中Flask 是不是定義了這些屬性侣签。
class Flask(object):
# 省略了注釋部分
# flask 用作請求對象的類
request_class = Request
# flask 用作響應(yīng)對象的類
response_class = Response
# 靜態(tài)文件路徑
static_path = '/static'
# 密鑰塘装,用于加密 session 或其它涉及安全的東西
secret_key = None
#存儲session對象數(shù)據(jù)的cookie名稱
session_cookie_name = 'session'
# Jinja2環(huán)境的一些選項
jinja_options = dict(
autoescape=True,
extensions=['jinja2.ext.autoescape', 'jinja2.ext.with_']
)
這部分是初始化Flask類中默認(rèn)設(shè)置的一些屬性,其實通過名字也可以大概知道每個屬性的作用影所”碾龋看到這個地方時是不是一臉懵逼,Request猴娩、Response 是什么東西阴幌,有什么作用?Jinja2 又是什么東西胀溺? 別急裂七,下面慢慢解釋這幾個東西的作用。
Request && Response
from werkzeug import Request as RequestBase, Response as ResponseBase
class Request(RequestBase):
"""The request object used by default in flask. Remembers the
matched endpoint and view arguments.
It is what ends up as :class:`~flask.request`. If you want to replace
the request object used you can subclass this and set
:attr:`~flask.Flask.request_class` to your subclass.
"""
def __init__(self, environ):
RequestBase.__init__(self, environ)
self.endpoint = None # 請求對象的端點
self.view_args = None # 請求視圖函數(shù)的參數(shù)
class Response(ResponseBase):
"""The response object that is used by default in flask. Works like the
response object from Werkzeug but is set to have a HTML mimetype by
default. Quite often you don't have to create this object yourself because
:meth:`~flask.Flask.make_response` will take care of that for you.
If you want to replace the response object used you can subclass this and
set :attr:`~flask.Flask.request_class` to your subclass.
"""
default_mimetype = 'text/html'
通過源碼的注釋我們可以知道仓坞,Request背零、Response都只是對 werkzeug 庫的Request、Response 進(jìn)行了一層包裝并加入一些屬性无埃。先說一下它們的作用:
- Request 的作用:是 flask 默認(rèn)的請求對象徙瓶,用來記住匹配的endpoint(端點)和view arguments(視圖參數(shù))
- Response 的作用:是 flask 默認(rèn)的響應(yīng)對象,默認(rèn)設(shè)置MIME類型默認(rèn)設(shè)置為HTML(即是定義了內(nèi)容類型 Content-Type 返回的類型為HTML), 默認(rèn)情況下嫉称,你不用自己創(chuàng)建這個對象侦镇,因為下面的 make_response 函數(shù)會幫你處理。
看完上面源碼和解釋织阅,是不是有新的疑問了壳繁,werkzeug又是什么?端點又是什么概念荔棉?額闹炉,werkzeug的作用真的很大,整個框架都是基于它實現(xiàn)的润樱,下面會有一個部分專門說明這個庫渣触。說明: werkzeug 庫和 jinja2 是 flask 的兩個依賴庫,會分出一篇文章專門介紹壹若,這篇文章重點是整個 Flask 內(nèi)部的機(jī)制嗅钻,建議看到對應(yīng)部分,先提前去讀兩個依賴庫的文章店展。
接下來繼續(xù)下一步的調(diào)試养篓,初始化一個Flask類, 先看看 Flask 類的初始化函數(shù):
def _get_package_path(name):
"""Returns the path to a package or cwd if that cannot be found."""
# 獲取 模塊包 路徑,被 Flask 引用
try:
return os.path.abspath(os.path.dirname(sys.modules[name].__file__))
except (KeyError, AttributeError):
return os.getcwd()
class Flask(object):
# 簡化版赂蕴,已經(jīng)去掉注釋觉至,建議看源碼注釋加上這個理解
def __init__(self, package_name):
# 設(shè)置是否開啟調(diào)試模式,若開啟睡腿,會監(jiān)視項目代碼變化语御,
# 開發(fā)服務(wù)器重載 Flask 應(yīng)用
self.debug = False
# 包或模塊的名字,模塊的名稱將會因其作為單獨應(yīng)用啟動還是作為模塊導(dǎo)入而不同
# Flask 才知道到哪去找模板席怪、靜態(tài)文件
self.package_name = package_name
# 根據(jù) Flask 傳入的__name__, 找到項目的根路徑
self.root_path = _get_package_path(self.package_name)
# 已注冊的所有視圖函數(shù)的字典应闯,字典的鍵是函數(shù)名稱,可以用來生成URL(url_for函數(shù))
# 字典的值是函數(shù)本身, 想要注冊視圖函數(shù)挂捻,可以使用 route 裝飾器
self.view_functions = {}
# 所有已注冊錯誤處理程序的字典, 字典的鍵是一個整數(shù)類型(integer)的錯誤碼
# 字典的值是對應(yīng)錯誤的函數(shù)碉纺,想要注冊錯誤handler, 可以使用 errorhandler 裝飾器
self.error_handlers = {}
# 請求開始進(jìn)入時,但還請求還沒調(diào)度前調(diào)用的函數(shù)列表刻撒,也就是預(yù)處理操作
# 可用于打開數(shù)據(jù)庫連接或獲取當(dāng)前登錄用戶骨田,使用 before_route 裝飾器注冊
self.before_request_funcs = []
# 請求結(jié)束時調(diào)用的函數(shù)列表,這些函數(shù)會被傳入當(dāng)前響應(yīng)對象并將其修改或替換它声怔。
self.after_request_funcs = []
# 不帶參數(shù)調(diào)用的函數(shù)列表态贤,用于填充模板上下文,每個應(yīng)該返回更新模板上下文的字典
# 默認(rèn)的處理器用來注入session醋火、request和g
self.template_context_processors = [_default_template_ctx_processor]
# 使用 werkzeug 的 routing.Map, 用于給應(yīng)用增加一些URL規(guī)則悠汽,
# URL規(guī)則形成一個Map實例的過程中會生成對應(yīng)的正則表達(dá)式,可以進(jìn)行URL匹配
self.url_map = Map()
# 添加靜態(tài)文件的URL映射規(guī)則
# SharedDataMiddleware中間件用來為程序添加處理靜態(tài)文件的能力
if self.static_path is not None:
self.url_map.add(Rule(self.static_path + '/<filename>',
build_only=True, endpoint='static'))
if pkg_resources is not None:
target = (self.package_name, 'static')
else:
target = os.path.join(self.root_path, 'static')
self.wsgi_app = SharedDataMiddleware(self.wsgi_app, {
self.static_path: target # URL路徑和實際文件目錄(static文件夾)的映射
})
# Jinja2 環(huán)境芥驳,它通過jinja_options創(chuàng)建柿冲,加載器(loader)通過
self.jinja_env = Environment(loader=self.create_jinja_loader(),
**self.jinja_options)
# 將url_for, get_flashed_message 作為全局對象填充入模板上下文中,可以在模板中調(diào)用它們
self.jinja_env.globals.update(
url_for=url_for,
get_flashed_messages=get_flashed_messages
)
上面就是一個 Flask 實例化時所做的工作兆旬,其實就是保存了一下配置信息假抄,設(shè)置了一下Jinja2 環(huán)境,并定義了一個URL 映射對象丽猬,用于映射URL 到函數(shù)之間的關(guān)系宿饱。
總結(jié)
開篇主要講了初始化一個Flask對象,內(nèi)部做了什么工作宝鼓,配置了一下信息刑棵,設(shè)置了一下Jinja2 環(huán)境,定義了一些視圖函數(shù)存放的數(shù)據(jù)結(jié)構(gòu)愚铡,定義了一個Map對象用于后面保存URL 和 視圖函數(shù)的映射關(guān)系蛉签。接下來會有更多關(guān)于werkzeug, jinja2 和 WSGI 相關(guān)文章放出來,敬請期待Aち取0帷!
提示
本文會同步flask 0.1版本的代碼注釋在github, 請通過https://github.com/guoweikuang/flask-annotate 查看整個flask 0.1 的代碼注釋邑雅,目前沒有完成所有注釋