Java Spring Boot 中 Rest Client 反序列化文本 JSON 的终极指南

2024-03-12 01:13:02

使用 Rest Client 反序列化文本 JSON

问题

使用 Spring 的 Rest Client 时，你可能会遇到一个问题，即反序列化来自外部 REST API 的文本 JSON。文本 JSON 与传统的 JSON 不同，因为它以双引号开始，而不是大括号。这会导致反序列化错误，因为 Rest Client 期望一个 JSON 对象，而不是一个 JSON 字符串。

解决方法

要解决此问题，你必须告诉 Rest Client 将响应正文视为一个字符串，而不是一个 JSON 对象。以下是如何使用 Spring WebClient 完成此操作：

WebClient client = WebClient.create();
String response = client.post()
    .uri(url)
    .contentType(MediaType.APPLICATION_JSON)
    .bodyValue(request)
    .retrieve()
    .bodyToMono(String.class)
    .block();

通过使用 .bodyToMono(String.class) 用于 .retrieve() 方法，你可以将响应正文作为字符串获取。然后，你可以使用 JSON 解析库（如 Jackson 或 Gson）将字符串反序列化为对象。

以下是如何使用 Jackson 反序列化响应字符串：

ObjectMapper mapper = new ObjectMapper();
ApiResponse responseObject = mapper.readValue(response, ApiResponse.class);

如果你正在使用 Rest Template 而不是 WebClient，你可以执行以下操作：

RestTemplate restTemplate = new RestTemplate();
String response = restTemplate.postForObject(url, request, String.class);
ObjectMapper mapper = new ObjectMapper();
ApiResponse responseObject = mapper.readValue(response, ApiResponse.class);

原因

有人可能会故意将响应作为 JSON 字符串返回的原因有多个：

兼容性： JSON 字符串更具通用性，可以被各种语言和库解析。
安全性： JSON 字符串可以比 JSON 对象更安全，因为它可以防止注入攻击。
性能： JSON 字符串通常比 JSON 对象更小，因此传输起来更有效。
灵活性： JSON 字符串比 JSON 对象更灵活，因为它允许包含非 JSON 数据，如 HTML 或 XML。

常见问题解答

我如何知道响应是否是一个文本 JSON 字符串？
- 检查响应头的 Content-Type 字段。它应为 text/json 或类似内容。
为什么我的 Rest Client 仍然无法反序列化响应？
- 确保你的 JSON 解析库已正确配置。
- 检查你的代码是否存在语法错误。
如何提高 JSON 反序列化的性能？
- 考虑使用对象缓存来避免重复反序列化。
- 优化你的 JSON 解析库设置。
我应该使用哪种 JSON 解析库？
- Jackson 和 Gson 是两种流行的选项，它们都提供了良好的性能和功能。
还有其他方法可以反序列化文本 JSON 吗？
- 你可以使用正则表达式手动解析文本 JSON。
- 还有第三方库可用于此目的，例如 json-smart。