在flask框架中肯尺,我們經(jīng)常會遇到endpoint這個東西续滋,最開始也沒法理解這個到底是做什么的惨远。最近正好在研究Flask的源碼谜悟,也就順帶了解了一下這個endpoint
首先,我們看一個例子:
@app.route('/user/')defuser(name):return'Hello,%s'%name
這個是我們在用flask框架寫網(wǎng)站中最常用的北秽。
通過看源碼葡幸,我們可以發(fā)現(xiàn):
函數(shù)等效于
defuser(name)return'Hello,%s'%nameapp.add_url_rule('/user/','user', user)
這個add_url_rule函數(shù)在文檔中是這樣解釋的:
add_url_rule(*args, **kwargs)
Connects a URL rule. Works exactly like the route() decorator. If a view_func is provided it will be registered with the endpoint.
add_url_rule有如下參數(shù):
rule– the URL rule as string
endpoint– the endpoint for the registered URL rule. Flask itself assumes the name of the view function as endpoint
view_func– the function to call when serving a request to the provided endpoint
options– the options to be forwarded to the underlying Rule object. A change to Werkzeug is handling of method options. methods is a list of methods this rule should be limited to (GET, POST etc.). By default a rule just listens for GET (and implicitly HEAD). Starting with Flask 0.6, OPTIONS is implicitly added and handled by the standard request handling.
拋開options這個參數(shù)不談,我們看看前三個參數(shù)贺氓。
rule:這個參數(shù)很簡單蔚叨,就是匹配的路由地址
view_func:這個參數(shù)就是我們寫的視圖函數(shù)
endpoint:這個參數(shù)就是我今天重點要講的,endpoint
很多人認(rèn)為:假設(shè)用戶訪問http://www.example.com/user/eric,flask會找到該函數(shù)蔑水,并傳遞name='eric'悄泥,執(zhí)行這個函數(shù)并返回值。
但是實際中肤粱,F(xiàn)lask真的是直接根據(jù)路由查詢視圖函數(shù)么弹囚?
在源碼中我們可以發(fā)現(xiàn):
每個應(yīng)用程序app都有一個view_functions,這是一個字典领曼,存儲endpoint-view_func鍵值對鸥鹉。add_url_rule的第一個作用就是向view_functions中添加鍵值對(這件事在應(yīng)用程序run之前就做好了)
每個應(yīng)用程序app都有一個url_map,它是一個Map類(具體實現(xiàn)在werkzeug/routing.py中)庶骄,里面包含了一個列表毁渗,列表元素是Role的實例(werkzeug/routing.py中)。add_url_rule的第二個作用就是向url_map中添加Role的實例(它也是在應(yīng)用程序run之前就做好了)
我們可以通過一個例子來看:
app=Flask(__name__)@app.route('/test', endpoint='Test')deftest():pass@app.route('/', endpoint='index')defhello_world():return'Hello World!'if__name__=='__main__':print(app.view_functions)print(app.url_map)? ? app.run()
運行這個程序单刁,結(jié)果是:
{'static': >, 'Test': , 'index': }Map([ Test>,
index>,
' (HEAD, OPTIONS, GET) -> static>]) * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
所以我們可以看出:這個url_map存儲的是url與endpoint的映射!
回到flask接受用戶請求地址并查詢函數(shù)的問題灸异。實際上,當(dāng)請求傳來一個url的時候羔飞,會先通過rule找到endpoint(url_map)肺樟,然后再根據(jù)endpoint再找到對應(yīng)的view_func(view_functions)。通常逻淌,endpoint的名字都和視圖函數(shù)名一樣么伯。
這時候,這個endpoint也就好理解了:
實際上這個endpoint就是一個Identifier卡儒,每個視圖函數(shù)都有一個endpoint田柔,
當(dāng)有請求來到的時候,用它來知道到底使用哪一個視圖函數(shù)
在實際應(yīng)用中骨望,當(dāng)我們需要在一個視圖中跳轉(zhuǎn)到另一個視圖中的時候硬爆,我們經(jīng)常會使用url_for(endpoint)去查詢視圖,而不是把地址硬編碼到函數(shù)中擎鸠。
這個時候缀磕,我們就不能使用視圖函數(shù)名當(dāng)endpoint去查詢了
我們舉個例子來說明。比如:
app=Flask(__name__)app.register_blueprint(user, url_prefix='user')app.register_blueprint(file, url_prefix='file')
我們注冊了2個藍圖糠亩。
在user中(省略初始化過程):
@user.route('/article')defarticle():pass
在file中(省略初始化過程):
@file.route('/article')defarticle():pass
這時候虐骑,我們發(fā)現(xiàn)准验,/article這個路由對應(yīng)了兩個函數(shù)名一樣的函數(shù)赎线,分別在兩個藍圖中。當(dāng)我們使用url_for(article)調(diào)用的時候(注意糊饱,url_for是通過endpoint查詢url地址垂寥,然后找視圖函數(shù)),flask無法知道到底使用哪個藍圖下的endpoint,所以我們需要這樣:
url_for('user.article')