当使用Json.Net序列化模型时，自动对字符串进行Html编码。

Question

有没有办法配置Json.Net在模型被序列化时自动编码所有字符串，就像HtmlEncode（myString）一样？

- Buda Gavril

---

我不认为会这样 - 我会期望它以 JSON 的方式编码字符串。它将内容进行 HTML 编码会非常奇怪。JSON 序列化程序的工作是将数据从 X 转换为 Y，格式为 JSON……它执行 HTML 编码就像是巨大的范围扩展。 - Jon Skeet

为什么不创建一个方法，你可以传入要序列化的对象，然后它返回一个HTML编码的字符串结果呢？ - user1628733

这是你所要求的吗？[编码] (https://dev59.com/-mzXa4cB1Zd3GeqPWK21) - Artyom

@Artyom，谢谢，这就是我在寻找的东西。谢谢。 - Buda Gavril

Answer 1

试试这个：

var json = JObject.Parse("{'Name':'<script>alert(1);</script>'}");
var serializerSettings = new JsonSerializerSettings()
{
    StringEscapeHandling = StringEscapeHandling.EscapeHtml
};
var result = JsonConvert.SerializeObject(json, serializerSettings);

结果将会是：

{"Name":"\u003cscript\u003ealert(1);\u003c/script\u003e"}

- Mohammad Nikravan

---

这个不会像 @Html.Encode() 一样编码字符串，但我发现它对我的使用场景很有帮助。 - Kevin Secrist

如果您使用上述转义的HTML加载到诸如jQuery.html函数之类的eval上下文中，则脚本将被执行。Http Utility HTML编码更好。 - gls123

不是回答我的问题，但正是我所需要的:D - HelloWorld

Answer 2

您可以使用类似于在反序列化期间有选择地转义字符串中的HTML的解决方案，只需进行一些小修改即可：

1. 将HtmlEncodingValueProvider更改为在GetValue中应用编码而不是SetValue（因此它在序列化而不是反序列化时执行编码）。
2. 更改解析器以将值提供程序应用于所有字符串属性，而不是查找属性。

这是最终代码的样子：

public class CustomResolver : DefaultContractResolver
{
    protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization)
    {
        IList<JsonProperty> props = base.CreateProperties(type, memberSerialization);

        // Attach an HtmlEncodingValueProvider instance to all string properties
        foreach (JsonProperty prop in props.Where(p => p.PropertyType == typeof(string)))
        {
            PropertyInfo pi = type.GetProperty(prop.UnderlyingName);
            if (pi != null)
            {
                prop.ValueProvider = new HtmlEncodingValueProvider(pi);
            }
        }

        return props;
    }

    protected class HtmlEncodingValueProvider : IValueProvider
    {
        PropertyInfo targetProperty;

        public HtmlEncodingValueProvider(PropertyInfo targetProperty)
        {
            this.targetProperty = targetProperty;
        }

        // SetValue gets called by Json.Net during deserialization.
        // The value parameter has the original value read from the JSON;
        // target is the object on which to set the value.
        public void SetValue(object target, object value)
        {
            targetProperty.SetValue(target, (string)value);
        }

        // GetValue is called by Json.Net during serialization.
        // The target parameter has the object from which to read the string;
        // the return value is the string that gets written to the JSON
        public object GetValue(object target)
        {
            string value = (string)targetProperty.GetValue(target);
            return System.Web.HttpUtility.HtmlEncode(value);
        }
    }
}

使用自定义的ContractResolver，代码如下：

var settings = new JsonSerializerSettings
{
    ContractResolver = new CustomResolver(),
    Formatting = Formatting.Indented
};

string json = JsonConvert.SerializeObject(your_object, settings);

小提琴: https://dotnetfiddle.net/RhFlk8

- Brian Rogers

---

很棒的解决方案！ - gls123

Answer 3

我发现了一种非常简单的方法来实现这个（WebAPI2）。

当你设置对象属性时，只需使用以下方式进行编码即可。

myObject.encoded_field = HttpUtility.HtmlEncode(your_html_content)

- BenW