基于.NET7+的代码生成修正OpenAPI客户端方法返回类型的可行性咨询

可行性结论 #

这个方案在.NET7+完全可行。.NET7强化了源代码生成（Source Generator）能力，支持通过自定义属性驱动、分析现有代码语法树生成新方法实现；结合C#的部分方法（partial method）机制，能彻底避免手动修改NSwag生成代码的重复劳动，完美实现“标记后自动生成修正版方法”的需求。

具体实现思路 #

1. 定义自定义标记属性 #

先创建一个特性，用来标记需要生成的修正方法，并指定参考的原方法名称：

[AttributeUsage(AttributeTargets.Method, Inherited = false, AllowMultiple = false)]
public sealed class CodeGenAttribute : Attribute
{
    public string TargetMethodName { get; }

    public CodeGenAttribute(string targetMethodName)
    {
        TargetMethodName = targetMethodName;
    }
}

2. 编写源代码生成器 #

实现ISourceGenerator接口，核心是分析标记了CodeGenAttribute的部分方法，匹配原方法后生成修正逻辑：

核心步骤：

• 收集标记方法：在Initialize方法中注册语法接收器，扫描项目中所有标记了CodeGenAttribute的partial方法。
• 匹配原方法：在Execute方法里，针对每个标记方法，在同一个partial类中找到名称匹配、参数列表完全一致的原方法（比如NSwag生成的GetDataAsync）。
• 生成修正代码：复制原方法的结构（访问修饰符、async关键字、参数列表），替换ParseResponse的泛型参数为新方法返回类型的泛型参数，生成完整实现。

示例核心生成逻辑（简化版）：

// 匹配目标原方法
var targetMethod = FindTargetMethod(partialMethod.ContainingType, attribute.TargetMethodName);
// 获取新方法的返回泛型类型
var returnElementType = ((INamedTypeSymbol)partialMethod.ReturnType).TypeArguments[0];

// 拼接生成代码
var sourceCode = $$"""
public virtual async Task<{{returnElementType}}> {{partialMethod.Name}}({{string.Join(", ", targetMethod.Parameters.Select(p => $"{p.Type} {p.Name}"))}})
{
    var response = GetResponse();
    return ParseResponse<{{returnElementType}}>(response);
}
""";

// 将生成代码添加到编译上下文
context.AddSource($"{partialMethod.Name}.g.cs", SourceText.From(sourceCode, Encoding.UTF8));

3. 项目集成 #

• 把源代码生成器做成独立类库项目，引用Microsoft.CodeAnalysis.CSharp和Microsoft.CodeAnalysis.Analyzers NuGet包。
• 在客户端项目中，添加对生成器项目的Analyzer引用，同时引用自定义属性的类库。
• 在NSwag生成的partial客户端类中，添加标记后的partial方法：

[CodeGen("GetDataAsync")]
public partial Task<SomeResponseType[]> GetDataAsync2(CancellationToken cancellationToken);

编译时生成器会自动生成该方法的实现代码。

4. 关键注意事项 #

• 确保NSwag生成的客户端类是partial类：NSwag默认生成的类就是partial，无需额外配置。
• 严格匹配参数列表：生成器要校验原方法的参数数量、类型、顺序，保证新方法参数完全一致，避免调用错误。
• 添加诊断逻辑：生成器中加入校验，比如找不到原方法时输出编译警告，方便排查问题。

内容的提问来源于stack exchange，提问作者Alex