一:背景

1. 讲故事

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


  1. {"Code":101,"Items":[{"OrderTitle":"订单1"}]}
  2. {"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中内容就不难了,接下来把代码改成如下:


  1. static void Main(string[] args)
  2. {
  3. var json = "{\"Code\":101,\"Items\":[{\"OrderTitle\":\"订单1\"}]}";
  4. var rsp = JsonConvert.DeserializeObject<ApiResponse>(json);
  5. if (rsp.Code == 101)
  6. {
  7. var items = (rsp.Items as JArray).Select(m => m["OrderTitle"].Value<string>()).ToList();
  8. Console.WriteLine(string.Join(",", items));
  9. }
  10. if (rsp.Code == 102)
  11. {
  12. //todo ....
  13. }
  14. }

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

三: linq to json 分析

1. 好处

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

2. 生成json

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


  1. JObject json = new JObject(
  2. new JProperty("Code", 101),
  3. new JProperty("Items", new JArray(new JObject()
  4. {
  5. new JProperty("OrderTitle","订单1"),
  6. new JProperty("Created",DateTime.Now)
  7. }))
  8. );
  9. Console.WriteLine(json.ToString());

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


  1. JObject json = JObject.FromObject(new
  2. {
  3. Code = 101,
  4. Items = (new[]
  5. {
  6. new { OrderTitle="订单1",Created=DateTime.Now }
  7. }).ToList()
  8. });
  9. Console.WriteLine(json.ToString());

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

2. 解析json

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


  1. {
  2. "store":{
  3. "book":[
  4. {
  5. "category":"reference",
  6. "author":"Nigel Rees",
  7. "title":"Sayings of the Century",
  8. "price":8.95
  9. },
  10. {
  11. "category":"fiction",
  12. "author":"Evelyn Waugh",
  13. "title":"Sword of Honour",
  14. "price":12.99
  15. },
  16. {
  17. "category":"fiction",
  18. "author":"Herman Melville",
  19. "title":"Moby Dick",
  20. "isbn":"0-553-21311-3",
  21. "price":8.99
  22. },
  23. {
  24. "category":"fiction",
  25. "author":"J. R. R. Tolkien",
  26. "title":"The Lord of the Rings",
  27. "isbn":"0-395-19395-8",
  28. "price":22.99
  29. }
  30. ],
  31. "bicycle":{
  32. "color":"red",
  33. "price":19.95
  34. }
  35. }
  36. }
  • 对 category 进行分组,统计每个类别的总金额

  1. static void Main(string[] args)
  2. {
  3. var json = System.IO.File.ReadAllText("1.txt");
  4. JObject obj = JObject.Parse(json);
  5. var dict = obj["store"]["book"].GroupBy(m => m["category"])
  6. .ToDictionary(k => k.Key,
  7. v => v.Select(n => n.Value<decimal>("price")).Sum());
  8. foreach (var key in dict.Keys)
  9. {
  10. Console.WriteLine($"key={key},value={dict[key]}");
  11. }
  12. }

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

  • 使用 jsonpath 处理

jsonpath 就像 xmlpath 一样,非常强大,更多的功能可以参考这个网页: https://goessner.net/articles/JsonPath/。

根据上面的语法,我尝试着提取所有的price,使用 $..price 试试。


  1. var json = System.IO.File.ReadAllText("1.txt");
  2. JObject obj = JObject.Parse(json);
  3. var priceList= obj.SelectTokens("$..price");
  4. foreach (var price in priceList)
  5. {
  6. Console.WriteLine(price.Value<decimal>());
  7. }

四: 总结

我相信大家在90%的情况都是用强类型作为json的mapping,剩下的10%情况,可以了解下强大的 linq to json哈,太实用啦! 希望本篇对您有帮助。

如您有更多问题与我互动,扫描下方进来吧~

api接口返回动态的json格式?我太难了,尝试一下 linq to json的更多相关文章

  1. API 接口返回值

    API 接口返回值 https://blog.csdn.net/baple/article/details/52925772

  2. Web Api 接口返回值不困惑:返回值类型详解

    前言:已经有一个月没写点什么了,感觉心里空落落的.今天再来篇干货,想要学习Webapi的园友们速速动起来,跟着博主一起来学习吧.之前分享过一篇 WebApi 接口参数:传参详解,这篇博文内容本身很基础 ...

  3. C#接收xmlrpc接口返回哈希表格式

    C#在调用xmlrpc接口时返回的是int值就可以直接获取,最近在调用一个接口是获取一个账号记录的详细信息,xmlrpc接口返回的是一个哈希值. 所以直接用int或者Hashtable 来获取返回值执 ...

  4. 从MongoDB里面取得json格式的数据,然后存为本地的json文件,然后再从json读取变为dict

    帮宣传下彩印网(www.caiyin.com) 有印刷,广告等等方面的需求就找这个网站吧,没错的. 天气预报在MongoDB中的天气预报的存储方式是: /* 1 */ { "_id" ...

  5. Json.net/Newtonsoft 3.0 新特性JObject/Linq to Json

    原文:http://www.cnblogs.com/chsword/archive/2008/09/19/Newtonsoft_new_3_0.html http://www.cnblogs.com/ ...

  6. json格式数据,将数据库中查询的结果转换为json, 然后调用接口的方式返回json(方式一)

    调用接口,无非也就是打开链接 读取流 将结果以流的形式输出 将查询结果以json返回,无非就是将查询到的结果转换成jsonObject ================================ ...

  7. spring boot:使接口返回统一的RESTful格式数据(spring boot 2.3.1)

    一,为什么要使用REST? 1,什么是REST? REST是软件架构的规范体系,它把资源的状态用URL进行资源定位, 以HTTP动作(GET/POST/DELETE/PUT)描述操作 2,REST的优 ...

  8. grails框架中读取txt文件内容将内容转换为json格式,出现异常Exception in thread "main" org.json.JSONException: A JSONObject text must begin with '{' at character 1 of [...]

    Exception in thread "main" org.json.JSONException: A JSONObject text must begin with '{' a ...

  9. Spring Boot API 统一返回格式封装

    今天给大家带来的是Spring Boot API 统一返回格式封装,我们在做项目的时候API 接口返回是需要统一格式的,只有这样前端的同学才可对接口返回的数据做统一处理,也可以使前后端分离 模式的开发 ...

随机推荐

  1. Django---drf第一天---作业

    1 图书的5个接口写完(使用序列化组件) urls.py from django.contrib import admin from django.urls import path, re_path ...

  2. REST,RPC和GraphQL应用场景,WebHooks、WebSocket、HTTP Streaming应用场景。

    一.请求--响应API. 请求--响应类的API的典型做法是,通过基于HTTP的Web服务器暴露一个/套接口.API定义一些端点,客户端发送数据的请求到这些端点,Web服务器处理这些请求,然后返回响应 ...

  3. alert(1) to win Part Ⅰ

    alert(1) to win Adobe: function escape(s) { s = s.replace(/"/g, '\\"'); return '<script ...

  4. mongodb(二):数据库安装,部署(linux)

    1.下载安装包 wget http://fastdl.mongodb.org/linux/mongodb-linux-i686-1.8.2.tgz 下载完成后解压缩压缩包 tar zxf mongod ...

  5. Python面向对象03 /继承

    Python面向对象03 /继承 目录 Python面向对象03 /继承 1. 初识继承 2. 单继承 3. 多继承 4. 总结 1. 初识继承 概念:专业角度:如果B类继承A类,B类就称为子类,派生 ...

  6. Docker搭建部署Node项目

    前段时间做了个node全栈项目,服务端技术栈是 nginx + koa + postgresql.其中在centos上搭建环境和部署都挺费周折,部署测试服务器,接着上线的时候又部署生产环境服务器.这中 ...

  7. 循序渐进VUE+Element 前端应用开发(17)--- 菜单资源管理

    在权限管理系统中,菜单也属于权限控制的一个资源,应该直接应用于角色,和权限功能点一样,属于角色控制的一环.不同角色用户,登录系统后,出现的系统菜单是不同的.在VUE+Element 前端中,我们菜单结 ...

  8. Getting Started with Recovery Manager (RMAN) (文档 ID 360416.1)

    In this Document Purpose Scope Details Overview of the RMAN EnvironmentDeciding Whether to Use a Fla ...

  9. reCAPTCHA无法加载?一个小工具就可以轻松解决!

    Chrome用户可以在应用商店搜索gooreplacer安装,或者点我下载,然后打开chrome://extensions/,将下载的crx文件拖入浏览器窗口,即可完成安装 Firefox用户可以在  ...

  10. JAVA集合一:ArrayList和LinkedList

    JAVA集合一:ArrayList和LinkedList 参考链接: HOW2J.CN 前言 这几篇博客重点记录JAVA的几个重要的集合框架:ArrayList.LinkedList.HashMap. ...