自定义C＃特性以在控制器中禁用方法

Question

我有一个ASP.NET Core WebAPI应用程序，我已经创建了一个通用的自定义基础控制器类，为继承自该类的任何控制器提供了CRUD操作（获取所有、根据ID获取、插入、更新和删除）。

在我的某些控制器中，我需要禁用某些方法。当然，我可以使用 [NonAction] 特性来实现这一点。

是否可以实现一个特性，并将其应用于我的控制器以禁用一系列方法？

这是我部分代码：

public interface IBaseService where T : DomainObject
{
    Task> GetAllAsync(BaseRequestViewModel request);
    Task> GetByIdAsync(int id);
    Task> InsertAsync(T entity);
    Task> UpdateAsync(T entity);
    Task> DeleteAsync(int id);
}

以及我的自定义基础控制器大致如下：

public class ProcessMiningControllerBase : ControllerBase where T : DomainObject
{
    private readonly IBaseService _baseService;

    public ProcessMiningControllerBase(IBaseService baseService)
    {
        _baseService = baseService;
    }

    [HttpPost]
    public virtual async Task> GetAllAsync(BaseRequestViewModel request)
    {
        return await _baseService.GetAllAsync(request);
    }

    [HttpGet("{id}")]
    public virtual async Task> GetByIdAsync(int id)
    {
        return await _baseService.GetByIdAsync(id);
    }

    [HttpPost]
    public virtual async Task> InsertAsync(T entity)
    {
        return await _baseService.InsertAsync(entity);
    }

    [HttpPut]
    public virtual async Task> UpdateAsync(T entity)
    {
        return await _baseService.UpdateAsync(entity);
    }

    [HttpDelete("{id}")]
    public virtual async Task> DeleteAsync(int id)
    {
        return await _baseService.DeleteAsync(id);
    }
}

Flimm · Answer

您可以按照以下四个步骤禁用控制器及其动作：

创建一个动作过滤器属性，使控制器始终返回404 NOT FOUND状态码，如下所示：

public class DisableControllerAttribute : ActionFilterAttribute
{
    public override void OnActionExecuting(ActionExecutingContext filterContext)
    {
        filterContext.Result = new NotFoundObjectResult(null);
    }
}

在应用程序的Program.cs文件中注册该过滤器：

builder.Services.AddControllers((c) => c.Filters.Add());

使用您创建的动作过滤器装饰控制器：

[DisableController]
public class ValuesController : ControllerBase
{
    // 控制器的方法...
}

（可选步骤）如果您还想在Swagger页面中隐藏该控制器，请在控制器上添加以下属性：

[ApiExplorerSettings(IgnoreApi = true)]

Ray Toal · Answer

谢谢大家！实际上，我已经找到了正确的实现方法：

定义一个自定义属性：

[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true)]
public class DisableBaseOperationsAttribute : Attribute
{
    // 空属性类，仅用于标识控制器
}

然后实现 IControllerModelConvention 接口，如下所示：

public class ProcessMiningControllerModelConvention : IControllerModelConvention
{
    private List baseOperations;
    
    public ProcessMiningControllerModelConvention()
    {
        baseOperations = new List()
        {
            "GetAll",
            "GetById",
            "Insert",
            "Update",
            "Delete",
        };
    }

    public void Apply(ControllerModel controller)
    {
        bool disableCrud = controller.Attributes.Any(a => a.GetType() == typeof(DisableBaseOperationsAttribute));
        if (disableCrud)
        {
            var crudActions = controller.Actions.Where(a => baseOperations.Contains(a.ActionName));
            foreach (var action in crudActions)
            {
                action.ApiExplorer.IsVisible = false;
            }
        }
    }
}

最后，在配置 AddControllers 时添加控制器模型约定：

builder.Services.AddControllers(s => s.Conventions.Add(new ProcessMiningControllerModelConvention()));

现在您可以在控制器上轻松使用这个属性来禁用基本操作。