Spring Boot启动时自动调用RESTful POST接口发送JSON文件的实现方法

最可靠的方案是利用Spring Boot提供的ApplicationRunner或CommandLineRunner接口，这两个接口会在Spring上下文完全初始化完成后执行代码，确保所有依赖的Bean都已就绪。以下是具体实现步骤：

方案一：使用RestTemplate（同步请求） #

1. 配置RestTemplate Bean #

首先创建RestTemplate实例，作为发送HTTP请求的工具：

@Configuration
public class RestConfig {
    @Bean
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }
}

2. 实现ApplicationRunner执行启动任务 #

创建组件类实现ApplicationRunner接口，在run方法中完成读取JSON文件、发送POST请求的逻辑：

@Component
public class StartupPostTask implements ApplicationRunner {

    private final RestTemplate restTemplate;
    private final ResourceLoader resourceLoader;
    
    // 注入依赖，避免硬编码实例化
    public StartupPostTask(RestTemplate restTemplate, ResourceLoader resourceLoader) {
        this.restTemplate = restTemplate;
        this.resourceLoader = resourceLoader;
    }

    @Override
    public void run(ApplicationArguments args) throws Exception {
        // 目标API地址（建议放到application.properties配置）
        String targetApi = "https://your-api-endpoint.com/receive-json";
        // JSON文件路径（示例为classpath下的data.json）
        Resource jsonResource = resourceLoader.getResource("classpath:data.json");
        String jsonContent = Files.readString(Paths.get(jsonResource.getURI()));

        // 构造请求头，指定Content-Type为JSON
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_JSON);
        HttpEntity<String> requestEntity = new HttpEntity<>(jsonContent, headers);

        try {
            // 发送POST请求并获取响应
            ResponseEntity<String> response = restTemplate.postForEntity(targetApi, requestEntity, String.class);
            System.out.println("POST请求发送成功，响应状态码：" + response.getStatusCode());
        } catch (Exception e) {
            // 捕获异常，避免请求失败导致应用启动中断
            System.err.println("发送POST请求失败：" + e.getMessage());
            e.printStackTrace();
        }
    }
}

方案二：使用WebClient（异步请求，适用于WebFlux项目） #

如果项目基于Spring WebFlux，可使用WebClient实现异步请求，不会阻塞应用启动流程：

1. 配置WebClient Bean #

@Configuration
public class WebClientConfig {
    @Bean
    public WebClient webClient() {
        return WebClient.create();
    }
}

2. 实现ApplicationRunner执行异步任务 #

@Component
public class StartupPostTask implements ApplicationRunner {

    private final WebClient webClient;
    private final ResourceLoader resourceLoader;

    public StartupPostTask(WebClient webClient, ResourceLoader resourceLoader) {
        this.webClient = webClient;
        this.resourceLoader = resourceLoader;
    }

    @Override
    public void run(ApplicationArguments args) throws Exception {
        String targetApi = "https://your-api-endpoint.com/receive-json";
        Resource jsonResource = resourceLoader.getResource("classpath:data.json");
        String jsonContent = Files.readString(Paths.get(jsonResource.getURI()));

        // 异步发送POST请求
        webClient.post()
                .uri(targetApi)
                .contentType(MediaType.APPLICATION_JSON)
                .bodyValue(jsonContent)
                .retrieve()
                .bodyToMono(String.class)
                .subscribe(
                        response -> System.out.println("请求成功，响应内容：" + response),
                        error -> System.err.println("请求失败：" + error.getMessage())
                );
    }
}

关键注意事项 #

• 避免使用@PostConstruct：该注解在Bean初始化阶段执行，此时Spring上下文尚未完全加载，可能导致依赖的Bean（如RestTemplate）未就绪，引发异常。
• 配置化优化：建议把API地址、JSON文件路径放到application.properties中，通过@Value注入，方便后续修改：

  app.target-api=https://your-api-endpoint.com/receive-json
  app.json-path=classpath:data.json
  

  然后在类中注入：

  @Value("${app.target-api}")
  private String targetApi;
  
  @Value("${app.json-path}")
  private String jsonPath;
  

• 异常处理：必须捕获请求过程中的异常，否则一旦请求失败，会导致整个应用启动失败（同步请求场景）。根据业务需求，可选择记录日志、重试等处理逻辑。

内容的提问来源于stack exchange，提问作者V.T