首页
/ 深入理解@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应用至关重要,特别是在全栈应用和服务器渲染场景下。随着框架的不断发展,未来还会提供更多针对特定环境的优化解决方案。

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

热门内容推荐

最新内容推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
73
63
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.29 K
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
921
551
PaddleOCRPaddleOCR
飞桨多语言OCR工具包(实用超轻量OCR系统,支持80+种语言识别,提供数据标注与合成工具,支持服务器、移动端、嵌入式及IoT设备端的训练与部署) Awesome multilingual OCR toolkits based on PaddlePaddle (practical ultra lightweight OCR system, support 80+ languages recognition, provide data annotation and synthesis tools, support training and deployment among server, mobile, embedded and IoT devices)
Python
47
1
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
193
273
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
59
16