Flask中endpoint的理解

在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')

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末滞项,一起剝皮案震驚了整個濱河市狭归,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌文判,老刑警劉巖过椎,帶你破解...
    沈念sama閱讀 207,248評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異戏仓,居然都是意外死亡疚宇,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,681評論 2 381
  • 文/潘曉璐 我一進店門赏殃,熙熙樓的掌柜王于貴愁眉苦臉地迎上來敷待,“玉大人,你說我怎么就攤上這事仁热“褚荆” “怎么了?”我有些...
    開封第一講書人閱讀 153,443評論 0 344
  • 文/不壞的土叔 我叫張陵抗蠢,是天一觀的道長举哟。 經(jīng)常有香客問我,道長迅矛,這世上最難降的妖魔是什么炎滞? 我笑而不...
    開封第一講書人閱讀 55,475評論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮诬乞,結(jié)果婚禮上册赛,老公的妹妹穿的比我還像新娘。我一直安慰自己震嫉,他們只是感情好森瘪,可當(dāng)我...
    茶點故事閱讀 64,458評論 5 374
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著票堵,像睡著了一般扼睬。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上悴势,一...
    開封第一講書人閱讀 49,185評論 1 284
  • 那天窗宇,我揣著相機與錄音,去河邊找鬼特纤。 笑死军俊,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的捧存。 我是一名探鬼主播粪躬,決...
    沈念sama閱讀 38,451評論 3 401
  • 文/蒼蘭香墨 我猛地睜開眼担败,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了镰官?” 一聲冷哼從身側(cè)響起提前,我...
    開封第一講書人閱讀 37,112評論 0 261
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎泳唠,沒想到半個月后狈网,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,609評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡笨腥,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,083評論 2 325
  • 正文 我和宋清朗相戀三年孙援,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片扇雕。...
    茶點故事閱讀 38,163評論 1 334
  • 序言:一個原本活蹦亂跳的男人離奇死亡拓售,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出镶奉,到底是詐尸還是另有隱情础淤,我是刑警寧澤,帶...
    沈念sama閱讀 33,803評論 4 323
  • 正文 年R本政府宣布哨苛,位于F島的核電站鸽凶,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏建峭。R本人自食惡果不足惜玻侥,卻給世界環(huán)境...
    茶點故事閱讀 39,357評論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望亿蒸。 院中可真熱鬧凑兰,春花似錦、人聲如沸边锁。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,357評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽茅坛。三九已至音半,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間贡蓖,已是汗流浹背曹鸠。 一陣腳步聲響...
    開封第一講書人閱讀 31,590評論 1 261
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留斥铺,地道東北人彻桃。 一個月前我還...
    沈念sama閱讀 45,636評論 2 355
  • 正文 我出身青樓,卻偏偏與公主長得像仅父,于是被迫代替她去往敵國和親叛薯。 傳聞我的和親對象是個殘疾皇子浑吟,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 42,925評論 2 344

推薦閱讀更多精彩內(nèi)容

  • 22年12月更新:個人網(wǎng)站關(guān)停笙纤,如果仍舊對舊教程有興趣參考 Github 的markdown內(nèi)容[https://...
    tangyefei閱讀 35,160評論 22 257
  • [TOC]一直想做源碼閱讀這件事耗溜,總感覺難度太高時間太少,可望不可見省容。最近正好時間充裕抖拴,決定試試做一下,并記錄一下...
    何柯君閱讀 7,174評論 3 98
  • 可以翻譯成“視圖入口”腥椒,就是個名字阿宅。url_for可以用到,其他方面也可以用到(比如導(dǎo)航條確定當(dāng)前頁面)笼蛛,因為en...
    卡薩諾瓦_閱讀 716評論 0 0
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理洒放,服務(wù)發(fā)現(xiàn),斷路器滨砍,智...
    卡卡羅2017閱讀 134,601評論 18 139
  • 去年11月的一天惋戏,只因在校招網(wǎng)上多看了你一眼领追,所以才有了現(xiàn)在坐在麥迪斯頓的總部大樓里寫著這篇文章,一切皆為緣分使然...
    逆旅少年jump閱讀 1,005評論 0 0