Spring Boot中使用RestTemplate优雅解析动态JSON响应-java教程-PHP中文网

spring boot中使用resttemplate优雅解析动态json响应

本教程详细介绍了如何在Spring Boot应用中，利用RestTemplate和Jackson库高效地解析来自外部REST API的复杂动态JSON响应。文章通过优化POJO模型，特别是使用`Map`结构来处理JSON中不确定键名的部分，并演示了如何将原始响应转换为更简洁的自定义数据结构，以适应前端展示需求，从而提升数据处理的灵活性和可维护性。

1. 理解复杂JSON响应结构

在与外部API交互时，我们经常会遇到结构复杂的JSON响应。本例中的JSON响应包含多个层次，并且在response.links部分具有动态的键名，例如"RCDSO - Production Environment Cost"等。

{
    "responseMessage": "SUCCESS",
    "status": "OK",
    "statusCode": 1,
    "response": {
        "links": {
            "RCDSO - Production Environment Cost": { "href": "href 1" },
            "RCDSO - Development & UAT Environment Cost": { "href": "href 2" },
            // ... 更多动态键值对 ...
        }
    }
}

登录后复制

最初的POJO设计为每个动态键名创建一个独立的类和字段，如RCDSOProductionEnvironmentCost。这种方法在键名固定且数量有限时可行，但当键名动态变化或数量众多时，会导致POJO代码冗余、难以维护，且不具备扩展性。为了优雅地处理这种动态结构，我们需要采用更灵活的POJO映射策略。

2. 设计灵活的POJO模型

为了有效地解析包含动态键名的JSON，Jackson库提供了强大的功能，其中最关键的是使用java.util.Map来映射动态部分。我们将构建一套POJO来精确反映JSON的层次结构，并利用Map来处理links部分的动态键。

首先，确保你的Spring Boot项目中包含了Jackson依赖，通常在spring-boot-starter-web中已默认包含：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</groupId>
</groupId>

登录后复制

接下来，定义我们的POJO类：

2.1 Link.java

这个类代表了links对象中每个报告项的值，它只包含一个href字段。

import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
public class Link {
    private String href;
}

登录后复制

2.2 ReportData.java

这个类代表了JSON中"response"字段的内容。关键在于，它使用Map来存储links部分，其中String是动态的报告名称，Link是对应的链接对象。

import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import java.util.Map;

@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
public class ReportData {
    private Map<String, Link> links;
}

登录后复制

2.3 FullApiResponse.java

这个类代表了整个JSON响应的顶层结构，包含了responseMessage、status、statusCode以及response对象。

import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
public class FullApiResponse {
    private String responseMessage;
    private String status;
    private int statusCode;
    private ReportData response; // 映射到JSON中的"response"对象
}

登录后复制

3. 使用RestTemplate调用API并自动映射

有了优化后的POJO模型，我们可以更新RestTemplate的调用逻辑。Spring Boot的RestTemplate在classpath中存在Jackson库时，会自动使用MappingJackson2HttpMessageConverter将JSON响应体转换为对应的POJO。

AI Surge Cloud

低代码数据分析平台，帮助企业快速交付深度数据

查看详情

以下是修改后的服务方法示例：

import org.springframework.http.*;
import org.springframework.stereotype.Service;
import org.springframework.web.client.RestTemplate;

import java.util.Collections; // 导入 Collections 类

@Service
public class ExternalApiService {

    // 假设apiKey从配置文件或环境变量中获取
    private final String apiKey = "YOUR_API_KEY"; 

    public FullApiResponse getReportListByClientId(String clientId) {
        // 创建RestTemplate实例，建议在Spring配置中注册为Bean以进行统一管理和配置
        // RestTemplate restTemplate = new RestTemplate(); 

        // 如果作为Bean注入，可以这样使用
        // @Autowired
        // private RestTemplate restTemplate;
        RestTemplate restTemplate = new RestTemplate(); 

        try {
            final String uri = "https://chapi.cloudhealthtech.com/olap_reports/custom?client_api_id=" + clientId;

            HttpHeaders headers = new HttpHeaders();
            headers.set(HttpHeaders.AUTHORIZATION, "Bearer " + apiKey);
            headers.set(HttpHeaders.ACCEPT, MediaType.APPLICATION_JSON_VALUE);
            // 如果需要发送一个空的请求体，可以传入null或""
            HttpEntity<String> requestEntity = new HttpEntity<>(headers);

            // 使用exchange方法发送GET请求，并指定响应体应映射到FullApiResponse.class
            ResponseEntity<FullApiResponse> responseEntity = 
                restTemplate.exchange(uri, HttpMethod.GET, requestEntity, FullApiResponse.class);

            // 返回映射后的POJO对象
            return responseEntity.getBody();   
        } catch (Exception e) {
            System.err.println("Error consuming external API: " + e.getMessage());
            e.printStackTrace();
            // 根据实际业务需求处理异常，例如抛出自定义异常或返回空对象
            return null; 
        }
    }
}

登录后复制

在上述代码中，restTemplate.exchange(uri, HttpMethod.GET, requestEntity, FullApiResponse.class)是核心。它指示RestTemplate在接收到JSON响应后，尝试将其反序列化为FullApiResponse类型的对象。由于FullApiResponse内部使用了Map来处理动态的links部分，Jackson会智能地将其解析为对应的Java Map。

4. 提取与转换数据

获取到FullApiResponse对象后，我们可以轻松地访问其中的数据，并根据需要进行进一步的加工和转换。例如，如果前端需要一个简单的报告项列表，我们可以将Map转换为List。

4.1 SimplifiedReportItem.java

这个自定义POJO用于表示前端所需的简化报告项。

import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
public class SimplifiedReportItem {
    private String reportName; // 报告名称，对应动态键
    private String href;       // 报告链接
}

登录后复制

4.2 数据提取与转换逻辑

在服务层或业务逻辑层，我们可以对获取到的FullApiResponse进行处理：

import java.util.ArrayList;
import java.util.List;
import java.util.Map;

// ... (其他导入)

@Service
public class ReportService {

    private final ExternalApiService externalApiService;

    public ReportService(ExternalApiService externalApiService) {
        this.externalApiService = externalApiService;
    }

    public List<SimplifiedReportItem> getSimplifiedReportItems(String clientId) {
        FullApiResponse apiResponse = externalApiService.getReportListByClientId(clientId);

        List<SimplifiedReportItem> simplifiedItems = new ArrayList<>();

        if (apiResponse != null && apiResponse.getResponse() != null && apiResponse.getResponse().getLinks() != null) {
            Map<String, Link> linksMap = apiResponse.getResponse().getLinks();

            for (Map.Entry<String, Link> entry : linksMap.entrySet()) {
                String reportName = entry.getKey();
                String href = entry.getValue().getHref();
                simplifiedItems.add(new SimplifiedReportItem(reportName, href));
            }
        }
        return simplifiedItems;
    }
}

登录后复制

现在，getSimplifiedReportItems方法返回了一个List，这个列表可以直接传递给前端（例如通过Spring MVC控制器返回给AJAX请求），以便在HTML表格中展示。

5. 注意事项

错误处理： 在实际应用中，try-catch块中的异常处理应更加细致。可以捕获HttpClientErrorException（如4xx错误）、HttpServerErrorException（如5xx错误）和ResourceAccessException（网络连接问题），并根据错误类型进行不同的业务逻辑处理或抛出自定义异常。

RestTemplate配置： 建议将RestTemplate配置为一个Spring Bean，以便进行统一管理和高级配置，例如设置连接超时、读取超时、拦截器（用于添加通用请求头、日志记录等）。

@Configuration
public class RestTemplateConfig {
    @Bean
    public RestTemplate restTemplate(RestTemplateBuilder builder) {
        return builder
                .setConnectTimeout(java.time.Duration.ofSeconds(5)) // 连接超时5秒
                .setReadTimeout(java.time.Duration.ofSeconds(10))   // 读取超时10秒
                // .additionalInterceptors(...) // 添加拦截器
                .build();
    }
}

登录后复制

API Key安全： API Key等敏感信息不应硬编码在代码中，应通过Spring Boot的配置文件（application.properties或application.yml）、环境变量或秘密管理服务（如Vault）进行管理。
Jackson依赖： 确保Jackson库的版本与Spring Boot兼容。如果遇到No converter found for class等错误，通常是Jackson配置或依赖问题。
POJO一致性： 确保POJO的字段名与JSON的键名严格匹配，或使用@JsonProperty("json_key_name")注解进行显式映射。