c# - 如何在C#中将Badgerfish样式的JSON转换为.NET对象或XML？

Question

.NET在使用RESTAPI时首选newtonsoft json序列化程序/反序列化程序。
D＆B直接REST实现使用BadgerFish方法（它主要存在于JavaWord（JavestNosiStof）中，JSON中有一些小的变化：D&B BadgerFish。
我想将D&B Badgerfish JSON响应映射到.NET类。
有一个GitHub项目https://github.com/bramstein/xsltjson/支持从xml到json（支持badgerfish）的转换，但是我如何做相反的事情，如下所述：
xsltjson支持几种不同的json输出格式，从紧凑的输出格式到支持badgerfish约定，后者允许xml和json之间的往返。
例如，假设d&b后端rest服务正在转换此xml：

<SalesRevenueAmount CurrencyISOAlpha3Code="USD”>1000000</SalesRevenueAmount>
<SalesRevenueAmount CurrencyISOAlpha3Code="CAD”>1040000</SalesRevenueAmount>

…进入：

"SalesRevenueAmount": [     {
   "@CurrencyISOAlpha3Code": "USD",
   "$": 1000000
},
{
   "@CurrencyISOAlpha3Code": "CAD",
   "$": 1040000
}
]

那么，我如何在.net rest客户机中使用这个返回的Badgerfish格式的JSON响应（稍微修改了原始规范）？

Answer 1

我也被要求使用D&B的API，在检查.NET中是否存在Badgerfish的现有解决方案时遇到了这个问题。
和你一样，我只需要担心反序列化到我的.NET模型中。
此外，在阅读了D&B的徽章鱼的变化后，我认为没有必要对它们进行特别的解释。下面的代码似乎可以很好地处理D&B的格式。
为什么是獾鱼？
似乎D&B已经有了一段时间的XML API，他们决定通过将现有的XML直接转换为JSON来生成JSON内容类型，而不是序列化为XML或JSON。
这就需要解决xml和json结构之间的不一致性。在XML中，可以将属性和值与单个元素关联。json中不存在这种范式。json只是键/值。
因此，BadgerFish是解决这两种数据格式之间不一致的标准。当然，它可以通过其他方式解决，这只是众多想法中的一个。
目标
为了解决这个问题，我首先需要弄清楚我的预期结果是什么。
使用您的示例，我决定使用以下json：

"SalesRevenueAmount": [
    {
       "@CurrencyISOAlpha3Code": "USD",
       "$": 1000000
    },
    {
       "@CurrencyISOAlpha3Code": "CAD",
       "$": 1040000
    }
]

应反序列化为模型集合，如下所示：

public class SalesRevenueAmount {
    public string CurrencyISOAlpha3Code { get; set; }
    public string Value { get; set; }
}

最简单的解决方案
最简单、最明显的解决方案是将 JsonProperty属性附加到我希望具有此 @或 $命名约定的每个属性。

public class SalesRevenueAmount {
    [JsonProperty("@CurrencyISOAlpha3Code")]
    public string CurrencyISOAlpha3Code { get; set; }
    [JsonProperty("$")]
    public string Value { get; set; }
}

这样做相对简单，但也极易出错。如果可以避免的话，我也不喜欢将基础设施层的特定属性附加到我的模型中。
更好的解决方案
因此，我推测一个更好的解决方案是不必维护和手工编写这些容易出错的注释。当然，我仍然需要编写属性名本身，但是可以在visual studio或您喜欢的任何ide中轻松地重构这些属性名。另一方面，在运行时或单元测试失败之前，不会捕获属性中的魔术字符串。
因此，我想要一些更自动，更结实，更干燥的东西。在深入研究了newtonsoft json之后，我终于找到了一个令我满意的解决方案。我创建了一个称为 JsonConverter的简单 BadgerFishJsonConverter。
当前的实现只处理反序列化，但调整它以进行序列化并不太困难。我只是还不需要。如果我以后这样做，我会回来更新我的答案。

public class BadgerFishJsonConverter : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        return true;
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        var source = JObject.Load(reader);

        //Since we can't modify the internal collections, first we will get all the paths.
        //Then we will proceed to rename them.
        var paths = new List<string>();
        collectPaths(source, paths);
        renameProperties(source, paths);

        return source.ToObject(objectType);
    }

    private void collectPaths(JToken token, ICollection<string> collection)
    {
        switch (token.Type)
        {
            case JTokenType.Object:
            case JTokenType.Array:
                foreach (var child in token)
                {
                    collectPaths(child, collection);
                }
                break;
            case JTokenType.Property:
                var property = (JProperty)token;

                if (shouldRenameProperty(property.Name))
                {
                    collection.Add(property.Path);
                }

                foreach (var child in property)
                {
                    collectPaths(child, collection);
                }
                break;
            default:
                break;
        }
    }

    private void renameProperties(JObject source, ICollection<string> paths)
    {
        foreach (var path in paths)
        {
            var token = source.SelectToken(path);
            token.Rename(prop => transformPropertyName(prop));
        }
    }

    private bool shouldRenameProperty(string propertyName)
    {
        return propertyName.StartsWith("@") || propertyName.Equals("$");
    }

    private static string transformPropertyName(JProperty property)
    {
        if (property.Name.StartsWith("@"))
        {
            return property.Name.Substring(1);
        }
        else if (property.Name.Equals("$"))
        {
            return "Value";
        }
        else
        {
            return property.Name;
        }
    }

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

如果我想在这上面花更多的时间，肯定会写得更有效率，但我根本不需要这样的速度来完成我的项目。
它当前使用的 ReadJson方法将json转换为 JObject.Load(reader)方法，就像使用默认实现一样。
然后，我在该对象的图形上递归，收集要重命名的属性的路径。这是因为我无法在枚举期间重命名它们，因为这将修改正在迭代的集合，这显然是出于某些原因而不允许的。
收集路径后，我迭代路径，重命名这些特定属性。此过程首先删除旧属性，然后使用新名称添加新属性。
对于那些如此倾向于此的人来说，一个更加精明和高效的实现将在构建 JObject的反序列化阶段完成所有这一切，在从读卡器读取属性时重命名属性。
使用
用法简单，如下：

var jsonSettings = new JsonSerializerSettings();
jsonSettings.Converters.Add(new BadgerFishJsonConverter());

var obj = JsonConvert.DeserializeObject<SalesRevenueAmounts>(json, jsonSettings); 

给出了以下两种模型：

public class SalesRevenueAmount
{
    public string CurrencyISOAlpha3Code { get; set; }
    public string Value { get; set; }
}

public class SalesRevenueAmounts
{
    public IEnumerable<SalesRevenueAmount> SalesRevenueAmount { get; set; }
}

其他参考文献
作为我解决方案的一部分，我利用了来自用户的 this Rename extension来整理代码。我添加了通过简单地将参数更改为 JsonReader来传递名称提供程序函数的功能，这样我就可以控制如何创建提供程序名称。
全面实施，如下：

public static class Extensions
{
    public static void Rename(this JToken token, string newName)
    {
        token.Rename(prop => newName);
    }

    public static void Rename(this JToken token, Func<JProperty, string> nameProvider)
    {
        if (token == null)
            throw new ArgumentNullException("token", "Cannot rename a null token");

        JProperty property;

        if (token.Type == JTokenType.Property)
        {
            if (token.Parent == null)
                throw new InvalidOperationException("Cannot rename a property with no parent");

            property = (JProperty)token;
        }
        else
        {
            if (token.Parent == null || token.Parent.Type != JTokenType.Property)
                throw new InvalidOperationException("This token's parent is not a JProperty; cannot rename");

            property = (JProperty)token.Parent;
        }

        var newName = nameProvider.Invoke(property);
        var newProperty = new JProperty(newName, property.Value);
        property.Replace(newProperty);
    }
}

希望这有助于在将来为某人节省时间。