fastapi 添加自定义装饰器

fastapi支持对 @wraps 的处理,在你的装饰器加入@wraps修饰即可。如下


def my_decorate(func):
    @wraps(func)
    async def wrapper(*args, **kwargs):
        return func(*args, **kwargs)
    return wrapper

原理:

@wraps, 这个装饰器用于将函数的信息转存到你的装饰器,包括('__module__', '__name__', '__qualname__', '__doc__', '__annotations__') ('__dict__',) 这几个变量,同时额外添加了一个

__wrapped__ 魔法变量,这个变量记录的是被装饰的原始函数。

fastapi 内部对 __wrapped__ 魔法变量做了特殊处理,当fastapi看到有这个变量,就转而处理变量指向的函数, 所以只需要给装饰器函数添加__wrapped__即可。如下

def get_roles(request:Request, a: int=1, b:str="test"):
    print(a,b)
    return b


def test(*args, **kwargs):
    return get_roles(*args, **kwargs)


test.__wrapped__ = get_roles
router.add_api_route("test", test)

当然直接用@wraps 就行。

### 实现和使用装饰器中间件 在 FastAPI 中,虽然官方推荐的方式是通过 `add_middleware` 方法来添加中间件[^1],也可以利用 Python 的装饰器模式创建自定义中间件。这种方式允许更灵活地控制特定视图函数的行为。 下面是一个例子展示如何构建并应用基于装饰器的中间件: #### 定义装饰器中间件 首先编写一个简单的装饰器用于模拟中间件功能,比如验证 token: ```python from functools import wraps from fastapi import Request, HTTPException from typing import Callable def verify_token_decorator(token_secret: str) -> Callable: """ 创建一个带参数的装饰器 """ def decorator(func): @wraps(func) async def wrapper(request: Request, *args, **kwargs): # 获取请求头中的 Authorization 字段 authorization_header = request.headers.get('Authorization') if not authorization_header or authorization_header != f'Bearer {token_secret}': raise HTTPException(status_code=403, detail="Invalid Token") return await func(*args, **kwargs) return wrapper return decorator ``` 此代码片段展示了如何创建名为 `verify_token_decorator` 的装饰器工厂函数,它接受一个参数 `token_secret` 并返回实际的装饰器逻辑。该装饰器会检查传入请求头部是否有合法的身份认证令牌[^2]。 #### 应用装饰器至路由处理器 接着可以将上述定义好的装饰器应用于具体的路径操作上: ```python from fastapi import FastAPI app = FastAPI() # 使用装饰器保护某个端点 @app.post("/protected-endpoint/") @verify_token_decorator("mysecretkey") # 这里填入真实的密钥字符串 async def protected_endpoint(): return {"message": "This is a protected resource"} ``` 这里演示了怎样把前面编写的 `verify_token_decorator` 装饰器附加到 `/protected-endpoint/` POST 请求处理程序之上。只有携带有效身份凭证(即正确格式化的 Bearer Token)才能访问这个受保护资源;否则将会收到权限不足 (403 Forbidden) 响应。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值