贝利信息

Python装饰器实现自动Token刷新:更优雅的API认证处理方案

日期:2026-01-07 00:00 / 作者:花韻仙語

本文介绍如何通过封装http请求方法而非使用装饰器,来优雅处理api调用中因token过期(http 401)触发的自动重试与令牌刷新逻辑,兼顾可维护性、可读性与面向对象设计原则。

在构建与需身份认证的REST API交互的Python客户端时,Token过期导致的 401 Unauthorized 是高频问题。虽然初看装饰器(decorator)似乎是“自动重试+刷新Token”的理想解法,但实际工程实践中,直接封装请求逻辑往往比强行套用装饰器更清晰、更可控、更符合职责分离原则

如原始代码所示,每个业务方法(如 get_device)内嵌重复的 401 判断与重发逻辑,不仅冗余,还破坏了单一职责。而若强行设计一个通用装饰器(例如 @retry_on_401),将面临几个关键挑战:

因此,推荐采用封装请求辅助方法的方案,如答案中所示:

import json
from typing import Any, Dict

class APIClient:
    def __init__(self, username: str, password: str):
        self.username = username
        self.password = password
        self.session = requests.Session()
        self._token = None

    def get_token(self) -> str:
        payload = json.dumps({"name": self.username, "password": self.password})
        r = self.session.post(
            BASE_URL + "authentication/signin",
            data=payload,
            verify=False,
        )
        if not r.ok:
            raise RuntimeError(f"Login failed: {r.status_code} {r.text}")
        response = r.json()
        if "token" not in response:
            raise RuntimeError("Token missing in login response")
        self._token = response["token"]
        return self._token

    def _authenticated_post(self, url: str, **kwargs) -> requests.Response:
        # 首次请求
        r = self.session.post(url, **kwargs)
        # 若未授权,刷新Token并重试
        if r.status_code == 401:
            self.session.headers.update({"X-AUTH-TOKEN": self.get_token()})
            r = self.session.post(url, **kwargs)
        return r

    def get_device(self, ip: str) -> Dict[str, Any]:
        data = json.dumps({"ipAddress": ip.strip()})
        r = self._authenticated_post(
            BASE_URL + "devices/filter",
            data=data
        )
        if not r.ok:
            raise RuntimeError(f"API request failed: {r.status_code} {r.text}")
        response = r.json()
        if "content" not in response:
            raise RuntimeError("Expected 'content' field not found")
        return response["content"][0]

优势说明

⚠️ 注意事项

总之,面对认证流程这类具有明确上下文依赖和状态管理需求的逻辑,优先选择面向对象封装,而非过度追求装饰器的“魔法感”——清晰胜于炫技,稳健优于巧妙。