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

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

74466 次浏览

Endpoint 是用于使用 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')

烧瓶路由如何工作

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 跳到应该处理这个请求的 view 函数。它不仅仅是说..。

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"

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

@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,而无需更改引用该资源的行。

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

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

原因是因为这样更强大。例如,烧瓶设计图允许您将应用程序拆分为不同的部分。我可能在一个名为“ admin”的蓝图中拥有所有管理端资源,在一个名为“ user”的端点中拥有所有用户级资源。

蓝图允许您将这些内容分隔成名称空间。

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

Py:

admin = Blueprint('admin', __name__)


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

Py:

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

请注意,在这两个蓝图中,’/hello’路由都是一个名为“尊敬”的函数。如果我想引用管理员的“问候”函数,我不能只说“问候”,因为还有一个用户的“问候”函数。端点允许通过指定蓝图的名称作为端点的一部分来实现一种名称空间。所以,我可以做以下几件事。

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

如果您有相同的类名,并且想要映射多个路由,那么指定端点,这样框架将区分两个:

 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")
@app.route('/')     #Endpoint
def a_function():   #View function
return 'view'

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