本文译自: https://stackoverflow.com/questions/19261833/what-is-an-endpoint-in-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
那么什么是 endpoint 呢?
Flask中路由Routing的工作方式
Flask(和底层的Werkzeug库)的基本思想是将URL路径映射到一些你将运行的逻辑(通常是“视图函数”)。 通常你的视图函数是这样定义的:
@app.route('/greeting/')
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/', 'give_greeting', give_greeting)
假设你的网站位于“www.example.org”并使用上述视图。 用户在浏览器中输入以下URL:
http://www.example.org/greeting/Mark
Flask的工作是获取这个URL,找出用户想要做的事情,然后把它传递给你众多python函数中的一个来处理。 它采取的路径是:
/greeting/Mark
并将其匹配到路由列表。 在我们的例子中,我们定义了这个路径和give_greeting函数匹配。
然而,虽然这是您创建视图的典型方式,但它实际上隐藏了一些细节。 实际上,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"
“endpoint” 是用于确定 Request 该由代码的哪个逻辑单元来处理。 通常情况下,endpoint 只是一个视图函数的名称。 但是,实际上可以更改端点,如下例所示:
@app.route('/greeting/', 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"
如何使用endpoint
端点通常用于“反向查找”。 例如,在Flask应用程序的一个视图函数中想要引用另一个视图函数。 可以使用 url_for() ,而不是直接使用URL。 示例如下:
@app.route('/')
def index():
print url_for('give_greeting', name='Mark') # This will print '/greeting/Mark'
@app.route('/greeting/')
def give_greeting(name):
return 'Hello, {0}!'.format(name)
这是有利的,因为现在我们可以改变我们的应用程序的URL而不需要改变我们引用该资源的那一行。
为什么不直接用视图函数呢?
现在的问题是:“为什么我们需要这个额外的层 (endpoint) ? 为什么要将路径映射到endpoint,然后将endpoint映射到视图函数? 为什么不跳过这个中间步骤?
原因是因为这种方式更强大。 例如,Flask Blueprints允许您将应用程序分成不同的部分。 我可能将所有管理端资源都放在名为“admin”的 blueprint 中,并将所有用户级资源放在“user”的 endpoint中。
Blueprints 允许您将这些分隔到命名空间中。 例如...
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!'
请注意,在这两个blueprint中,“/ greeting”路由是一个名为“greeting”的函数。 如果我想引用admin 的 “greeting” 函数,我们需要使用 "admin.greeting"。 endpoint 允许我们将blueprint的名称指定为端点的一部分,从而实现一种命名空间。 所以,我们可以使用下面的做法:
print url_for('admin.greeting') # Prints '/admin/greeting'
print url_for('user.greeting') # Prints '/user/greeting'