将路由查询参数绑定到默认值属性而无需在 URL 中指定

Question

我正在创建一个 .NET Core 3 WebApi，并且我有一些 'troubles' 来自查询参数的模型绑定。我有一个 Range class 和 Min、Max 结束 Value 属性。这个class的用法是用一个范围或者一个常量值来过滤。

    public class Range
    {
        public int? Min { get; set; }
        public int? Max { get; set; }
        public int? Value { get; set; }
        public static implicit operator Range(int value) => new Range {Value = value};
    }

当我没有定义子属性时，我希望它绑定到 Value 属性，例如 api/contacts?age=40.
Min 和 Max 按计划使用默认绑定方式，如 api/contacts?age.min=18&age.max=30。我认为添加隐式运算符会起作用，但它不起作用。

有没有办法（比如属性）使 Value 成为默认值属性？

Answer 1

当您将 'int' 值分配给 'Range' 对象时，隐式运算符会进行隐式转换。但无法应用于ASP.NETCore的模型绑定场景。模型绑定只检查来自请求的数据并调用模型绑定器绑定不同类型的数据类.

asp.net核心框架也提供了'TypeConverter'来判断是否应该将字符串转换为对象。然而，它只能处理一个查询字符串并扰乱了一个通用的模型绑定过程。（例如 age.max 和 age.min）。

对于你的问题，我建议的唯一方法是构建一个自定义模型绑定器，以便它将按照自定义规则绑定数据：（以你的案例为例）

复杂模型自定义模型绑定步骤如下：

创建一个自定义活页夹，例如，RangeEntityBinder 应该扩展 IModelBinder
创建自定义活页夹提供程序，例如，RangeEntityBinderProvider 应扩展 IModelBinderProvider
在启动文件
的ConfigureServices中将binder provider注册到ModelBinderProviders

根据您的描述，我制作了一个demo，您可以参考。

控制器：

public IActionResult RangePage(Range age) 
        {
            if(age == null)
            {
                age = new Range();
            }
            return View(age);
        }

RangePage.cshtml:

<a asp-controller="Home" asp-action="RangePage" asp-route-age.min="18" asp-route-age.max="30">age.min=18&age.max=30</a>
<br />
<a asp-controller="Home" asp-action="RangePage" asp-route-age="40">age=40</a>
<div class="container">
    <label asp-for="Max">Max: </label>@Model.Max
    <br />
    <label asp-for="Min">Min: </label>@Model.Min
    <br />
    <label asp-for="Value">Value: </label>@Model.Value
</div>

Range.cs

public class Range
{
    public int? Min { get; set; }
    public int? Max { get; set; }

    public int? Value { get; set; }

}

RangeEntityBinder.cs

public class RangeEntityBinder : IModelBinder
    {
        private readonly ComplexTypeModelBinder worker;


        public RangeEntityBinder(Dictionary<ModelMetadata, IModelBinder> propertyBinders, ILoggerFactory loggerFactory)
        {
            worker = new ComplexTypeModelBinder(propertyBinders, loggerFactory);
        }

        public async Task BindModelAsync(ModelBindingContext bindingContext)
        {
            if (bindingContext == null)
            {
                throw new ArgumentNullException(nameof(bindingContext));
            }

            // Try get the "age" to populate the model
            var modelName = bindingContext.ModelName;

            // Try to fetch the value of the argument by name
            var valueProviderResult = bindingContext.ValueProvider.GetValue(modelName);

            // If find 'age', return Range object with Value="age"
            // If not, use ComplexTypeModelBinder do the common binding
            if (valueProviderResult == ValueProviderResult.None)
            {
                await this.worker.BindModelAsync(bindingContext);
                if (!bindingContext.Result.IsModelSet)
                {
                    return;
                }

                var model= bindingContext.Result.Model as Range;
                if (model== null)
                {
                    throw new InvalidOperationException($"Expected {bindingContext.ModelName} to have been bound by ComplexTypeModelBinder");
                }
            }
            else
            {
                var value = valueProviderResult.FirstValue;

                // Check if the argument value is null or empty
                if (string.IsNullOrEmpty(value))
                {
                    await Task.CompletedTask;
                }

                if (!int.TryParse(value, out var ageValue))
                {
                    // Non-integer arguments result in model state errors
                    bindingContext.ModelState.TryAddModelError(
                        modelName, "Age value must be an integer.");

                    await Task.CompletedTask;
                    return;
                }

                var model = new Range()
                {
                    Value = ageValue
                };

                bindingContext.Result = ModelBindingResult.Success(model);
                await Task.CompletedTask;
            }


        }
    }

RangeEntityBinderProvider.cs

public class RangeEntityBinderProvider: IModelBinderProvider
    {

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

            // If type is Range, use RangeEntityBinder to bind model
            if (context.Metadata.ModelType == typeof(Range))
            {
                var propertyBinders = new Dictionary<ModelMetadata, IModelBinder>();
                for (var i = 0; i < context.Metadata.Properties.Count; i++)
                {
                    var property = context.Metadata.Properties[i];
                    propertyBinders.Add(property, context.CreateBinder(property));
                }

                var loggerFactory = context.Services.GetRequiredService<ILoggerFactory>();

                return new RangeEntityBinder(propertyBinders, loggerFactory);
            }

            return null;
        }
    }

配置服务方法

public void ConfigureServices(IServiceCollection services)
        {
            /* Other services*/

            services.AddMvc(options =>
            {
                options.ModelBinderProviders.Insert(0, new RangeEntityBinderProvider());
            });

            /* Other services*/

        }

演示：

将路由查询参数绑定到默认值属性而无需在 URL 中指定

Bind route query parameter to a default property without specifying it in the URL

c#

model-binding

asp.net-web-api

asp.net-core

将路由查询参数绑定到默认值 属性 而无需在 URL 中指定

Bind route query parameter to a default property without specifying it in the URL

c#

model-binding

asp.net-web-api

asp.net-core

将路由查询参数绑定到默认值属性而无需在 URL 中指定