Flask 在所有 Flask 路由中添加前缀

在本文中，我们将介绍如何在所有 Flask 路由中添加前缀。通常情况下，Flask 应用程序的路由规则是直接定义在视图函数的装饰器中的。然而，在某些场景下，我们可能需要为所有的路由添加一个公共的 URL 前缀，例如，在一个多模块的项目中，每个模块都有自己的路由规则，但是我们想要将它们都放在一个统一的 URL 前缀下。

下面以一个简单的示例说明如何添加前缀到所有 Flask 路由：

from flask import Flask, redirect, url_for

app = Flask(__name__)

@app.route('/')
def index():
    return "Hello, World!"

# 在所有路由上添加前缀 '/api'
@app.before_request
def add_prefix():
    if not request.path.startswith('/api'):
        return redirect(url_for(request.endpoint, **request.view_args), code=301)

# 使用 '/api' 作为前缀的路由
@app.route('/api/hello')
def api_hello():
    return "Hello, API!"

if __name__ == '__main__':
    app.run()

在上述示例中，我们通过 @app.before_request 装饰器定义了一个前置钩子函数 add_prefix，在每个请求处理之前调用该函数。我们可以在该函数中判断请求的路径是否已经以指定的前缀开始，如果没有，则重定向到添加了前缀的路径。这样，所有的路由都会被添加上前缀 /api。

在上述示例中，我们定义了两个路由，一个是根路由 /，另一个是带有前缀 /api 的路由 /api/hello。当访问根路由时，会显示 “Hello, World!”，而访问带有前缀的路由 /api/hello 时，会显示 “Hello, API!”。通过前置钩子函数，我们将所有的路由都添加了前缀 /api。

需要注意的是，我们在重定向的时候使用了 url_for 函数来生成带有正确参数的目标地址。url_for 函数可以根据视图函数的名称和参数生成对应的 URL。

通过以上的示例，我们可以很方便地给所有 Flask 路由添加前缀。这在多模块的项目中特别有用，可以将每个模块的路由都放在一个统一的前缀下，方便维护和管理。

阅读更多：Flask 教程

总结

在本文中，我们介绍了如何给所有 Flask 路由添加前缀。通过使用 @app.before_request 装饰器定义一个前置钩子函数，在每个请求处理之前判断路径是否已经包含了指定的前缀，并在没有前缀的情况下进行重定向。这样，我们可以很方便地为所有的路由添加一个公共的 URL 前缀，使得项目更加有组织和易于维护。希望本文对你理解和使用 Flask 路由有所帮助。