@app.url_value_preprocessor
是 Flask 中的一个装饰器,用来注册一个 URL 值预处理函数。这个函数会在每次请求处理过程中执行,在请求处理函数之前执行,它的主要作用是对 URL 中的变量进行处理和验证。
以下是一个示例
在这个示例中,@app.url_value_preprocessor
装饰器注册了一个名为 convert_string_to_int
的函数,这个函数会在每次请求处理过程中执行。在这个函数中,我们对 URL 中的所有变量进行处理和验证。具体来说,如果变量名以 _id
结尾,我们会尝试将其转换为整数,如果转换失败则忽略这个变量。
from flask import Flask, g
app = Flask(__name__)
@app.route('/user/<int:user_id>')
def show_user(user_id):
return 'User %d' % user_id
@app.url_value_preprocessor
def convert_string_to_int(endpoint, values):
for key, value in values.items():
if key.endswith('_id'):
try:
values[key] = int(value)
except ValueError:
pass
if __name__ == '__main__':
app.run()
在请求处理函数中,我们可以像平常一样使用 URL 变量。
例如,在 /user/1 这个 URL 中,user_id 变量的值为 1,可以在请求处理函数中使用。
注意事项
需要注意的是,@app.url_value_preprocessor
装饰器的函数需要接受两个参数:endpoint 和 values。endpoint 是请求处理函数的名称,values 是一个字典,包含了 URL 中的所有变量。
在函数中,我们可以根据需要对这些变量进行处理和验证。
- 如果需要注册多个预处理函数,可以在同一个应用程序中注册多个。在这种情况下,它们会按照注册的顺序依次执行。
- 如果需要阻止请求处理函数执行,可以在预处理函数中抛出一个异常。
- 如果多个预处理函数都抛出了异常,那么最后一个抛出的异常会被 Flask 捕获并返回到客户端。