asp.net-web-api – Web API ModelBinders – 如何以不同方式绑定对象的一个​​属性

我有以下行动签名

[ValidateInput(false)]
    public HttpResponseMessage PostParam(Param param)

Param看起来像这样：

public class Param {
  public int Id { get; set;}
  public string Name { get; set; }
  public string Choices { get; set; }
}

这就是故障 – 电线上的内容是这样的

{
  Id: 2,Name: "blah",Choices: [
    {
      foo: "bar"
    },{
      blah: "blo"
      something: 123
    }
  ]
}

我不希望“选择”反序列化 – 我希望它存储为字符串(是的,我理解安全隐患).可以理解,我收到一个错误,因为默认的绑定器不知道这个.

现在使用Asp Mvc创建一个特定的ModelBinder会相当简单. ID

>继承DefaultModelBinder
>使用我自己的方法覆盖属性反序列化
>使用Binders.Add在我的Application_Start中设置活页夹

看起来像Web Api这是一个不同的过程 – System.Web.DefaultModelBinder没有任何要覆盖的东西,我无法使用Binders.Add挂钩.我试过环顾四周但却找不到如何实际做我想做的事情.这更加复杂,因为显然ModelBinders api在Beta和RTM上发生了相当大的变化,因此有很多过时的信息.

解决方法

在Web API中,您必须区分三个概念 – ModelBinding,Formatters和ParameterBinding.这对于从/使用MVC的人来说非常困惑,我们只讨论ModelBinding.

与MVC相反,ModelBinding只负责从URI中提取数据. Formatters处理读取正文,ParameterBinding(HttpParameterBinding)包含前两个概念.

只有在想要彻底改变整个机制时(即允许两个对象从主体绑定,实现MVC样式绑定等),ParameterBinding才真正有用 – 对于更简单的任务,修改绑定器(针对URI特定数据)或格式化程序(针对正文)数据)几乎总是绰绰有余.

无论如何,关键 – 您可以使用自定义JSON.NET转换器轻松完成您想要实现的目标(JSON.NET是Web API JSON格式引擎背后的默认序列化库).

你需要做的就是：

public class Param
{
    public int Id { get; set; }
    public string Name { get; set; }

    [JsonConverter(typeof(CustomArrayConverter))]
    public string Choices { get; set; }
}

然后添加转换器：

internal class CustomArrayConverter : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        return true;
    }

    public override object ReadJson(JsonReader reader,Type objectType,object existingValue,JsonSerializer serializer)
    {
        var array = JArray.Load(reader);
        return JsonConvert.SerializeObject(array);
    }

    public override void WriteJson(JsonWriter writer,object value,JsonSerializer serializer)
    {
        serializer.Serialize(writer,JArray.Parse(value as string));
    }
}

在这种情况下,我们告诉转换器中的JSON.NET将Choices存储为字符串(在read方法中),当您将带有Choices属性的Param对象返回给客户端时(在write方法中),我们将获取字符串并序列化到数组,以便输出JSON看起来与输入JSON相同.

您可以像这样测试它：

public Param PostParam(Param param)
    {
        return param;
    }

并验证进入的数据是否符合您的要求,并且输出的数据与原始JSON相同.