.NET 6 WebAPI接口默认实现方法无法生成API接口求助

为什么接口默认方法无法生成API端点？ #

ASP.NET Core的控制器动作发现机制只会扫描控制器类直接定义的公共方法，不会识别接口中的默认实现方法。这就是为什么你控制器里的Query2能正常生成API，而接口IQueryController<T>中的Query方法不行的核心原因。

解决方案 #

方案1：显式转发接口方法（快速但重复） #

在每个实现IQueryController<T>的控制器中，手动添加调用接口默认方法的转发代码：

public IActionResult Query([FromServices] IConfiguration config,
                           [FromServices] ILogger<Associate> logger,
                           [FromServices] IBaseService service,
                           List<QueryParam> listQueryParams)
{
    // 显式调用接口的默认实现
    return ((IQueryController<Associate>)this).Query(config, logger, service, listQueryParams);
}

这种方法能快速解决问题，但需要在每个控制器中重复编写代码，违背了用接口复用逻辑的初衷。

方案2：自定义控制器特性提供器（简洁且可扩展） #

通过自定义IControllerFeatureProvider，让ASP.NET Core识别接口中的默认方法并将其作为控制器动作：

1. 创建自定义特性提供器类：

using Microsoft.AspNetCore.Mvc.Controllers;
using System.Reflection;

namespace App.RestApi.Common
{
    public class DefaultInterfaceMethodFeatureProvider : IControllerFeatureProvider
    {
        // 保留默认的控制器判定逻辑
        public bool IsController(TypeInfo typeInfo)
        {
            return ControllerFeatureProvider.IsController(typeInfo);
        }

        public void PopulateFeature(IEnumerable<TypeInfo> controllerTypes, ControllerFeature feature)
        {
            foreach (var controllerType in controllerTypes)
            {
                // 获取控制器实现的所有接口中的默认方法
                var defaultInterfaceMethods = controllerType.ImplementedInterfaces
                    .SelectMany(interf => interf.GetMethods(BindingFlags.Public | BindingFlags.Instance))
                    .Where(method => method.IsDefaultImplementation);

                foreach (var method in defaultInterfaceMethods)
                {
                    // 检查控制器是否已经显式实现了该方法
                    var existingMethod = controllerType.GetMethod(
                        method.Name,
                        method.GetParameters().Select(p => p.ParameterType).ToArray());

                    if (existingMethod == null)
                    {
                        // 将接口默认方法添加为控制器动作
                        feature.Controllers.Add(new ControllerActionDescriptor
                        {
                            ControllerTypeInfo = controllerType,
                            MethodInfo = method,
                            ActionName = method.Name,
                            Attributes = method.GetCustomAttributes().ToList()
                        });
                    }
                }
            }
        }
    }
}

2. 在Program.cs中注册该特性提供器：

builder.Services.AddControllers()
    .ConfigureApplicationPartManager(apm =>
    {
        apm.FeatureProviders.Add(new DefaultInterfaceMethodFeatureProvider());
    });

配置完成后，ASP.NET Core就能自动识别接口中的默认方法并生成对应的API端点。

方案3：源代码生成器（自动生成转发代码） #

通过源代码生成器，在编译时自动为实现接口的控制器生成转发方法，无需手动编写重复代码：

1. 创建源代码生成器类：

using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using System.Text;

namespace App.RestApi.Generators
{
    [Generator]
    public class QueryControllerGenerator : ISourceGenerator
    {
        public void Initialize(GeneratorInitializationContext context) { }

        public void Execute(GeneratorExecutionContext context)
        {
            foreach (var syntaxTree in context.Compilation.SyntaxTrees)
            {
                var root = syntaxTree.GetRoot();
                var classDeclarations = root.DescendantNodes().OfType<ClassDeclarationSyntax>();

                foreach (var classDecl in classDeclarations)
                {
                    var model = context.Compilation.GetSemanticModel(syntaxTree);
                    var classSymbol = model.GetDeclaredSymbol(classDecl) as INamedTypeSymbol;

                    if (classSymbol == null) continue;

                    // 检查当前类是否实现了IQueryController<T>
                    var queryInterface = classSymbol.Interfaces
                        .FirstOrDefault(i => i.Name.StartsWith("IQueryController"));

                    if (queryInterface == null) continue;

                    var entityType = queryInterface.TypeArguments[0];

                    // 生成转发方法的源代码
                    var source = new StringBuilder();
                    source.AppendLine($"namespace {classSymbol.ContainingNamespace.Name}");
                    source.AppendLine("{");
                    source.AppendLine($"    public partial class {classSymbol.Name}");
                    source.AppendLine("    {");
                    source.AppendLine($"        public Microsoft.AspNetCore.Mvc.IActionResult Query(Microsoft.Extensions.Configuration.IConfiguration config,");
                    source.AppendLine($"                                                   Microsoft.Extensions.Logging.ILogger<{entityType.Name}> logger,");
                    source.AppendLine($"                                                   App.Service.IBaseService service,");
                    source.AppendLine($"                                                   System.Collections.Generic.List<App.RestApi.Common.QueryParam> listQueryParams)");
                    source.AppendLine("        {");
                    source.AppendLine($"            return ((App.RestApi.Controllers.IQueryController<{entityType.Name}>)this).Query(config, logger, service, listQueryParams);");
                    source.AppendLine("        }");
                    source.AppendLine("    }");
                    source.AppendLine("}");

                    // 将生成的代码添加到编译过程中
                    context.AddSource($"{classSymbol.Name}.Query.g.cs", source.ToString());
                }
            }
        }
    }
}

2. 将控制器标记为partial：

public partial class AssociateController : Controller, IQueryController<Associate>

编译时生成器会自动为控制器添加转发方法，让API端点正常生成。

推荐方案 #

如果追求无代码侵入的运行时解决方案，选择自定义控制器特性提供器；如果偏好编译时安全性且不介意引入源代码生成，源代码生成器是更好的选择。显式转发仅适合快速临时解决问题，不适合大规模项目。

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