处理REST API动态响应:基于JSON结构动态解析不同数据类型

admin 百科 15

处理REST API动态响应:基于JSON结构动态解析不同数据类型

处理REST API动态响应:基于JSON结构动态解析不同数据类型-第2张图片-佛山资讯网

当rest api在同一http状态码下返回多种不同的json响应结构时,直接使用`resttemplate`结合`object.class`和`instanceof`进行类型判断是无效的。本文将介绍一种健壮的方法,通过将api响应获取为字符串,并利用jackson `objectmapper`的`jsonnode`进行初步结构判断,然后根据判断结果将响应反序列化为对应的java对象,从而有效处理这种动态响应场景。

1. 问题背景与挑战

在与第三方API集成时,我们有时会遇到这样的场景:API在成功(例如HTTP 200 OK)的情况下,根据业务逻辑的不同,返回两种或多种截然不同的JSON响应结构。例如,一个请求可能在有数据时返回一个记录列表,而在无数据或发生特定业务错误时,仍然返回200 OK,但其响应体却是一个包含错误信息的对象。

在这种情况下,如果直接使用RestTemplate的exchange方法并将响应类型指定为Object.class,然后尝试通过instanceof操作符来判断response.getBody()的具体类型(例如ZohoError或List),会发现这种判断总是失败的。其根本原因在于,当RestTemplate接收到JSON响应并将其反序列化为Object时,通常会将其解析为Java的通用类型,如LinkedHashMap(表示JSON对象)或ArrayList(表示JSON数组),而不是我们期望的自定义DTO类(如ZohoError)。因此,instanceof ZohoError或instanceof List(即使是ArrayList)都可能无法按照预期工作,导致业务逻辑分支判断错误。

2. 解决方案:基于字符串的JSON结构动态解析

为了准确识别并处理这种动态响应,我们需要一种更灵活的方法:将API响应作为原始字符串获取,然后利用JSON处理库(如Jackson)进行结构化分析和条件反序列化。

2.1 核心思路

  1. 获取原始响应字符串: 不直接让RestTemplate尝试反序列化为特定对象,而是将其响应体获取为String类型。
  2. 初步解析为JsonNode: 使用ObjectMapper将响应字符串解析为一个通用的JsonNode。JsonNode是Jackson库中表示JSON结构的基本单元,它可以是对象、数组、字符串、数字、布尔值或null。
  3. 判断JSON结构: 通过检查JsonNode的类型(是对象还是数组)以及其中是否存在特定的关键字段(例如错误消息字段),来判断当前的JSON响应属于哪种预期的结构。
  4. 条件反序列化: 根据判断结果,使用ObjectMapper将原始响应字符串反序列化为对应的Java DTO对象(例如ZohoError或List)。

2.2 示例代码实现

假设我们有以下两个DTO类用于表示可能的响应结构:

标签: java js json node app rest api 状态码 json处理 api调用 string类 字符串解

发布评论 0条评论)

还木有评论哦,快来抢沙发吧~