NSwag在.NET 9.0环境下生成C客户端失败问题解析

问题背景

在使用NSwag工具链为.NET 9.0项目生成C#客户端代码时，开发者遇到了路径参数为空的异常。这个问题在从.NET 7/8升级到.NET 9后出现，表现为NSwag无法正确解析项目路径，导致代码生成失败。

错误现象

执行NSwag生成命令时，系统抛出System.ArgumentException: The path is empty. (Parameter 'path')异常。错误发生在ProjectMetadata.GetProjectMetadata方法中，表明NSwag无法获取到有效的项目路径信息。

根本原因分析

通过深入分析，我们发现这个问题与.NET 9.0项目构建系统返回的MSBuild属性有关。当查询关键构建属性时，多个重要属性返回了空值：

• ProjectDir（项目目录）
• ProjectDepsFilePath（项目依赖文件路径）
• ProjectRuntimeConfigFilePath（运行时配置文件路径）
• TargetFileName（目标文件名）

这些空值导致NSwag无法正确定位项目文件和生成所需的元数据。这种情况在.NET 7/8中工作正常，但在升级到.NET 9后出现，表明可能是.NET 9构建系统或项目配置发生了变化。

解决方案

经过技术验证，我们推荐以下解决方案：

1. 更新NSwag版本：使用预览版NSwag 14.3.1-preview-20250420-0810或更高版本，这些版本已经针对.NET 9的构建系统变化进行了适配。

2. 调整构建命令：在项目文件中修改NSwag的执行命令，显式指定工作目录：

<Target Name="NSwag" AfterTargets="Build">
  <Exec Command="$(NSwagExe_Net90) run nswag.json /variables:Configuration=$(Configuration)" 
        WorkingDirectory="$(ProjectDir)" />
</Target>

3. 检查项目配置：确保项目中没有特殊的构建目标或多级Directory.Build.props文件，这些可能会影响MSBuild属性的正常传递。

技术细节

当NSwag执行时，它会通过MSBuild API获取项目元数据来生成OpenAPI规范。在.NET 9环境下，如果关键路径属性为空，就会导致生成过程失败。这个问题特别容易出现在：

• 使用非标准项目结构时
• 有自定义构建逻辑的项目中
• 多目标框架项目中

最佳实践建议

为了避免类似问题，我们建议：

1. 保持NSwag工具链更新到最新稳定版本
2. 在项目升级时，仔细检查NSwag配置文件的兼容性
3. 考虑将NSwag生成步骤作为独立构建步骤而非后期构建目标
4. 在复杂项目中，考虑使用明确的路径而非依赖自动发现

总结

.NET 9.0的构建系统变化导致NSwag在获取项目元数据时出现了兼容性问题。通过更新工具链版本和调整构建配置，开发者可以解决这一问题。这也提醒我们在升级.NET版本时，需要关注构建工具链的兼容性变化，特别是对于依赖MSBuild API的工具。