什么是Flask中的“端点”?

Flask文档显示 :

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. endpoint – the endpoint for the registered URL rule. Flask itself assumes the name of the view function as endpoint 

“端点”究竟是什么意思?

烧瓶路由的工作原理

Flask(和底层的Werkzeug库)的整个思想是将URLpath映射到一些你将运行的逻辑(通常是“视图函数”)。 你的基本观点是这样定义的:

 @app.route('/greeting/<name>') def give_greeting(name): return 'Hello, {0}!'.format(name) 

请注意,您引用的函数(add_url_rule)实现了相同的目标,只是不使用装饰符号。 所以下面是一样的:

 # No "route" decorator here. We will add routing using a different method below. def give_greeting(name): return 'Hello, {0}!'.format(name) app.add_url_rule('/greeting/<name>', 'give_greeting', give_greeting) 

假设您的网站位于“www.example.org”并使用上述视图。 用户在浏览器中input以下URL:

 http://www.example.org/greeting/Mark 

Flask的工作就是获取这个URL,找出用户想要做的事情,然后把它传递给你的许多python函数中的一个来处理。 它采取的path是

 /greeting/Mark 

…并将其匹配到路线列表。 在我们的例子中,我们定义了这个path去give_greeting函数。

然而,虽然这是您创build视图的典型方式,但它实际上会提取一些额外的信息。 在幕后,Flask并没有直接从URL到应该处理这个请求的视图函数。 它不只是说…

 URL (http://www.example.org/greeting/Mark) should be handled by View Function (the function "my_greeting") 

实际上,还有一个步骤,它将URL映射到一个端点:

 URL (http://www.example.org/greeting/Mark) should be handled by Endpoint "my_greeting". Requests to Endpoint "my_greeting" should be handled by View Function "my_greeting" 

基本上, “端点”是用于确定代码的哪个逻辑单元应该处理请求的标识符 。 通常情况下,端点只是一个视图函数的名称。 但是,实际上可以更改端点,如下例所示。

 @app.route('/greeting/<name>', endpoint='say_hello') def give_greeting(name): return 'Hello, {0}!'.format(name) 

现在,当Flask路由请求时,逻辑如下所示:

 URL (http://www.example.org/greeting/Mark) should be handled by Endpoint "say_hello". Endpoint "say_hello" should be handled by View Function "my_greeting" 

如何使用端点

端点通常用于“反向查找”。 例如,在Flask应用程序的一个视图中,您想引用另一个视图(也许当您从站点的一个区域链接到另一个区域时)。 可以使用url_for() ,而不是对URL进行硬编码。 假设如下

 @app.route('/') def index(): print url_for('give_greeting', name='Mark') # This will print '/greeting/Mark' @app.route('/greeting/<name>') def give_greeting(name): return 'Hello, {0}!'.format(name) 

这是有利的,因为现在我们可以改变我们的应用程序的URL而不需要改变我们引用该资源的那一行。

为什么不总是使用视图函数的名称?

可能出现的一个问题是:“为什么我们需要这个额外的层? 为什么要将path映射到端点,然后将端点映射到视图函数? 为什么不跳过这个中间步骤?

原因是因为这种方式更强大。 例如, Flask Blueprints允许您将应用程序分成不同的部分。 我可能将所有pipe理端资源都放在名为“admin”的蓝图中,并将端点中的所有用户级资源都称为“user”。

蓝图允许您将这些分隔到命名空间中。 例如…

main.py:

 from flask import Flask, Blueprint from admin import admin from user import user app = Flask(__name__) app.register_blueprint(admin, url_prefix='admin') app.register_blueprint(user, url_prefix='user') 

admin.py:

 admin = Blueprint('admin', __name__) @admin.route('/greeting') def greeting(): return 'Hello, administrative user!' 

user.py:

 user = Blueprint('user', __name__) @user.route('/greeting') def greeting(): return 'Hello, lowly normal user!' 

请注意,在这两个蓝图中,“/ greeting”路由是一个名为“greeting”的函数。 如果我想引用pipe理“问候”function,我不能只是说“问候”,因为也有用户“问候”function。 端点允许您将蓝图的名称指定为端点的一部分,从而实现一种命名空间。 所以,我可以做以下…

 print url_for('admin.greeting') # Prints '/admin/greeting' print url_for('user.greeting') # Prints '/user/greeting' 

端点是用于反向查找url_for url规则的名称,默认为view函数的名称。

小例子:

 from flask import Flask, url_for app = Flask(__name__) # We can use url_for('foo_view') for reverse-lookups in templates or view functions @app.route('/foo') def foo_view(): pass # We now specify the custom endpoint named 'bufar'. url_for('bar_view') will fail! @app.route('/bar', endpoint='bufar') def bar_view(): pass with app.test_request_context('/'): print url_for('foo_view') print url_for('bufar') # url_for('bar_view') will raise werkzeug.routing.BuildError print url_for('bar_view')