Question

我有一个请求模型类，我正在尝试使用默认的Web API 2模型绑定（.NET 4.6.1）。一些查询字符串参数与模型属性匹配，但有些不匹配。

public async Task<IHttpActionResult> Get([FromUri]MyRequest request) {...}

示例查询字符串：

/api/endpoint?country=GB

样本模型属性：

public class MyRequest
{
    [JsonProperty("country")] // Did not work
    [DataMember(Name = "country")] // Also did not work
    public string CountryCode { get; set; }
    // ... other properties
}

是否有一种方法可以在模型上使用属性（例如您可能使用[JsonProperty("country")]）来避免实现自定义模型绑定？还是最好的方法只是使用创建特定的模型来绑定QueryString，然后使用AutoMapper定制差异？

Answer 1

根据进一步的研究，Web API中的默认模型绑定行为不支持JsonProperty或DataMember属性，最有可能的解决方案似乎是（1）自定义模型绑定器或（2）维护2组模型以及它们之间的映射。

我选择了自定义模型联编程序（下面的实现），因此我可以重复使用它，而不必复制我的所有模型（并维护每个模型之间的映射）。

用法

以下实现允许我让任何模型可选地使用JsonProperty进行模型绑定，但是如果未提供，则默认为仅属性名称。它支持来自标准.NET类型（字符串，整数，双精度型等）的映射。尚未完全投入生产，但到目前为止满足我的用例。

[ModelBinder(typeof(AttributeModelBinder))]
public class PersonModel
{
    [JsonProperty("pid")]
    public int PersonId { get; set; }

    public string Name { get; set; }
}

这允许在查询中映射以下查询字符串：

/api/endpoint?pid=1&name=test

实施

首先，该解决方案定义了一个映射属性，以跟踪模型的源属性以及在从值提供者设置值时要使用的目标名称。

public class MappedProperty
{
    public MappedProperty(PropertyInfo source)
    {
        this.Info = source;
        this.Source = source.Name;
        this.Target = source.GetCustomAttribute<JsonPropertyAttribute>()?.PropertyName ?? source.Name;
    }
    public PropertyInfo Info { get; }
    public string Source { get; }
    public string Target { get; }
}

然后，定义了一个自定义模型绑定程序来处理映射。它缓存反映的模型属性，以避免在后续调用中重复反映。可能尚未完全投入生产，但初步测试很有希望。

public class AttributeModelBinder : IModelBinder
{
    public static object _lock = new object();
    private static Dictionary<Type, IEnumerable<MappedProperty>> _mappings = new Dictionary<Type, IEnumerable<MappedProperty>>();


    public IEnumerable<MappedProperty> GetMapping(Type type)
    {
        if (_mappings.TryGetValue(type, out var result)) return result; // Found
        lock (_lock)
        {
            if (_mappings.TryGetValue(type, out result)) return result; // Check again after lock
            return (_mappings[type] = type.GetProperties().Select(p => new MappedProperty(p)));
        }
    }

    public object Convert(Type target, string value)
    {
        try
        {
            var converter = TypeDescriptor.GetConverter(target);
            if (converter != null)
                return converter.ConvertFromString(value);
            else
                return target.IsValueType ? Activator.CreateInstance(target) : null;
        }
        catch (NotSupportedException)
        {
            return target.IsValueType ? Activator.CreateInstance(target) : null;
        }
    }

    public void SetValue(object model, MappedProperty p, IValueProvider valueProvider)
    {
        var value = valueProvider.GetValue(p.Target)?.AttemptedValue;
        if (value == null) return;
        p.Info.SetValue(model, this.Convert(p.Info.PropertyType, value));
    }

    public bool BindModel(HttpActionContext actionContext, ModelBindingContext bindingContext)
    {
        try
        {
            var model = Activator.CreateInstance(bindingContext.ModelType);
            var mappings = this.GetMapping(bindingContext.ModelType);
            foreach (var p in mappings)
                this.SetValue(model, p, bindingContext.ValueProvider);
            bindingContext.Model = model;
            return true;
        }
        catch (Exception ex)
        {
            return false;
        }
    }
}

Answer 2

最新答案，但最近我也遇到了这个问题。您可以简单地使用BindProperty属性：

public class MyRequest
{
    [BindProperty(Name = "country")]
    public string CountryCode { get; set; }
}

在.NET Core 2.1和2.2上测试

使用Web API默认模型绑定程序自定义属性名称？

2 个答案: