Flask 框架中如何使用装饰器实现请求拦截？
在 Flask 开发中，我们经常需要对特定的路由进行访问控制，比如验证用户是否登录、检查权限等。这时候，装饰器就成为了一个非常优雅的解决方案。本文将详细介绍如何在 Flask 中使用装饰器来实现请求拦截。
一、装饰器基础
装饰器本质上是一个 Python 函数，它可以让其他函数在不需要做任何代码修改的前提下增加额外功能。在 Flask 中，我们可以利用装饰器来对视图函数进行包装，从而实现请求拦截。
1.1 简单的装饰器示例
首先，让我们看一个简单的装饰器示例：
def my_decorator(func):
def wrapper():
print("在函数执行前做一些事情")
func()
print("在函数执行后做一些事情")
return wrapper
@my_decorator
def say_hello():
print("Hello!")
say_hello()在这个例子中，my_decorator 是一个装饰器，它包装了 say_hello 函数。当我们调用 say_hello() 时，实际上是在调用 wrapper() 函数。
二、Flask 中的请求拦截装饰器
在 Flask 中，我们通常需要在请求到达视图函数之前进行一些操作，比如验证用户身份。下面是一个简单的登录验证装饰器示例：
2.1 基本的登录验证装饰器
from functools import wraps
from flask import request, jsonify
def login_required(f):
@wraps(f)
def decorated_function(*args, **kwargs):
# 检查请求头中是否有 Authorization 字段
auth_header = request.headers.get('Authorization')
if not auth_header:
return jsonify({'error': '未提供认证信息'}), 401
# 这里可以添加更复杂的验证逻辑，比如验证 token
# 为了简单起见，我们假设只要存在 Authorization 字段就认为已登录
if 'Bearer' not in auth_header:
return jsonify({'error': '无效的认证信息'}), 401
# 如果验证通过，继续执行被装饰的函数
return f(*args, **kwargs)
return decorated_function在这个示例中，我们使用了 functools.wraps 来保留原始函数的元数据。login_required 装饰器会检查请求头中的 Authorization 字段，如果没有提供或者格式不正确，就会返回 401 错误。
2.2 在路由中使用装饰器
定义好装饰器后，我们可以在路由中使用它：
from flask import Flask
app = Flask(__name__)
@app.route('/protected')
@login_required
def protected_route():
return jsonify({'message': '这是一个受保护的路由'})
if __name__ == '__main__':
app.run(debug=True)在这个例子中，/protected 路由被 login_required 装饰器保护，只有提供了有效认证信息的请求才能访问。
三、带参数的装饰器
有时候我们需要更灵活的装饰器，比如可以指定哪些角色可以访问某个路由。这时候可以使用带参数的装饰器。
3.1 带参数的权限验证装饰器
from functools import wraps
from flask import request, jsonify
def permission_required(roles):
def decorator(f):
@wraps(f)
def decorated_function(*args, **kwargs):
# 获取用户的角色信息，这里假设从请求头中获取
user_role = request.headers.get('X-User-Role')
if user_role not in roles:
return jsonify({'error': '没有权限访问此资源'}), 403
return f(*args, **kwargs)
return decorated_function
return decorator这个装饰器接受一个 roles 参数，指定允许访问的角色列表。在内部，它返回一个真正的装饰器函数。
3.2 使用带参数的装饰器
@app.route('/admin')
@permission_required(['admin'])
def admin_route():
return jsonify({'message': '这是管理员路由'})
@app.route('/user')
@permission_required(['admin', 'user'])
def user_route():
return jsonify({'message': '这是用户路由'})在这个例子中，/admin 路由只允许 admin 角色访问，而 /user 路由允许 admin 和 user 角色访问。
四、处理多个装饰器
在 Flask 中，我们可以为一个路由应用多个装饰器。装饰器的应用顺序是从下往上。
@app.route('/super-protected')
@login_required
@permission_required(['admin'])
def super_protected_route():
return jsonify({'message': '这是超级保护的路由'})在这个例子中，请求会先经过 permission_required 装饰器，然后再经过 login_required 装饰器。如果任何一个装饰器验证失败，请求都会被拦截。
五、实际应用场景
5.1 API 限流
我们可以使用装饰器来实现 API 限流功能：
import time
from functools import wraps
from flask import request, jsonify
# 简单的限流字典，实际应用中应该使用 Redis 等存储
rate_limit_cache = {}
def rate_limit(limit, period):
def decorator(f):
@wraps(f)
def decorated_function(*args, **kwargs):
client_ip = request.remote_addr
current_time = time.time()
# 初始化客户端的限流记录
if client_ip not in rate_limit_cache:
rate_limit_cache[client_ip] = []
# 移除过期的记录
rate_limit_cache[client_ip] = [
timestamp for timestamp in rate_limit_cache[client_ip]
if current_time - timestamp < period
]
# 检查是否超过限制
if len(rate_limit_cache[client_ip]) >= limit:
return jsonify({'error': '请求过于频繁，请稍后再试'}), 429
# 记录本次请求
rate_limit_cache[client_ip].append(current_time)
return f(*args, **kwargs)
return decorated_function
return decorator
@app.route('/api/data')
@rate_limit(limit=10, period=60) # 每分钟最多 10 次请求
def api_data():
return jsonify({'data': 'some data'})5.2 请求日志记录
我们还可以使用装饰器来记录请求日志：
import logging
from functools import wraps
from flask import request
logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)
def log_request(f):
@wraps(f)
def decorated_function(*args, **kwargs):
logger.info(f"收到请求: {request.method} {request.url}")
logger.info(f"请求头: {dict(request.headers)}")
response = f(*args, **kwargs)
logger.info(f"响应状态码: {response.status_code}")
return response
return decorated_function
@app.route('/log-test')
@log_request
def log_test():
return jsonify({'message': '测试日志记录'})六、注意事项
6.1 使用 functools.wraps
在使用装饰器时，一定要记得使用 functools.wraps，否则被装饰函数的元数据（如函数名、文档字符串等）会被覆盖。
6.2 错误处理
在装饰器中要做好错误处理，确保在出现异常时能够返回合适的错误信息，而不是让程序崩溃。
6.3 性能考虑
复杂的装饰器可能会影响应用的性能，特别是在高并发场景下。在实际应用中，要注意优化装饰器的逻辑。
七、总结
通过使用装饰器，我们可以在 Flask 中实现灵活且强大的请求拦截功能。无论是简单的登录验证，还是复杂的权限控制、API 限流等，都可以通过装饰器优雅地实现。希望本文能帮助你更好地理解和使用 Flask 中的装饰器。