Flask 中的“端点”是啥？

Posted 2023-02-15

【中文标题】Flask 中的“端点”是啥？

【英文标题】：What is an 'endpoint' in Flask?Flask 中的“端点”是什么？

【发布时间】：2013-10-16 05:02:36

【问题描述】：

Flask documentation shows:

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

“端点”到底是什么意思？

【参考方案1】：

Flask 路由的工作原理

Flask（以及底层 Werkzeug 库）的整个想法是将 URL 路径映射到您将运行的某些逻辑（通常是“视图函数”）。您的基本视图定义如下：

@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”并使用上述视图。用户在浏览器中输入以下 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 "give_greeting")

其实还有一个步骤，就是将 URL 映射到一个端点：

URL (http://www.example.org/greeting/Mark) should be handled by Endpoint "give_greeting".
Requests to Endpoint "give_greeting" should be handled by View Function "give_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 "give_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，而无需更改引用该资源的行。

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

可能会出现以下问题：“为什么我们需要这个额外的层？”为什么要将路径映射到端点，然后将端点映射到视图函数？为什么不直接跳过中间步骤？

原因是因为这种方式更强大。例如，Flask Blueprints 允许您将应用程序拆分为多个部分。我可能将所有管理端资源放在一个名为“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”的函数。如果我想引用管理员“问候”功能，我不能只说“问候”，因为还有一个用户“问候”功能。通过让您将蓝图的名称指定为端点的一部分，端点允许一种命名空间。因此，我可以执行以下操作...

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

【讨论】：

root 用户的url_for 怎么样？我发现了错误Could not build url for endpoint ''

我真的很喜欢你的解释，它让我很好地了解了这些端点是如何工作的。然而，既然我理解了这个概念，我认为你错过了关于端点的一点，特别是在 Flask 中。如果您不指定端点，则 url_for() 函数中的规则可能会因 X 或 Y 原因更改函数/类的名称而被破坏（有人重构了代码并找到了更合适的名称等...） . Flask 自动生成的端点可帮助您处理 url 的更改。显式端点可帮助您处理 func 的 url 更改和名称更改。

这真的让我对 Flask 的端点功能的理解更加清晰，甚至可能是对端点的一般定义的理解。我还发现了一些错字。你的视图函数不应该是give_greeting 而不是my_greeting 吗？我在任何地方都没有看到my_greeting..

这样一个有用的、深入的答案。太棒了！

【参考方案2】：

Endpoint 是用于反向查找带有url_for 的url 规则的名称，默认为视图函数的名称。

小例子：

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

【参考方案3】：

如果你有相同的类名并且想映射多个路由，那么指定端点，这样框架就会区分两个：

 class ClassName(Resource):
        def get(self):
            if request.endpoint!='hello':
                return "data": "Hello"
            elif:
                return "data" : "World"
                
    api.add_resource(ClassName, '/rout1', endpoint = "world")
    api.add_resource(ClassName, '/rout2', endpoint="hello")

【参考方案4】：

@app.route('/')     #Endpoint
def a_function():   #View function
    return 'view'

在 Flask 内部，每个端点及其请求方法都映射到一个视图函数。当您使用 app.route 装饰器时，您实际上是在添加 URL 规则。