php发展

首页 » 常识 » 预防 » api接口返回动态的json格式我太难了
TUhjnbcbe - 2021/1/20 11:04:00
一:背景1.讲故事

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

{"Code":,"Items":[{"OrderTitle":"订单1"}]}{"Code":,"Items":[{"ProductTitle":"商品1"}]}

逻辑是这样的:Items中的内容会随的Code的改变而改变,里面有可能是订单列表又有可能是商品列表,习惯弱类型的朋友看这种json太正常不过了,但对于强类型的我们来说,简直就是一个大写的奇葩,你这让我用什么强类型反序列化呢???,如果还没理解,请看下面的这张图吧!

经过沟通,对方果然用的是弱类型的php,磨了半天,说服让对方改了返回结构,这样就可以直接用固有类匹配。

二:寻找解决办法

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

1.使用dynamic

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

从图中看:rsp.ItemsasListOrderItem返回是null,尝试失败,虽然转化失败了,但我相信你也看到了Newtonsoft.Json.Linq.JArray,貌似这玩意可以用linq操控,对的,这就是linqtojson。

2.使用linqtojson

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

staticvoidMain(string[]args){varjson="{\"Code\":,\"Items\":[{\"OrderTitle\":\"订单1\"}]}";varrsp=JsonConvert.DeserializeObjectApiResponse(json);if(rsp.Code==){varitems=(rsp.ItemsasJArray).Select(m=m["OrderTitle"].Valuestring()).ToList();Console.WriteLine(string.Join(",",items));}if(rsp.Code==){//todo....}}

从代码中可以看到,我是通过code的不同做了不同的业务逻辑处理,貌似问题通过这种半自动化的model实现了,但拥有强大好奇心的你,岂能不往下挖?

三:linqtojson分析1.好处

我觉得linqtojson的最大好处就是绕过了强类型限制,可以像弱类型语言一样处理生成和读取json,给了我们在业务处理上更多的选择余地,接下来我就在Create和Query上给大家抛砖引玉吧。

2.生成json

在没有强类型的情况下,如何构建json结构呢?对了,不知道大家对linqtoxml还有熟悉的吗?还记得它是怎么一步一步构建的哈,如果你记得的话,这里也是差不多的构建方式,比如说刚才的JArray。

JObjectjson=newJObject(newJProperty("Code",),newJProperty("Items",newJArray(newJObject(){newJProperty("OrderTitle","订单1"),newJProperty("Created",DateTime.Now)})));Console.WriteLine(json.ToString());

从图中看这种手工构建json的方式还是比较繁琐的,走的就是linqtoxml的路子,有没有更简单的方式呢?我觉得这里你可以用C#中的一个语法糖:匿名类型,虽然从IL上看也是强类型,但在用在这里太合适了,接下来我来改造一下:

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

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

2.解析json

为了让结果更可观,我准备生成一个稍微复杂一点的json,然后通过linqtojson和jsonpath两种方式操控json。

{"store":{"book":[{"category":"reference","author":"NigelRees","title":"SayingsoftheCentury","price":8.95},{"category":"fiction","author":"EvelynWaugh","title":"SwordofHonour","price":12.99},{"category":"fiction","author":"HermanMelville","title":"MobyDick","isbn":"0---3","price":8.99},{"category":"fiction","author":"J.R.R.Tolkien","title":"TheLordoftheRings","isbn":"0--19-8","price":22.99}],"bicycle":{"color":"red","price":19.95}}}

对category进行分组,统计每个类别的总金额

staticvoidMain(string[]args){varjson=System.IO.File.ReadAllText("1.txt");JObjectobj=JObject.Parse(json);vardict=obj["store"]["book"].GroupBy(m=m["category"]).ToDictionary(k=k.Key,v=v.Select(n=n.Valuedecimal("price")).Sum());foreach(varkeyindict.Keys){Console.WriteLine($"key={key},value={dict[key]}");}}

哈哈,分组统计在强大的linq面前就是这么简单!

使用jsonpath处理

jsonpath就像xmlpath一样,非常强大,更多的功能可以参考这个网页:

1
查看完整版本: api接口返回动态的json格式我太难了