如何使用 Json.NET 将 IHtmlString 序列化为 JSON？

我有一个包含通过 JSON 发布的原始 HTML 的字段，该字段最近从字符串转换为 IHtmlString。当这个变化发生时，该字段从一个 JSON 字符串变成一个空对象，并且一堆消耗 JSON 的东西开始爆炸。

// When it was a string...
{
    someField: "some <span>html</span> string"
}

// When it became an IHtmlString...
{
    someField: { }
}

忽略任何反对 JSON 中原始 HTML 的参数，因为它对于这个项目来说是没有意义的，如何在 JSON 序列化中获取预期的字符串？

背景

Json.NET 和默认的 .NET JavaScriptSerializer 都会处理以下实例IHtmlString作为没有属性的对象并将其序列化为空对象。为什么？因为它是一个只有一种方法的接口，并且方法不会序列化为 JSON。

public interface IHtmlString {
    string ToHtmlString();
}

Solution

对于 Json.NET，您需要创建一个自定义JsonConverter这将消耗一个IHtmlString并输出原始字符串。

public class IHtmlStringConverter : Newtonsoft.Json.JsonConverter {
    public override bool CanConvert(Type objectType) {
        return typeof(IHtmlString).IsAssignableFrom(objectType);
    }

    public override void WriteJson(Newtonsoft.Json.JsonWriter writer, object value, Newtonsoft.Json.JsonSerializer serializer) {
        IHtmlString source = value as IHtmlString;
        if (source == null) {
            return;
        }

        writer.WriteValue(source.ToString());
    }

    public override object ReadJson(Newtonsoft.Json.JsonReader reader, Type objectType, object existingValue, Newtonsoft.Json.JsonSerializer serializer) {
        // warning, not thoroughly tested
        var html = reader.Value as string;
        return html == null ? null : System.Web.Mvc.MvcHtmlString.Create(html);
    }
}

完成后，发送您的新实例IHtmlStringConverter到 Json.NET 的SerializeObject call.

string json = JsonConvert.SerializeObject(objectWithAnIHtmlString, new[] { new IHtmlStringConverter() });

示例代码

有关控制器演示此内容的示例 MVC 项目，请访问这个问题的 GitHub 存储库 https://github.com/patridge/JsonNetIHtmlStringTesting.