在ts-rest项目中实现动态授权头的解决方案

背景介绍

在构建现代Web应用时，授权机制是不可或缺的一部分。ts-rest作为一个强大的API契约库，与React Query结合使用时，开发者经常会遇到需要动态设置授权头（如Bearer Token）的场景。本文将深入探讨如何在ts-rest项目中优雅地实现这一需求。

核心挑战

当使用ts-rest的React Query客户端时，开发者面临两个主要挑战：

1. 静态头部的局限性：通过baseHeaders设置的头部在整个应用生命周期中保持不变，而访问令牌通常会过期
2. 动态设置的复杂性：直接在查询中设置头部会导致令牌过期后无法自动更新

解决方案：自定义客户端

ts-rest提供了自定义客户端的机制，这是解决动态授权需求的最佳实践。通过initClient函数，我们可以创建一个能够动态获取最新令牌的客户端。

实现示例

export function createAuthClient(getToken: () => Promise<string>) {
  return initClient(contract, {
    baseUrl: API_BASE_URL,
    baseHeaders: {
      authorization: "" // 占位符，满足契约要求
    },
    api: async (args) => {
      const token = await getToken();
      return tsRestFetchApi({
        ...args,
        headers: {
          ...args.headers,
          authorization: `Bearer ${token}`
        }
      });
    }
  });
}

关键点说明

1. 异步令牌获取：api函数支持异步操作，可以等待令牌刷新
2. 头部合并：保留原始头部的同时添加授权信息
3. 契约兼容性：即使实际头部是动态生成的，仍需提供占位符满足类型检查

注意事项

1. 头部大小写敏感：HTTP头部是大小写不敏感的，但某些服务器实现可能有特殊要求
2. 错误处理：应考虑在令牌获取失败时提供适当的错误处理机制
3. 性能优化：频繁获取令牌可能影响性能，应考虑缓存策略

与React Query集成

创建自定义客户端后，可以轻松与React Query集成：

const authClient = createAuthClient(async () => {
  // 实现获取最新令牌的逻辑
});

export const tsrReactQuery = initTsrReactQuery(contract, {
  ...authClient.options,
  // 其他React Query特定配置
});

高级场景

对于更复杂的授权流程，如：

1. 自动令牌刷新：在收到401响应时自动刷新令牌并重试请求
2. 多授权策略：根据运行环境（服务端/客户端）使用不同的授权机制
3. 请求追踪：为每个请求添加唯一标识

都可以通过扩展自定义客户端来实现，这体现了ts-rest设计的灵活性。

总结

通过自定义客户端的方式，ts-rest项目可以完美解决动态授权头的需求。这种方法不仅解决了令牌过期问题，还保持了代码的整洁性和可维护性。开发者可以根据实际需求扩展这一模式，实现更复杂的授权逻辑。

记住，良好的授权实现应该对业务代码透明，让开发者专注于业务逻辑而非底层细节。ts-rest的这一设计理念使其成为构建现代API客户端的强大工具。