当前位置：首页 > news >正文

Spring RestTemplate修仙指南：从HTTP萌新到请求大能的终极奥义

news 来源：原创 2025/6/23 3:04:13

各位在Spring生态摸爬滚打的道友们！今天要解锁的是Spring官方御用HTTP法宝——RestTemplate！这货堪称Java界的"御剑飞行术"，虽然官方已推荐WebClient接棒，但江湖上仍有80%项目在用这员老将！准备好一键起飞了吗？ 🚀

一、筑基篇：初识RestTemplate

1.1 召唤法宝（创建实例）

// 简单召唤（无配置版）
RestTemplate restTemplate = new RestTemplate();

// 注入灵力版（推荐Spring Bean方式）
@Bean 
public RestTemplate restTemplate() {
    return new RestTemplate();
}

1.2 基础GET请求（探查敌情）

String url = "https://api.example.com/users/1";
// 方式1：直接获取字符串
String response = restTemplate.getForObject(url, String.class);

// 方式2：获取完整响应（含状态码/头信息）
ResponseEntity<String> entity = restTemplate.getForEntity(url, String.class);
System.out.println("状态码：" + entity.getStatusCode());
System.out.println("响应体：" + entity.getBody());

二、金丹篇：高级请求术

2.1 POST请求（传送灵力）

// 准备请求体（自动序列化为JSON）
User user = new User("张无忌", 25);
ResponseEntity<User> response = restTemplate.postForEntity(
    "https://api.example.com/users",
    user,  // 请求体对象
    User.class  // 响应类型
);

// 获取创建成功的用户ID（假设返回完整用户对象）
User createdUser = response.getBody();
System.out.println("新用户ID：" + createdUser.getId());

2.2 自定义请求头（伪装大法）

// 方式1：使用HttpHeaders
HttpHeaders headers = new HttpHeaders();
headers.set("Authorization", "Bearer your_token");
headers.setContentType(MediaType.APPLICATION_JSON);

HttpEntity<User> requestEntity = new HttpEntity<>(user, headers);
ResponseEntity<User> response = restTemplate.exchange(
    url, 
    HttpMethod.POST, 
    requestEntity, 
    User.class
);

// 方式2：使用拦截器（全局生效）
@Bean
public RestTemplate restTemplate() {
    RestTemplate restTemplate = new RestTemplate();
    restTemplate.getInterceptors().add((request, body, execution) -> {
        request.getHeaders().add("X-App-Version", "1.0.0");
        return execution.execute(request, body);
    });
    return restTemplate;
}

三、元婴篇：异常处理

3.1 统一错误处理（渡劫护盾）

try {
    ResponseEntity<User> response = restTemplate.getForEntity(url, User.class);
} catch (HttpClientErrorException e) {
    // 4xx错误处理
    System.err.println("客户端异常：" + e.getStatusCode() + ", " + e.getResponseBodyAsString());
} catch (HttpServerErrorException e) {
    // 5xx错误处理
    System.err.println("服务端异常：" + e.getStatusCode());
} catch (RestClientException e) {
    // 其他网络异常
    System.err.println("网络异常：" + e.getMessage());
}

3.2 自定义ResponseErrorHandler

@Bean
public RestTemplate restTemplate() {
    RestTemplate restTemplate = new RestTemplate();
    restTemplate.setErrorHandler(new DefaultResponseErrorHandler() {
        @Override
        public void handleError(ClientHttpResponse response) throws IOException {
            if (response.getStatusCode() == HttpStatus.NOT_FOUND) {
                throw new CustomNotFoundException("资源不存在");
            }
            // 其他异常处理...
        }
    });
    return restTemplate;
}

四、化神篇：性能优化

4.1 连接池配置（灵气循环）

@Bean
public RestTemplate restTemplate() {
    // 使用HttpComponentsClientHttpRequestFactory（需httpclient依赖）
    HttpComponentsClientHttpRequestFactory factory = new HttpComponentsClientHttpRequestFactory();
    
    // 连接池配置
    PoolingHttpClientConnectionManager connectionManager = new PoolingHttpClientConnectionManager();
    connectionManager.setMaxTotal(200); // 最大连接数
    connectionManager.setDefaultMaxPerRoute(50); // 单路由最大连接
    
    CloseableHttpClient httpClient = HttpClients.custom()
            .setConnectionManager(connectionManager)
            .build();
    
    factory.setHttpClient(httpClient);
    factory.setConnectTimeout(5000); // 连接超时
    factory.setReadTimeout(30000);   // 读取超时
    
    return new RestTemplate(factory);
}

4.2 启用GZIP压缩（缩地成寸）

@Bean
public RestTemplate restTemplate() {
    RestTemplate restTemplate = new RestTemplate();
    restTemplate.getMessageConverters()
        .add(0, new GzipHttpMessageConverter()); // 自定义GZIP转换器
    return restTemplate;
}

五、大乘篇：实战技巧

5.1 文件上传（乾坤大挪移）

MultiValueMap<String, Object> parts = new LinkedMultiValueMap<>();
parts.add("file", new FileSystemResource("avatar.jpg"));
parts.add("metadata", new User("张无忌", 25)); // 同时传文件和JSON

HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.MULTIPART_FORM_DATA);

ResponseEntity<String> response = restTemplate.exchange(
    uploadUrl,
    HttpMethod.POST,
    new HttpEntity<>(parts, headers),
    String.class
);

5.2 文件下载（隔空取物）

ResponseEntity<Resource> response = restTemplate.exchange(
    downloadUrl,
    HttpMethod.GET,
    null,
    Resource.class
);

try (InputStream is = response.getBody().getInputStream()) {
    Files.copy(is, Paths.get("downloaded_file.zip"));
}