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

Question

我有以下 Action 签名

    [ValidateInput(false)]
    public HttpResponseMessage PostParam(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

用我自己的

覆盖属性反序列化

在我的 Application_Start 中设置活页夹使用 Binders.Add

似乎使用 Web Api 这是一个不同的过程 - System.Web.DefaultModelBinder 没有任何要覆盖的内容，我无法使用 Binders.Add 进行连接.我试过环顾四周，但找不到太多关于如何实际做我想做的事。这更加复杂，因为显然 ModelBinders api 在 Beta 和 RTM 上发生了相当大的变化，因此那里有很多过时的信息。

Answer 1

在 Web API 中，您必须区分三个概念 - ModelBinding , Formatters和 ParameterBinding .这对于从/习惯于 MVC 的人来说是相当困惑的，我们只讨论 ModelBinding .
ModelBinding与 MVC 不同，它只负责从 URI 中拉取数据。格式化程序处理读取正文，ParameterBinding ( HttpParameterBinding ) 包含前两个概念。
ParameterBinding仅当您想要彻底改变整个机制时(即允许从主体绑定(bind)两个对象，实现 MVC 样式绑定(bind)等)时才真正有用 - 对于修改绑定(bind)器(针对 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如 string (在 read 方法中)，当您返回 Param带有 Choices 的对象属性给客户端(在 write 方法中)，我们取 string并序列化为 array以便输出 JSON 看起来与输入相同。

您现在可以像这样测试它:

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

并验证输入的数据是否如您所愿，输出的数据是否与原始 JSON 相同。