
当rest api在同一http状态码下返回多种不同的json响应结构时,直接使用`resttemplate`结合`object.class`和`instanceof`进行类型判断是无效的。本文将介绍一种健壮的方法,通过将api响应获取为字符串,并利用jackson `objectmapper`的`jsonnode`进行初步结构判断,然后根据判断结果将响应反序列化为对应的java对象,从而有效处理这种动态响应场景。
在与第三方API集成时,我们有时会遇到这样的场景:API在成功(例如HTTP 200 OK)的情况下,根据业务逻辑的不同,返回两种或多种截然不同的JSON响应结构。例如,一个请求可能在有数据时返回一个记录列表,而在无数据或发生特定业务错误时,仍然返回200 OK,但其响应体却是一个包含错误信息的对象。
在这种情况下,如果直接使用RestTemplate的exchange方法并将响应类型指定为Object.class,然后尝试通过instanceof操作符来判断response.getBody()的具体类型(例如ZohoError或List
为了准确识别并处理这种动态响应,我们需要一种更灵活的方法:将API响应作为原始字符串获取,然后利用JSON处理库(如Jackson)进行结构化分析和条件反序列化。
假设我们有以下两个DTO类用于表示可能的响应结构:
import com.fasterxml.jackson.annotation.JsonAlias;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
// 错误响应DTO
@Getter
@Setter
@ToString
@EqualsAndHashCode
public class ZohoError {
private String message;
@JsonAlias("errorcode")
private String errorCode;
@JsonAlias("Response status")
private int responseStatus;
}
// 成功响应中的单个记录DTO
@Getter
@Setter
@ToString
@EqualsAndHashCode
public class Leave {
private String id;
private String employeeName;
private String leaveType;
// ... 其他字段
}现在,我们修改原有的API调用逻辑,使用Jackson ObjectMapper进行动态解析:
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.core.type.TypeReference;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Service;
import org.springframework.web.client.RestTemplate;
import java.util.Collections;
import java.util.List;
@Service
public class ThirdPartyApiService {
private final RestTemplate restTemplate;
private final ObjectMapper objectMapper; // 注入或创建ObjectMapper实例
public ThirdPartyApiService(RestTemplate restTemplate, ObjectMapper objectMapper) {
this.restTemplate = restTemplate;
this.objectMapper = objectMapper;
}
public List<Leave> getLeaveRecords(String uri) {
HttpHeaders httpHeaders = new HttpHeaders();
// ... 添加必要的HTTP头
HttpEntity<Void> request = new HttpEntity<>(httpHeaders);
// 1. 获取原始响应字符串
ResponseEntity<String> response = restTemplate.exchange(uri, HttpMethod.GET, request, String.class);
String responseBody = response.getBody();
if (responseBody == null || responseBody.isEmpty()) {
return Collections.emptyList();
}
try {
// 2. 将响应字符串解析为JsonNode
JsonNode rootNode = objectMapper.readTree(responseBody);
// 3. 判断JSON结构:
// 假设错误响应总是包含 "errorCode" 字段,而成功列表响应是一个JSON数组。
// 这是一个基于业务规则的判断,需要根据实际API响应结构来确定。
if (rootNode.has("errorCode") || rootNode.has("message") && rootNode.has("Response status")) {
// 看起来是错误响应
ZohoError zohoError = objectMapper.readValue(responseBody, ZohoError.class);
System.err.println("API返回错误: " + zohoError.getMessage() + " (Code: " + zohoError.getErrorCode() + ")");
return Collections.emptyList(); // 或者抛出自定义异常
} else if (rootNode.isArray()) {
// 看起来是列表响应
// 使用TypeReference来处理泛型列表的反序列化
return objectMapper.readValue(responseBody, new TypeReference<List<Leave>>() {});
} else {
// 未知响应结构,可能是单个对象而不是列表,或者其他意外情况
System.err.println("API返回未知结构: " + responseBody);
return Collections.emptyList();
}
} catch (Exception e) {
System.err.println("解析API响应失败: " + e.getMessage());
// 记录日志,并根据业务需求处理异常
return Collections.emptyList();
}
}
}当面对REST API在同一HTTP状态码下返回多种JSON结构时,直接依赖RestTemplate的自动类型推断和instanceof是不可靠的。通过将API响应获取为原始字符串,并结合Jackson ObjectMapper的JsonNode进行灵活的结构判断和条件反序列化,我们可以构建出更加健壮和适应性强的客户端代码。这种方法虽然增加了代码量,但显著提升了对复杂API响应的处理能力和程序的稳定性。
以上就是处理REST API动态响应:基于JSON结构动态解析不同数据类型的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号