Spring Boot内部调用第三方API返回404问题排查与解决

可能的原因 #

• APIRoot格式不完整：如果APIRoot没有包含http://或https://前缀，RestTemplate会将其当作当前Spring Boot应用的相对路径发起请求，而非目标API地址，导致返回404。
• 未捕获RestTemplate调用异常：调用目标API时如果抛出异常（如连接失败、目标API返回错误状态码），未做捕获处理的话，Spring Boot默认的异常处理可能返回404（或其他错误状态）。
• 缺少目标API要求的请求头：直接用Postman调用时可能自动携带了目标API需要的请求头（如User-Agent、认证信息），但RestTemplate默认没有添加，导致目标API拒绝请求返回404。

解决步骤 #

1. 修正APIRoot格式 #

确保APIRoot是完整的URL，例如：

this.APIRoot = "http://target-api-host:8080/root-path";

2. 捕获异常并排查错误 #

修改callAPI方法，添加异常捕获，打印目标API返回的具体错误信息：

private String callAPI(String uri){
    RestTemplate restTemplate = new RestTemplate();
    try {
        return restTemplate.getForObject(uri, String.class);
    } catch (HttpClientErrorException | HttpServerErrorException e) {
        // 打印目标API返回的状态码和响应体
        System.err.println("API调用错误: 状态码=" + e.getStatusCode() + ", 响应体=" + e.getResponseBodyAsString());
        throw e;
    } catch (Exception e) {
        System.err.println("API调用失败: " + e.getMessage());
        throw e;
    }
}

通过控制台输出的错误信息，就能明确是目标API返回了错误，还是连接问题。

3. 添加必要的请求头 #

如果目标API需要特定请求头，使用HttpEntity携带请求头发起调用：

private String callAPI(String uri){
    RestTemplate restTemplate = new RestTemplate();
    HttpHeaders headers = new HttpHeaders();
    // 添加目标API需要的请求头，比如User-Agent
    headers.add("User-Agent", "Spring Boot RestTemplate");
    // 如果需要认证，添加Authorization头
    // headers.add("Authorization", "Bearer your-token");
    HttpEntity<String> entity = new HttpEntity<>(headers);
    
    try {
        return restTemplate.exchange(uri, HttpMethod.GET, entity, String.class).getBody();
    } catch (Exception e) {
        System.err.println("API调用失败: " + e.getMessage());
        throw e;
    }
}

4. 优化RestTemplate实例化 #

不要每次调用都新建RestTemplate，建议在配置类中把它注册为Bean，全局复用：

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

然后在控制器中注入使用：

@Autowired
private RestTemplate restTemplate;

private String callAPI(String uri){
    // 直接使用注入的restTemplate
    try {
        return restTemplate.getForObject(uri, String.class);
    } catch (Exception e) {
        System.err.println("API调用失败: " + e.getMessage());
        throw e;
    }
}

内容的提问来源于stack exchange，提问作者ArneVC