关于c#:api接口返回动态的json格式我太难了尝试一下-linq-to-json

40次阅读

共计 3029 个字符,预计需要花费 8 分钟才能阅读完成。

一:背景

1. 讲故事

前段时间和一家公司联调 api 接口的时候,发现一个奇葩的问题,它的 api 返回的 json 会动静扭转,简化如下:


{"Code":101,"Items":[{"OrderTitle":"订单 1"}]}

{"Code":102,"Items":[{"ProductTitle":"商品 1"}]}

逻辑是这样的:Items 中的内容会随的 Code 的扭转而扭转,外面有可能是订单列表又有可能是商品列表,习惯弱类型的敌人看这种 json 太失常不过了,但对于强类型的咱们来说,几乎就是一个大写的奇葩,你这让我用什么强类型反序列化呢???,如果还没了解,请看上面的这张图吧!

通过沟通,对方果然用的是弱类型的 php,磨了半天,压服让对方改了返回构造,这样就能够间接用固有类匹配。

二:寻找解决办法

从业务上来说,能压服对方退让那是最好的,但从技术上来说,这种场景有什么好的解决办法呢?问题的实质就是 json 是动静的,你反序列化的时候无奈指定匹配类。

1. 应用 dynamic

既然是动静的,那 C# 中也有一个动静类型 dynamic,何不用它来做 json 中动态变化的那局部的承受值,将 items 定义为 dynamic。如下图:

从图中看:rsp.Items as List<OrderItem> 返回是 null,尝试失败,尽管转化失败了,但我置信你也看到了 Newtonsoft.Json.Linq.JArray,貌似这玩意能够用 linq 操控,对的,这就是 linq to json

2. 应用 linq to json

有了 linq 根底,提取 JArray 中内容就不难了,接下来把代码改成如下:


        static void Main(string[] args)
        {var json = "{\"Code\":101,\"Items\":[{\"OrderTitle\":\" 订单 1\"}]}";

            var rsp = JsonConvert.DeserializeObject<ApiResponse>(json);

            if (rsp.Code == 101)
            {var items = (rsp.Items as JArray).Select(m => m["OrderTitle"].Value<string>()).ToList();

                Console.WriteLine(string.Join(",", items));
            }

            if (rsp.Code == 102)
            {//todo ....}
        }

从代码中能够看到,我是通过 code 的不同做了不同的业务逻辑解决,貌似问题通过这种半自动化的 model 实现了,但领有弱小好奇心的你,岂能不往下挖?

三:linq to json 剖析

1. 益处

我感觉 linq to json 的最大益处就是绕过了强类型限度,能够像弱类型语言一样解决生成和读取 json,给了咱们在业务解决上更多的抉择余地,接下来我就在 Create 和 Query 上给大家抛砖引玉吧。

2. 生成 json

在没有强类型的状况下,如何构建 json 构造呢?对了,不晓得大家对 linq to xml 还有相熟的吗?还记得它是怎么一步一步构建的哈,如果你记得的话,这里也是差不多的构建形式, 比如说方才的 JArray。


            JObject json = new JObject(new JProperty("Code", 101),
                                       new JProperty("Items", new JArray(new JObject()
                                       {new JProperty("OrderTitle","订单 1"),
                                           new JProperty("Created",DateTime.Now)
                                       }))
                                      );

            Console.WriteLine(json.ToString());

从图中看这种手工构建 json 的形式还是比拟繁琐的,走的就是 linq to xml 的路子,有没有更简略的形式呢?我感觉这里你能够用 C# 中的一个语法糖:匿名类型,尽管从 IL 上看也是强类型,但在用在这里太适合了,接下来我来革新一下:


            JObject json = JObject.FromObject(new
            {
                Code = 101,
                Items = (new[]
                {new { OrderTitle="订单 1",Created=DateTime.Now}
                }).ToList()});

            Console.WriteLine(json.ToString());

这样是不是太不便了,算是巧用 匿名类型 吧。

2. 解析 json

为了让后果更可观,我筹备生成一个略微简单一点的 json,而后通过 linq to jsonjsonpath 两种形式操控 json。


{
    "store":{
        "book":[
            {
                "category":"reference",
                "author":"Nigel Rees",
                "title":"Sayings of the Century",
                "price":8.95
            },
            {
                "category":"fiction",
                "author":"Evelyn Waugh",
                "title":"Sword of Honour",
                "price":12.99
            },
            {
                "category":"fiction",
                "author":"Herman Melville",
                "title":"Moby Dick",
                "isbn":"0-553-21311-3",
                "price":8.99
            },
            {
                "category":"fiction",
                "author":"J. R. R. Tolkien",
                "title":"The Lord of the Rings",
                "isbn":"0-395-19395-8",
                "price":22.99
            }
        ],
        "bicycle":{
            "color":"red",
            "price":19.95
        }
    }
}
  • 对 category 进行分组,统计每个类别的总金额

        static void Main(string[] args)
        {var json = System.IO.File.ReadAllText("1.txt");

            JObject obj = JObject.Parse(json);

            var dict = obj["store"]["book"].GroupBy(m => m["category"])
                                            .ToDictionary(k => k.Key,
                                                          v => v.Select(n => n.Value<decimal>("price")).Sum());

            foreach (var key in dict.Keys)
            {Console.WriteLine($"key={key},value={dict[key]}");
            }
        }

哈哈,分组统计在弱小的 linq 背后就是这么简略!

  • 应用 jsonpath 解决

jsonpath 就像 xmlpath 一样,十分弱小,更多的性能能够参考这个网页:https://goessner.net/articles…。

依据下面的语法,我尝试着提取所有的 price,应用 $..price 试试。


            var json = System.IO.File.ReadAllText("1.txt");

            JObject obj = JObject.Parse(json);

            var priceList= obj.SelectTokens("$..price");

            foreach (var price in priceList)
            {Console.WriteLine(price.Value<decimal>());
            }

四:总结

我置信大家在 90% 的状况都是用强类型作为 json 的 mapping,剩下的 10% 状况,能够理解下弱小的 linq to json 哈,太实用啦!心愿本篇对您有帮忙。

正文完
 0