在反序列化期间有选择地转义字符串中的 HTML

Question

我正在寻找编写一个JsonConverter在字符串中转义 HTML 的代码，除非[AllowHtml]已应用该属性；

    private class ObjectWithStrings
    {
        // will be HTML-escaped
        public string Name { get; set; }

        // won't be escaped
        [AllowHtml]
        public string Unsafe { get; set; }
    }

所以我试图用自定义的 ReadJson 属性编写一个 JsonConverter；

    public override bool CanConvert(Type objectType)
    {
        return objectType == typeof(string);
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        var s = (string)reader.Value;
        if (s == null)
        {
            return null;
        }

        // here I need to get a PropertyInfo so I can call GetCustomAttribute<AllowHtmlAttribute>();

        var encoded = System.Web.Security.AntiXss.AntiXssEncoder.HtmlEncode(s, useNamedEntities: true);
        return encoded;
    }

我的差距是我看不到 Json.Net 是否会让我知道我正在阅读的属性。因此，我无法弄清楚如何获取属性的自定义属性。

有没有办法找出我要序列化的属性，或者为这种事情推荐的不同模式？

编辑：我没有写出明确的问题；我试图编写一个JsonConverter反序列化字符串的方法，请参阅上面的CanConvert(). 我怀疑选择是我问题的开始；我可能需要反序列化具有字符串属性的对象，并进行标准反序列化，除非反序列化特定属性。

Answer 1

在自定义 中JsonConverter，您可以找到正在反序列化的 JSON 属性的名称，方法是Path从JsonReader.

string propertyName = reader.Path.Split('.').Last();

但是，这并不能解决您的整体问题。假设 JSON 属性的名称与您的目标类属性匹配，您仍然需要一种方法来获取父对象类型，以便从中获取自定义属性。不幸的是，您无法在转换器中使用此信息。转换器旨在仅负责它所说的可以转换的对象类型（在您的情况下是字符串），以及该对象的子属性（在这种情况下没有，因为字符串是原始类型）。因此，要使其工作，需要编写转换器以对父级进行操作类，然后需要处理该类的所有字符串属性。由于您的目标似乎是将 HTML 编码行为应用于所有类中的所有字符串，因此您需要一个通用转换器来处理所有非原始类型，这可能会变得非常混乱，具体取决于您尝试的范围反序列化。

幸运的是，有更好的方法。JsonConverter您可以将自定义IContractResolver与 a 结合使用IValueProvider来解决此问题，而不是使用。AContractResolver更适合于您希望广泛应用某种行为的此类问题。

下面是您需要的代码示例。的CustomResolver类扩展DefaultContractResolver由Json.Net提供。该CreateProperties()方法检查JsonProperty由基本解析器创建的对象，并将内部HtmlEncodingValueProvider类的实例附加到任何未[AllowHtml]应用该属性的字符串属性。每个值提供程序稍后通过该SetValue()方法处理其目标字符串属性的实际编码。

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

        // Find all string properties that do not have an [AllowHtml] attribute applied
        // and attach an HtmlEncodingValueProvider instance to them
        foreach (JsonProperty prop in props.Where(p => p.PropertyType == typeof(string)))
        {
            PropertyInfo pi = type.GetProperty(prop.UnderlyingName);
            if (pi != null && pi.GetCustomAttribute(typeof(AllowHtmlAttribute), true) == 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)
        {
            var encoded = System.Web.Security.AntiXss.AntiXssEncoder.HtmlEncode((string)value, useNamedEntities: true);
            targetProperty.SetValue(target, encoded);
        }

        // 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)
        {
            // if you need special handling for serialization, add it here
            return targetProperty.GetValue(target);
        }
    }
}

要使用解析器，请创建一个新JsonSerializerSettings实例，然后将其ContractResolver属性设置为自定义解析器的新实例，并将设置传递给该JsonConvert.DeserializeObject()方法。

这是一个简短的演示：

class Program
{
    static void Main(string[] args)
    {
        string json = @"
        { 
            ""Name"" : ""<b>Foo Bar</b>"", 
            ""Description"" : ""<p>Bada Boom Bada Bing</p>"", 
        }";

        JsonSerializerSettings settings = new JsonSerializerSettings
        {
            ContractResolver = new CustomResolver()
        };

        Foo foo = JsonConvert.DeserializeObject<Foo>(json, settings);
        Console.WriteLine("Name: " + foo.Name);
        Console.WriteLine("Desc: " + foo.Description);
    }
}

class Foo
{
    public string Name { get; set; }
    [AllowHtml]
    public string Description { get; set; }
}

class AllowHtmlAttribute : Attribute { }

这是输出。请注意，该Name属性获得了 HTML 编码，而该Description属性则没有。

Name: <b>Foo Bar</b>
Desc: <p>Bada Boom Bada Bing</p>

小提琴：https : //dotnetfiddle.net/cAg4NC