首页
/ 深入理解@hey-api/client-fetch中的客户端管理机制

深入理解@hey-api/client-fetch中的客户端管理机制

2025-07-02 13:10:50作者:凤尚柏Louis

背景介绍

在现代Web开发中,前后端分离架构已成为主流。@hey-api/client-fetch作为一个强大的OpenAPI客户端生成工具,能够根据后端API定义自动生成类型安全的客户端代码。然而,在实际应用中,特别是在服务端渲染(SSR)场景下,客户端实例的管理方式可能会带来一些挑战。

核心问题分析

在@hey-api/client-fetch的默认实现中,服务函数接收一个包含可选client属性的options参数。当不显式传递client时,系统会使用services.gen.ts中定义的默认客户端实例。这种设计在浏览器端运行良好,因为每个用户都有自己的浏览器环境,客户端实例自然隔离。

但在服务端场景下,特别是需要处理多用户请求时,这种单例模式会带来问题:

  1. 不同用户共享同一个客户端实例
  2. 认证信息(如access token)可能被错误地跨用户共享
  3. 可能导致安全问题和功能异常

解决方案演进

项目维护者针对这一问题提供了两种解决方案:

1. 配置禁用默认客户端

最新版本中,可以通过设置sdk.clientfalse来禁用默认客户端生成。这样所有服务调用都必须显式提供客户端实例,强制开发者正确处理每个请求的客户端隔离。

2. Next.js专用客户端

针对Next.js应用场景,项目计划提供专门的客户端实现,这将更好地处理服务端渲染环境下的客户端管理问题。虽然目前优先级不高,但这是未来的发展方向。

最佳实践建议

对于需要在服务端使用@hey-api/client-fetch的开发者,建议:

  1. 升级到最新版本,利用sdk.client = false配置
  2. 为每个用户请求创建独立的客户端实例
  3. 在中间件层统一处理客户端创建和配置
  4. 避免在全局作用域存储任何与用户相关的客户端状态

技术实现细节

在底层实现上,这个功能是通过修改代码生成逻辑实现的。当禁用默认客户端时:

  1. services.gen.ts不再包含默认客户端导出
  2. 所有生成的服务函数类型定义将client标记为必需属性
  3. 调用时必须显式提供配置好的客户端实例

这种设计既保持了API的简洁性,又解决了服务端环境下的隔离问题。

总结

@hey-api/client-fetch通过灵活的客户端管理机制,既支持简单的浏览器端使用场景,也能满足复杂的服务端多用户隔离需求。理解这一机制对于构建安全、可靠的Web应用至关重要,特别是在全栈应用和服务器渲染场景下。随着框架的不断发展,未来还会提供更多针对特定环境的优化解决方案。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
260
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
854
505
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
254
295
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
331
1.08 K
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
397
370
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
83
4
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
kernelkernel
deepin linux kernel
C
21
5