flask uri 怎么统一加前缀

发布于:2025-05-02 ⋅ 阅读:(13) ⋅ 点赞:(0)

在 Flask 中为 URI 统一添加前缀,可以通过多种方式实现,下面为你详细介绍几种常见的方法。

方法一:使用 Blueprint(推荐)

Blueprint(蓝图)是 Flask 中组织路由的一种方式,它可以将不同的路由分组,并且可以为蓝图设置统一的 URL 前缀。以下是具体的实现步骤和示例代码:

from flask import Flask, Blueprint

# 创建 Flask 应用实例
app = Flask(__name__)

# 创建一个蓝图,并设置 URL 前缀
api_bp = Blueprint('api', __name__, url_prefix='/api')

# 在蓝图中定义路由
@api_bp.route('/hello')
def hello():
    return 'Hello, World!'

# 将蓝图注册到应用中
app.register_blueprint(api_bp)

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

代码解释
  1. 创建蓝图:使用 Blueprint 类创建一个蓝图对象 api_bp,并指定蓝图的名称和 URL 前缀 /api
  2. 定义路由:在蓝图对象上使用 @api_bp.route 装饰器定义路由,这里定义了一个 /hello 路由。
  3. 注册蓝图:使用 app.register_blueprint(api_bp) 将蓝图注册到 Flask 应用中。
  4. 访问路由:由于设置了 /api 前缀,实际访问的 URL 为 /api/hello

方法二:自定义 URL 映射规则

你也可以通过自定义 URL 映射规则来为所有路由统一添加前缀。以下是示例代码:

from flask import Flask

app = Flask(__name__)

# 定义一个函数,用于添加前缀
def add_url_prefix(prefix):
    def decorator(func):
        def wrapper(*args, **kwargs):
            return func(*args, **kwargs)
        # 获取原始的路由规则
        original_rule = func.__dict__.get('__route__', '')
        # 添加前缀
        new_rule = f'{prefix}{original_rule}'
        # 重新设置路由规则
        wrapper.__dict__['__route__'] = new_rule
        return wrapper
    return decorator

# 定义一个路由,并添加前缀
@app.route('/hello')
@add_url_prefix('/api')
def hello():
    return 'Hello, World!'

# 手动添加路由
app.add_url_rule(hello.__dict__['__route__'], 'hello', hello)

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

代码解释
  1. 定义装饰器:定义一个 add_url_prefix 装饰器,用于为路由添加前缀。
  2. 定义路由:使用 @app.route 定义一个路由,并使用 @add_url_prefix 装饰器添加前缀。
  3. 手动添加路由:由于使用了自定义装饰器,需要手动调用 app.add_url_rule 方法将路由添加到应用中。

方法三:修改 Flask 应用的 URL 映射

这种方法通过修改 Flask 应用的 url_map 对象来为所有路由统一添加前缀。以下是示例代码:

from flask import Flask

app = Flask(__name__)

# 定义一个路由
@app.route('/hello')
def hello():
    return 'Hello, World!'

# 为所有路由添加前缀
prefix = '/api'
for rule in app.url_map.iter_rules():
    rule.rule = f'{prefix}{rule.rule}'

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

代码解释
  1. 定义路由:使用 @app.route 定义一个路由。
  2. 修改路由规则:遍历 app.url_map.iter_rules() 获取所有路由规则,并为每个规则添加前缀。

总结

  • 使用 Blueprint:是最推荐的方法,它可以将不同的功能模块分开管理,提高代码的可维护性和可扩展性。
  • 自定义 URL 映射规则:适用于需要对路由进行更复杂处理的场景,但代码相对复杂。
  • 修改 Flask 应用的 URL 映射:简单直接,但可能会影响 Flask 应用的内部机制,不建议在大型项目中使用。

网站公告

今日签到

点亮在社区的每一天
去签到