首页
/ NSwag项目中的IHostedService清理问题解析

NSwag项目中的IHostedService清理问题解析

2025-05-31 17:04:08作者:申梦珏Efrain

在NSwag工具的使用过程中,开发者遇到了一个与依赖注入容器中IHostedService清理相关的问题。这个问题特别影响了与Umbraco CMS集成的场景,导致无法正常生成TypeScript服务和模型。

问题背景

NSwag是一个用于生成TypeScript/JavaScript客户端代码、OpenAPI/Swagger规范以及.NET客户端代码的工具。在最新版本中,NSwag在处理ASP.NET Core应用程序时,会对依赖注入容器中的IHostedService注册进行清理操作。这个设计初衷是为了防止后台服务在代码生成过程中意外启动。

问题根源

清理操作的实现方式存在问题。当前代码使用IsAssignableFrom方法来识别所有IHostedService及其派生接口的注册,这会导致过度清理。具体来说,当某个服务接口(如Umbraco中的IRuntime)继承自IHostedService时,即使它仅以自身接口类型(IRuntime)注册,也会被错误地移除。

技术细节

在Umbraco CMS中,IRuntime接口继承自IHostedService,但它的注册方式是:

services.AddSingleton<IRuntime, Runtime>();

而非直接注册为IHostedService。然而,当前的清理逻辑会匹配所有可赋值给IHostedService的类型,导致这些必要的服务被意外移除。

解决方案

正确的做法应该是仅移除直接注册为IHostedService类型的服务,而不是所有可赋值给IHostedService的类型。即将条件判断从:

if(typeof(IHostedService).IsAssignableFrom(services[i].ServiceType))

修改为:

if(services[i].ServiceType == typeof(IHostedService))

影响范围

这个问题不仅影响Umbraco CMS,任何框架或库中如果有服务间接实现IHostedService接口但直接以自身接口类型注册的情况,都会受到相同的影响。这种过度清理会导致依赖注入容器中缺少必要的服务,进而引发各种运行时错误。

最佳实践建议

对于工具开发者来说,在进行依赖注入容器操作时应当:

  1. 精确匹配服务类型,避免使用过于宽泛的类型判断
  2. 考虑提供配置选项,允许用户自定义哪些服务需要保留
  3. 在清理操作前记录将被移除的服务,便于调试

对于NSwag用户来说,如果遇到类似问题,可以:

  1. 检查项目中是否有间接实现IHostedService的关键服务
  2. 考虑暂时降级NSwag版本
  3. 等待官方修复并升级到包含修复的版本

这个问题提醒我们在处理依赖注入容器时需要格外小心,特别是在工具类库中,因为任何修改都可能影响用户应用程序的核心功能。

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

项目优选

收起
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.3 K
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
922
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++
192
273
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
59
16