多个可选参数，包括 ASP.NET Core Web API 路由中的枚举类型

Question

我正在我的 ASP.NET Core Web Api 中创建一个采用多个参数的方法，所有这些参数都是可选的。在邮递员上调用此方法时出现错误：

System.InvalidOperationException: The constraint reference 'StatusEnum' could not be resolved to a type. Register the constraint type with 'Microsoft.AspNetCore.Routing.RouteOptions.ConstraintMap'

如何在路由中使用枚举作为我的参数类型？ 我的控制器：

[HttpPost("filter-reports/{reportStatus:StatusEnum?}/{IsNecessary:bool?}/{completionStatus: completionStatusEnum?}")]
    [Authorize]
    public ObjectResult GetDamageReportByFilters(StatusEnum? reportStatus, bool? IsNecessary, completionStatusEnum? completionStatus)
    {
        var result = _reportService.GetReportByFilters(reportStatus,IsNecessary, completionStatus);

        return StatusCode(200, result);
    }

我该如何解决这个问题？

Answer 1

这个问题已经有很长时间了，但我希望这能帮助其他正在寻找相同问题的人：https://nickheath.net/2019/02/20/asp-net-core-enum-route-constraints/

我刚刚个性化：

namespace MyWebApp
{
    using Microsoft.AspNetCore.Http;
    using Microsoft.AspNetCore.Routing;
    public static partial class Extensions
    {
        public class CustomRouteConstraint<TEnum> : IRouteConstraint
            where TEnum : struct, Enum
        {
            public bool Match(HttpContext httpContext, IRouter route, string routeKey, RouteValueDictionary values, RouteDirection routeDirection)
            {
                // retrieve the candidate value
                var candidate = values[routeKey]?.ToString();
                // attempt to parse the candidate to the required Enum type, and return the result
                return Enum.TryParse(candidate, true, out TEnum _);
            }
        }
    }
}

在 startup.cs 上：

public void ConfigureServices(IServiceCollection services)
{
    //...
    //! Enum route constraints: ref https://nickheath.net/2019/02/20/asp-net-core-enum-route-constraints/
    services.Configure<Microsoft.AspNetCore.Routing.RouteOptions>(options =>
    {
        options.ConstraintMap.Add("MyCustomEnum", typeof(MyWebApp.Extensions.CustomRouteConstraint<Models.MyCustomEnum>));
    });
    //...
}

终于行动起来了：

[Route("/{area:MyCustomEnum}")]
public async Task<IActionResult> ViewAsync(MyCustomEnum area)
{
    //...
}

Answer 2

如果您只想将值解析为 Enum 对象，那么您只需为每个 Enum 类型添加自定义模型绑定器

Custom Model Binding in ASP.NET Core

Answer 3

您的问题是，通过希望将路由参数的值限制为枚举值，您使用了不正确的路由约束：您不能使用枚举的名称作为路由约束（供参考，有效的路由限制列在this page)

你不需要指定约束来标记一个路由参数为可选，你可以使用问号：

[HttpPost("filter-reports/{reportStatus?}/{IsNecessary:bool?}/{completionStatus?}")]
[Authorize]
public ObjectResult GetDamageReportByFilters(StatusEnum? reportStatus, bool? IsNecessary, completionStatusEnum? completionStatus)
{
    var result = _reportService.GetReportByFilters(reportStatus,IsNecessary, completionStatus);

    return StatusCode(200, result);
}

请注意，由于没有路由约束，因此可以将任何值传递给 enum 参数。如果那不是有效值，则传递给函数的实际值为 0。如果 0 映射到有效的枚举值，则使用该值，否则只需处理 0 值（在 C# 中，任何 @987654323 @value 可以存储在枚举中）。

Answer 4

一种更简单的方法（无需关心约束映射）是用实际枚举值的简单字符串/整数表示替换您方法的 StateEnum 参数，并将其作为参数的一部分在您的方法中解析。

[HttpPost("Test/{state}")]
public IActionResult TestMethod(string state)
{
    if (!Enum.TryParse(state, true, out StateEnum stateEnumValue))
        return BadRequest();

    // Do stuff here

    return Accepted();
}

[HttpPost("Test2/{state}")]
public IActionResult TestMethod2(int state)
{
    StateEnum stateEnumValue = (StateEnum) state;
    // Do stuff here
    return Accepted();
}

public enum StateEnum
{
    FirstState = 1,
    SecondState = 2
}

但由于您的参数是可选的，您可以尝试使用查询字符串来代替，允许您省略不需要的参数来请求。或者（正如其他答案所建议的那样）使用代表您的参数的 pbject （因为在那里管理可选内容更容易）

Answer 5

路由中不能有可选参数；

如果reportStatus 和isNecessary 是可选的，URL 会是什么样子？

../filter-reports/?/?/COMPLETED?

从你的参数中创建一个模型并将其发送到 post 方法的主体中，然后它们可以是可选的