将多个属性名称映射到 Newtonsoft.JSON 中的同一字段

Question

我在分布式系统中有两个组件，它们发送使用 Newtonsoft.JSON (JSON.Net) 进行序列化/反序列化的消息。

消息属性目前以挪威语发送，我希望将代码库翻译成英语。由于某些消息会以挪威语发送，并由已升级到英文版的组件处理，因此需要能够同时支持这两种语言。

我希望在反序列化时，“挪威”属性名称和英语都将映射到同一个属性。例如：

例如，取英语中的“name”或挪威语中的“navn”。

public class Message
{
     [JsonProperty("Navn")]
     public string Name { get; set;}
}

上面的问题是它只能从Navn => Name 映射。我希望它将Navn 和Name 映射到Name。

这在 Newtonsoft.JSON 中是否可用，无需太多自定义编码？

Answer 1

您可以在此答案中使用自定义 ContractResolver：

Json.NET deserialize or serialize json string and map properties to different property names defined at runtime

或者

使用 [JsonProperty("")] 查找属性名称的不同变体并返回如下属性之一：

public class Message
{
   private string _name;

   [JsonProperty("Navn" )]
   public string NorwegianName { get; set; }

   [JsonProperty("Name")]
   public string Name { 
      get { return _name ?? NorwegianName; } 
      set { _name = value; } }
}

这将返回带有 JSON 属性名称的名称：Navn 或 Name。

Answer 2

我需要这样做，经过一些实验后，我发现为同一个 MemberInfo 返回多个 JsonProperties 的解析器运行良好。它还使用单个指定名称进行序列化，但可以从任何一个名称中读取。我正在使用此迁移名称，它不希望在源 json 中找到多个可能的名称。

public class TestClass
{
    [FallbackJsonProperty("fn", "firstName", "first_name")]
    public string FirstName {get;set;}
}

public class ThingResolver : CamelCasePropertyNamesContractResolver
{
    protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization)
    {
        var typeMembers = GetSerializableMembers(type);
        var properties = new List<JsonProperty>();

        foreach (var member in typeMembers)
        {
            var property = CreateProperty(member, memberSerialization);
            properties.Add(property);
            
            var fallbackAttribute = member.GetCustomAttribute<FallbackJsonProperty>();

            if (fallbackAttribute == null)
            {
                continue;
            }

            property.PropertyName = fallbackAttribute.PreferredName;
            
            foreach (var alternateName in fallbackAttribute.FallbackReadNames)
            {
                var fallbackProperty = CreateProperty(member, memberSerialization);
                fallbackProperty.PropertyName = alternateName;
                fallbackProperty.ShouldSerialize = (x) => false;
                properties.Add(fallbackProperty);
            }
        }

        return properties;
    }
}

[AttributeUsage(AttributeTargets.Property)]
public class FallbackJsonProperty : Attribute
{
    public string PreferredName { get; }
    public string[] FallbackReadNames { get; }

    public FallbackJsonProperty(string preferredName, params string[] fallbackReadNames)
    {
        PreferredName = preferredName;
        FallbackReadNames = fallbackReadNames;
    }
}