NSwag 14.3.0版本中可选参数排序问题分析与解决方案

问题背景

在NSwag工具链的14.3.0版本中，用户报告了一个关于参数排序的重要问题。当使用OperationProcessor添加可选参数时，生成的.NET客户端代码中可选参数被错误地放置在了必需参数之前，这违反了C#语言规范（导致CS1737编译错误），也破坏了API调用的预期行为。

问题表现

在正常情况下，C#方法的参数顺序应该是：

1. 必需参数
2. 可选参数（带默认值）
3. 取消令牌参数（对于异步方法）

但在NSwag 14.3.0中，生成的代码却出现了可选参数被错误地放在必需参数之前的情况，例如：

// 错误的生成结果
public Task<WeatherForecast> GetByIdAsync(string optionalParam = null, Guid cityId, CancellationToken cancellationToken = default);

// 期望的正确结果
public Task<WeatherForecast> GetByIdAsync(Guid cityId, string optionalParam = null, CancellationToken cancellationToken = default);

问题根源

经过社区成员的深入调查，发现问题源于14.3.0版本中的一个代码变更。在CSharpOperationModel.cs文件中，参数收集逻辑从传统的集合初始化方式改为了使用C# 12的新特性——集合表达式。

在14.2.0版本中，参数收集是通过显式调用Concat方法实现的：

Parameters = _operation.Parameters
    .Where(p => p.Kind != OpenApiParameterKind.Body)
    .Concat(bodyParameters)
    .Concat(formParameters)
    .ToList();

而在14.3.0版本中，改为了使用集合表达式：

Parameters = [
    .. _operation.Parameters.Where(p => p.Kind != OpenApiParameterKind.Body),
    .. bodyParameters,
    .. formParameters
];

这种变更意外地改变了参数的排序逻辑，导致通过OperationProcessor添加的参数被错误地放在了参数列表的前面。

解决方案

NSwag团队已经确认了这个问题，并在后续版本中提供了修复方案。修复的核心思想是：

1. 确保通过OperationProcessor添加的参数保持其原始顺序
2. 维护必需参数始终在可选参数之前的约定
3. 保持取消令牌参数在最后的正确位置

用户可以通过以下方式获取修复后的版本：

• 使用MyGet预览源中的14.3.1-preview-20250420-0810或更高版本

最佳实践建议

对于遇到此问题的用户，我们建议：

1. 如果项目紧急，可以暂时回退到NSwag 14.2.0版本
2. 或者升级到包含修复的预览版本
3. 在更新NSwag版本时，务必全面测试生成的客户端代码
4. 考虑在CI/CD流程中添加对生成代码的编译检查，确保参数顺序正确

总结

参数顺序在API客户端中至关重要，不仅影响代码的可读性，也直接影响调用的正确性。NSwag团队对社区的快速响应展示了开源项目的优势，而用户提供的详细复现步骤也极大地帮助了问题的定位和解决。作为开发者，在遇到类似工具链升级导致的问题时，提供最小复现案例是帮助解决问题的关键。