Flask中endpoint的理解(小結(jié))

在flask框架中，我們經(jīng)常會(huì)遇到endpoint這個(gè)東西，最開(kāi)始也沒(méi)法理解這個(gè)到底是做什么的。最近正好在研究Flask的源碼，也就順帶了解了一下這個(gè)endpoint

首先，我們看一個(gè)例子：

@app.route('/user/<name>')
def user(name):
  return 'Hello, %s' % name

這個(gè)是我們?cè)谟胒lask框架寫網(wǎng)站中最常用的。

通過(guò)看源碼，我們可以發(fā)現(xiàn)：

函數(shù)等效于

def user(name)
  return 'Hello, %s' % name
  
app.add_url_rule('/user/<name>', 'user', user)

這個(gè)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.

拋開(kāi)options這個(gè)參數(shù)不談，我們看看前三個(gè)參數(shù)。
rule：這個(gè)參數(shù)很簡(jiǎn)單，就是匹配的路由地址
view_func：這個(gè)參數(shù)就是我們寫的視圖函數(shù)
endpoint：這個(gè)參數(shù)就是我今天重點(diǎn)要講的，endpoint

很多人認(rèn)為：假設(shè)用戶訪問(wèn)http://www.example.com/user/eric，flask會(huì)找到該函數(shù)，并傳遞name='eric'，執(zhí)行這個(gè)函數(shù)并返回值。

但是實(shí)際中，F(xiàn)lask真的是直接根據(jù)路由查詢視圖函數(shù)么？

在源碼中我們可以發(fā)現(xiàn)：

• 每個(gè)應(yīng)用程序app都有一個(gè)view_functions，這是一個(gè)字典，存儲(chǔ)endpoint-view_func鍵值對(duì)。add_url_rule的第一個(gè)作用就是向view_functions中添加鍵值對(duì)(這件事在應(yīng)用程序run之前就做好了)
• 每個(gè)應(yīng)用程序app都有一個(gè)url_map，它是一個(gè)Map類(具體實(shí)現(xiàn)在werkzeug/routing.py中)，里面包含了一個(gè)列表，列表元素是Role的實(shí)例(werkzeug/routing.py中)。add_url_rule的第二個(gè)作用就是向url_map中添加Role的實(shí)例(它也是在應(yīng)用程序run之前就做好了)

我們可以通過(guò)一個(gè)例子來(lái)看：

app = Flask(__name__)

@app.route('/test', endpoint='Test')
def test():
  pass


@app.route('/', endpoint='index')
def hello_world():
  return 'Hello World!'

if __name__ == '__main__':
  print(app.view_functions)
  print(app.url_map)
  app.run()

運(yùn)行這個(gè)程序，結(jié)果是：

{'static': <bound method Flask.send_static_file of <Flask 'flask-code'>>, 'Test': <function test at 0x10065e488>, 'index': <function hello_world at 0x10323d488>}
Map([<Rule '/test' (HEAD, OPTIONS, GET) -> Test>,
 <Rule '/' (HEAD, OPTIONS, GET) -> index>,
 <Rule '/static/<filename>' (HEAD, OPTIONS, GET) -> static>])
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

所以我們可以看出：這個(gè)url_map存儲(chǔ)的是url與endpoint的映射!

回到flask接受用戶請(qǐng)求地址并查詢函數(shù)的問(wèn)題。實(shí)際上，當(dāng)請(qǐng)求傳來(lái)一個(gè)url的時(shí)候，會(huì)先通過(guò)rule找到endpoint(url_map)，然后再根據(jù)endpoint再找到對(duì)應(yīng)的view_func(view_functions)。通常，endpoint的名字都和視圖函數(shù)名一樣。

這時(shí)候，這個(gè)endpoint也就好理解了：

實(shí)際上這個(gè)endpoint就是一個(gè)Identifier，每個(gè)視圖函數(shù)都有一個(gè)endpoint，

當(dāng)有請(qǐng)求來(lái)到的時(shí)候，用它來(lái)知道到底使用哪一個(gè)視圖函數(shù)

在實(shí)際應(yīng)用中，當(dāng)我們需要在一個(gè)視圖中跳轉(zhuǎn)到另一個(gè)視圖中的時(shí)候，我們經(jīng)常會(huì)使用url_for(endpoint)去查詢視圖，而不是把地址硬編碼到函數(shù)中。

這個(gè)時(shí)候，我們就不能使用視圖函數(shù)名當(dāng)endpoint去查詢了

我們舉個(gè)例子來(lái)說(shuō)明。比如：

app = Flask(__name__)
app.register_blueprint(user, url_prefix='user')
app.register_blueprint(file, url_prefix='file')

我們注冊(cè)了2個(gè)藍(lán)圖。

在user中(省略初始化過(guò)程)：

@user.route('/article')
def article():
  pass

在file中(省略初始化過(guò)程)：

@file.route('/article')
def article():
  pass

這時(shí)候，我們發(fā)現(xiàn)，/article這個(gè)路由對(duì)應(yīng)了兩個(gè)函數(shù)名一樣的函數(shù)，分別在兩個(gè)藍(lán)圖中。當(dāng)我們使用url_for(article)調(diào)用的時(shí)候(注意，url_for是通過(guò)endpoint查詢url地址，然后找視圖函數(shù))，flask無(wú)法知道到底使用哪個(gè)藍(lán)圖下的endpoint，所以我們需要這樣:

url_for('user.article')

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持億速云。