一尘不染

反序列化时的备用属性名称

c#

关于这个问题:

使用Json.net进行序列化时,如何更改属性名称?

当然可以,但是我可以吃点蛋糕吗?

我正在寻找的是一种令人赏心悦目的方式,为属性提供一个备用名称,以使该字符串可以包含其中一个。

就像是:

[BetterJsonProperty(PropertyName = "foo_bar")]
public string FooBar { get; set; }

{
     "FooBar": "yup"
}

{     
      "foo_bar":"uhuh"
}

将按预期反序列化。

作为无属性的解决方案将起作用或类上的属性有效:

 [AllowCStylePropertyNameAlternatives]

阅读 278

收藏
2020-05-19

共1个答案

一尘不染

实现此目的的一种方法是创建一个自定义JsonConverter。想法是让转换器枚举我们感兴趣的对象的JSON属性名称,从名称中剥离非字母数字字符,然后尝试通过反射将它们与实际的对象属性进行匹配。这是它在代码中的外观:

public class LaxPropertyNameMatchingConverter : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        return objectType.IsClass;
    }

    public override bool CanWrite
    {
        get { return false; }
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        object instance = objectType.GetConstructor(Type.EmptyTypes).Invoke(null);
        PropertyInfo[] props = objectType.GetProperties();

        JObject jo = JObject.Load(reader);
        foreach (JProperty jp in jo.Properties())
        {
            string name = Regex.Replace(jp.Name, "[^A-Za-z0-9]+", "");

            PropertyInfo prop = props.FirstOrDefault(pi => 
                pi.CanWrite && string.Equals(pi.Name, name, StringComparison.OrdinalIgnoreCase));

            if (prop != null)
                prop.SetValue(instance, jp.Value.ToObject(prop.PropertyType, serializer));
        }

        return instance;
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        throw new NotImplementedException();
    }
}

要将自定义转换器与特定的类一起使用,可以使用如下[JsonConverter]属性装饰该类:

[JsonConverter(typeof(LaxPropertyNameMatchingConverter))]
public class MyClass
{
    public string MyProperty { get; set; }
    public string MyOtherProperty { get; set; }
}

这是运行中的转换器的简单演示:

class Program
{
    static void Main(string[] args)
    {
        string json = @"
        [
            { 
                ""my property"" : ""foo"",
                ""my-other-property"" : ""bar"",
            },
            { 
                ""(myProperty)"" : ""baz"",
                ""myOtherProperty"" : ""quux""
            },
            { 
                ""MyProperty"" : ""fizz"",
                ""MY_OTHER_PROPERTY"" : ""bang""
            }
        ]";

        List<MyClass> list = JsonConvert.DeserializeObject<List<MyClass>>(json);

        foreach (MyClass mc in list)
        {
            Console.WriteLine(mc.MyProperty);
            Console.WriteLine(mc.MyOtherProperty);
        }
    }
}

输出:

foo
bar
baz
quux
fizz
bang

尽管此解决方案在大多数情况下 都能 胜任,但 如果您可以直接更改Json.Net源代码
,可以使用一个更简单的解决方案。事实证明,您只需在Newtonsoft.Json.Serialization.JsonPropertyCollection类中添加一行代码即可完成相同的操作。在此类中,有一个称为的方法GetClosestMatchProperty(),如下所示:

public JsonProperty GetClosestMatchProperty(string propertyName)
{
    JsonProperty property = GetProperty(propertyName, StringComparison.Ordinal);
    if (property == null)
        property = GetProperty(propertyName, StringComparison.OrdinalIgnoreCase);

    return property;
}

在反序列化器调用此方法的时候,JsonPropertyCollection包含要反序列化的类的所有属性,而propertyName参数包含要匹配的JSON属性名称的名称。如您所见,该方法首先尝试精确名称匹配,然后尝试不区分大小写的匹配。因此,我们已经在JSON和类属性名称之间完成了多对一映射。

如果修改此方法以在匹配属性名称之前从属性名称中删除所有非字母数字字符,则无需任何特殊的转换器或属性,就可以得到所需的行为。这是修改后的代码:

public JsonProperty GetClosestMatchProperty(string propertyName)
{
    propertyName = Regex.Replace(propertyName, "[^A-Za-z0-9]+", "");
    JsonProperty property = GetProperty(propertyName, StringComparison.Ordinal);
    if (property == null)
        property = GetProperty(propertyName, StringComparison.OrdinalIgnoreCase);

    return property;
}

当然,修改源代码也有其问题,但我认为值得一提。

2020-05-19