ASP.NET Core 7 Web API无法从查询字符串获取枚举列表值

问题根源 #

你配置的JsonStringEnumConverter仅负责JSON请求体的枚举序列化/反序列化，而URL查询参数的绑定由ASP.NET Core的模型绑定系统处理，两者是独立机制，所以之前的配置对Query参数无效。客户端传的逗号分隔枚举字符串无法被默认模型绑定器正确解析为List<EnumName>，导致出现错误值。

解决方案 #

以下是两种无需修改客户端请求格式的服务端处理方案：

方案1：全局注册自定义枚举列表模型绑定器

创建通用模型绑定器，自动处理所有List<TEnum>（TEnum为枚举类型）的Query参数绑定：

1. 实现模型绑定器和绑定器提供器：

public class EnumListModelBinder : IModelBinder
{
    public Task BindModelAsync(ModelBindingContext bindingContext)
    {
        if (bindingContext == null)
            throw new ArgumentNullException(nameof(bindingContext));

        var valueProviderResult = bindingContext.ValueProvider.GetValue(bindingContext.ModelName);
        if (valueProviderResult == ValueProviderResult.None)
            return Task.CompletedTask;

        bindingContext.ModelState.SetModelValue(bindingContext.ModelName, valueProviderResult);

        var rawValue = valueProviderResult.FirstValue;
        if (string.IsNullOrWhiteSpace(rawValue))
        {
            bindingContext.Result = ModelBindingResult.Success(null);
            return Task.CompletedTask;
        }

        var enumType = bindingContext.ModelType.GetGenericArguments()[0];
        try
        {
            var enumValues = rawValue.Split(',', StringSplitOptions.RemoveEmptyEntries)
                .Select(s => Enum.Parse(enumType, s.Trim(), ignoreCase: false))
                .ToList();

            bindingContext.Result = ModelBindingResult.Success(enumValues);
        }
        catch (ArgumentException ex)
        {
            bindingContext.ModelState.TryAddModelError(bindingContext.ModelName, $"无效的枚举值：{ex.Message}");
            bindingContext.Result = ModelBindingResult.Failed();
        }

        return Task.CompletedTask;
    }
}

public class EnumListModelBinderProvider : IModelBinderProvider
{
    public IModelBinder GetBinder(ModelBinderProviderContext context)
    {
        if (context == null)
            throw new ArgumentNullException(nameof(context));

        if (context.Metadata.ModelType.IsGenericType &&
            context.Metadata.ModelType.GetGenericTypeDefinition() == typeof(List<>) &&
            context.Metadata.ModelType.GetGenericArguments()[0].IsEnum)
        {
            return new EnumListModelBinder();
        }

        return null;
    }
}

2. 在Program.cs中注册绑定器提供器：

builder.Services.AddControllers(options =>
{
    // 将自定义绑定器放在最前面，优先使用
    options.ModelBinderProviders.Insert(0, new EnumListModelBinderProvider());
});

完成后，所有List<TEnum>类型的Query参数都会自动解析逗号分隔的字符串，无需修改控制器代码。

方案2：针对单个参数指定模型绑定器

如果不需要全局生效，可直接在控制器参数上标注自定义绑定器：

public async Task<ActionResult> ApiName(
    [FromQuery] int Id, 
    [FromQuery, ModelBinder(BinderType = typeof(EnumListModelBinder))] List<EnumName> ListEnum)
{
    // 业务逻辑
}

这种方式更灵活，仅作用于当前参数。

额外说明

如果允许修改客户端请求格式，也可以将Query参数改为重复键值对形式（如ListEnum=EnumVal1&ListEnum=EnumVal2），ASP.NET Core的默认模型绑定器会自动识别并绑定为List<EnumName>，无需额外配置。

内容的提问来源于stack exchange，提问作者M.Parent