使用 URL 处理器 — Flask 文档

使用 URL 处理器

0.7 版中的新功能。

Flask 0.7 引入了 URL 处理器的概念。 这个想法是你可能有一堆资源，在 URL 中有你并不总是明确想要提供的公共部分。 例如，您可能有一堆包含语言代码的 URL，但您不想自己在每个函数中处理它。

URL 处理器在与蓝图结合使用时特别有用。 我们将在此处处理特定于应用程序的 URL 处理器以及蓝图细节。

国际化应用程序 URL

考虑这样的应用程序：

from flask import Flask, g

app = Flask(__name__)

@app.route('/<lang_code>/')
def index(lang_code):
    g.lang_code = lang_code
    ...

@app.route('/<lang_code>/about')
def about(lang_code):
    g.lang_code = lang_code
    ...

这是大量重复，因为您必须在每个函数中自己处理 g 对象上的语言代码设置。 当然，可以使用装饰器来简化这一点，但是如果您想从一个函数生成 URL 到另一个函数，您仍然必须明确提供语言代码，这可能很烦人。

对于后者，这就是 url_defaults() 函数的用武之地。 他们可以自动将值注入到 url_for() 的调用中。 下面的代码检查语言代码是否还没有在 URL 值字典中，以及端点是否需要名为 'lang_code' 的值：

@app.url_defaults
def add_language_code(endpoint, values):
    if 'lang_code' in values or not g.lang_code:
        return
    if app.url_map.is_endpoint_expecting(endpoint, 'lang_code'):
        values['lang_code'] = g.lang_code

URL 映射的方法 is_endpoint_expecting() 可用于确定为给定端点提供语言代码是否有意义。

该功能的反面是 url_value_preprocessor()s。 它们在请求匹配后立即执行，并且可以根据 URL 值执行代码。 这个想法是他们从值字典中提取信息并将其放在其他地方：

@app.url_value_preprocessor
def pull_lang_code(endpoint, values):
    g.lang_code = values.pop('lang_code', None)

这样你就不再需要在每个函数中对 g 进行 lang_code 赋值。 您可以通过编写自己的装饰器来进一步改进，用语言代码作为 URL 前缀，但更漂亮的解决方案是使用蓝图。 一旦 'lang_code' 从值字典中弹出，它将不再转发到视图函数，将代码简化为：

from flask import Flask, g

app = Flask(__name__)

@app.url_defaults
def add_language_code(endpoint, values):
    if 'lang_code' in values or not g.lang_code:
        return
    if app.url_map.is_endpoint_expecting(endpoint, 'lang_code'):
        values['lang_code'] = g.lang_code

@app.url_value_preprocessor
def pull_lang_code(endpoint, values):
    g.lang_code = values.pop('lang_code', None)

@app.route('/<lang_code>/')
def index():
    ...

@app.route('/<lang_code>/about')
def about():
    ...

国际化蓝图 URL

因为蓝图可以自动为所有 URL 加上一个公共字符串的前缀，所以很容易为每个函数自动执行此操作。 此外，蓝图可以有每个蓝图的 URL 处理器，它从 url_defaults() 函数中删除了大量逻辑，因为它不再需要检查 URL 是否真的对 'lang_code' 参数感兴趣：

from flask import Blueprint, g

bp = Blueprint('frontend', __name__, url_prefix='/<lang_code>')

@bp.url_defaults
def add_language_code(endpoint, values):
    values.setdefault('lang_code', g.lang_code)

@bp.url_value_preprocessor
def pull_lang_code(endpoint, values):
    g.lang_code = values.pop('lang_code')

@bp.route('/')
def index():
    ...

@bp.route('/about')
def about():
    ...