ASP.NET Core中如何将默认接口方法用作控制器操作？

ASP.NET MVC/API默认只会将控制器类自身定义的方法识别为操作方法，对于实现接口的默认方法，框架不会自动扫描并注册为可访问的接口端点。比如你提供的示例中，MyEntityController实现了IGetEntityControllerMixin<MyEntity>接口，但其中的Get默认方法不会被当作API接口处理。

下面是几种可行的解决方案：

1. 自定义操作方法选择器（推荐） #

通过实现自定义的操作方法选择器，让ASP.NET框架识别接口的默认方法。

步骤1：创建选择器特性 #

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

public class AllowInterfaceDefaultMethodsAttribute : ActionMethodSelectorAttribute
{
    public override bool IsValidForRequest(RouteContext routeContext, ActionDescriptor actionDescriptor)
    {
        var method = actionDescriptor.MethodInfo;
        // 判断当前方法是否是接口的默认实现
        return method.IsDefaultImplementation();
    }
}

步骤2：全局注册选择器 #

在Program.cs（或Startup.cs）中，将自定义选择器添加到MVC配置的全局筛选器：

var builder = WebApplication.CreateBuilder(args);

// 添加控制器服务并注册全局筛选器
builder.Services.AddControllers(options =>
{
    options.Filters.Add(new AllowInterfaceDefaultMethodsAttribute());
});

var app = builder.Build();

// 其他中间件配置...
app.MapControllers();

app.Run();

这样所有接口的默认方法都会被框架识别为合法的操作方法，无需修改控制器或接口代码。

2. 显式调用接口默认方法 #

在控制器中显式实现接口方法，并直接调用接口的默认实现。这种方式虽然繁琐，但无需额外配置：

[ApiController]
[Route("[controller]")]
public class MyEntityController : ControllerBase,
                                  IGetEntityControllerMixin<MyEntity>,
                                  IPagingEntityControllerMixin<MyEntity>
{
    public IRepository<MyEntity> Repository { get; }
    public MyEntityController(IRepository<MyEntity> repository)
        => Repository = repository;

    // 显式实现并转发到接口默认方法
    public async Task<ActionResult<MyEntity>> Get(int id)
    {
        return ((IGetEntityControllerMixin<MyEntity>)this).Get(id);
    }
}

3. 改用控制器基类 #

如果接口的默认方法逻辑可以复用，也可以将逻辑移到抽象基类中，让控制器继承基类。这种方式框架会自动识别基类中的方法：

public abstract class GetEntityControllerBase<TEntity> : ControllerBase
    where TEntity : class, IEntity, new()
{
    public abstract IRepository<TEntity> Repository { get; }

    [HttpGet("{id:int}")]
    public async Task<ActionResult<TEntity>> Get(int id)
    {
        var entity = await Repository.GetByIdAsync(id);
        return entity == null ? NotFound() : Ok(entity);
    }
}

[ApiController]
[Route("[controller]")]
public class MyEntityController : GetEntityControllerBase<MyEntity>,
                                  IPagingEntityControllerMixin<MyEntity>
{
    public override IRepository<MyEntity> Repository { get; }
    public MyEntityController(IRepository<MyEntity> repository)
        => Repository = repository;
}

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