使用Json.Net序列化模型时自动使用HtmlEncode字符串

时间:2017-05-22 14:49:13

标签: c# serialization json.net html-encode

有没有办法将Json.Net配置为在序列化模型时自动编码HtmlEncode(myString)之类的所有字符串?

3 个答案:

答案 0 :(得分:4)

您可以使用类似于Selectively escape HTML in strings during deserialization中的解决方案,并进行一些小的更改:

  1. 更改HtmlEncodingValueProvider以在GetValue而不是SetValue中应用编码(以便它在序列化而不是反序列化时进行编码)。
  2. 更改解析程序以将值提供程序应用于所有字符串属性,而不是查找属性。
  3. 以下是生成的代码:

    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

答案 1 :(得分:4)

试试这个:

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"}

答案 2 :(得分:0)

我找到了一种非常简单的方法(WebAPI2)。

设置对象属性时,只需在下面进行编码。

myObject.encoded_field = HttpUtility.HtmlEncode(您的html_content)