ASP.NET Core 1 Web API 模型绑定数组

Question

如何在 ASP.NET Core 1 Web API 中使用 GET 模型绑定来自 URI 的数组（隐式或显式）？

在 ASP.NET Web API pre Core 1 中，这有效：

[HttpGet]
public void Method([FromUri] IEnumerable<int> ints) { ... }

如何在 ASP.NET Web API Core 1 中执行此操作？文档什么也没有。

Answer 1

FromUriAttribute

类结合了

FromRouteAttribute

和

FromQueryAttribute

类。根据路由的配置/发送的请求，您应该能够用其中之一替换您的属性。

但是，有一个可用的垫片可以为您提供

FromUriAttribute

类。通过包资源管理器安装“Microsoft.AspNet.Mvc.WebApiCompatShim”NuGet 包，或将其直接添加到您的project.json 文件中：

"dependencies": {
  "Microsoft.AspNet.Mvc.WebApiCompatShim": "6.0.0-rc1-final"
}

虽然有点旧，但我发现这篇文章很好地解释了一些更改。

绑定

如果您希望为数组绑定逗号分隔值（“/api/values?ints=1,2,3”），您将像以前一样需要一个自定义绑定器。这是Mrchief 解决方案的改编版本，用于 ASP.NET Core。

public class CommaDelimitedArrayModelBinder : IModelBinder
{
    public Task BindModelAsync(ModelBindingContext bindingContext)
    {
        if (bindingContext.ModelMetadata.IsEnumerableType)
        {
            var key = bindingContext.ModelName;
            var value = bindingContext.ValueProvider.GetValue(key).ToString();

            if (!string.IsNullOrWhiteSpace(value))
            {
                var elementType = bindingContext.ModelType.GetTypeInfo().GenericTypeArguments[0];
                var converter = TypeDescriptor.GetConverter(elementType);

                var values = value.Split(new[] { "," }, StringSplitOptions.RemoveEmptyEntries)
                    .Select(x => converter.ConvertFromString(x.Trim()))
                    .ToArray();

                var typedValues = Array.CreateInstance(elementType, values.Length);

                values.CopyTo(typedValues, 0);
                
                bindingContext.Result = ModelBindingResult.Success(typedValues);
            }
            else
            {
                // change this line to null if you prefer nulls to empty arrays 
                bindingContext.Result = ModelBindingResult.Success(Array.CreateInstance(bindingContext.ModelType.GetElementType(), 0));
            }

            return TaskCache.CompletedTask;
        }

        return TaskCache.CompletedTask;
    }
}

您可以指定用于

Startup.cs

中所有集合的模型绑定器：

public void ConfigureServices(IServiceCollection services)
{
    // Add framework services.
    services.AddMvc().AddMvcOptions(opts =>
        {
            opts.ModelBinders.Insert(0, new CommaDelimitedArrayModelBinder());
        });
}

或者在 API 调用中指定一次：

[HttpGet]
public void Method([ModelBinder(BinderType = typeof(CommaDelimitedArrayModelBinder))] IEnumerable<int> ints)

Answer 2

ASP.NET Core 1.1 答案

@WillRay 的答案有点过时了。我写了一个“IModelBinder”和“IModelBinderProvider”。第一个可以与

[ModelBinder(BinderType = typeof(DelimitedArrayModelBinder))]

属性一起使用，而第二个可以用于全局应用模型绑定器，如下所示。

.AddMvc(options =>
{
    // Add to global model binders so you don't need to use the [ModelBinder] attribute.
    var arrayModelBinderProvider = options.ModelBinderProviders.OfType<ArrayModelBinderProvider>().First();
    options.ModelBinderProviders.Insert(
        options.ModelBinderProviders.IndexOf(arrayModelBinderProvider),
        new DelimitedArrayModelBinderProvider());
})

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

        if (context.Metadata.IsEnumerableType && !context.Metadata.ElementMetadata.IsComplexType)
        {
            return new DelimitedArrayModelBinder();
        }

        return null;
    }
}

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

        var modelName = bindingContext.ModelName;
        var valueProviderResult = bindingContext.ValueProvider.GetValue(modelName);
        var values = valueProviderResult
            .ToString()
            .Split(new char[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
        var elementType = bindingContext.ModelType.GetTypeInfo().GenericTypeArguments[0];

        if (values.Length == 0)
        {
            bindingContext.Result = ModelBindingResult.Success(Array.CreateInstance(elementType, 0));
        }
        else
        {
            var converter = TypeDescriptor.GetConverter(elementType);
            var typedArray = Array.CreateInstance(elementType, values.Length);

            try
            {
                for (int i = 0; i < values.Length; ++i)
                {
                    var value = values[i];
                    var convertedValue = converter.ConvertFromString(value);
                    typedArray.SetValue(convertedValue, i);
                }
            }
            catch (Exception exception)
            {
                bindingContext.ModelState.TryAddModelError(
                    modelName,
                    exception,
                    bindingContext.ModelMetadata);
            }

            bindingContext.Result = ModelBindingResult.Success(typedArray);
        }

        return Task.CompletedTask;
    }
}

Answer 3

.NET Core 3 中有一些变化。

Microsoft 已将功能从 AddMvc 方法中分离出来（source）。

由于 AddMvc 还包括对视图控制器、Razor 视图等的支持。如果您不需要在项目中使用它们（例如在 API 中），您可以考虑使用用于 Web API 控制器的 services.AddControllers() 。

因此，更新后的代码将如下所示：

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers()
            .AddMvcOptions(opt =>
            {
                var mbp = opt.ModelBinderProviders.OfType<ArrayModelBinderProvider>().First();
                    opt.ModelBinderProviders.Insert(opt.ModelBinderProviders.IndexOf(mbp), new DelimitedArrayModelBinderProvider());
            });
}