重学SpringBoot3-RestTemplate配置与使用详解

更多SpringBoot3内容请关注我的专栏：《SpringBoot3》
期待您的点赞👍收藏⭐评论✍

重学SpringBoot3-RestTemplate配置与使用详解

• 1. 简介
• 2. 环境要求
• 3. 基础配置
  • 3.1 添加依赖
  • 3.2 RestTemplate配置类
• 4. 高级配置
  • 4.1 自定义连接池配置
  • 4.2 错误处理配置
• 5. 使用示例
  • 5.1 RestTemplate方法列表
  • 5.2 基本使用
  • 5.3 使用请求头
  • 5.4 处理复杂响应
  • 5.5 打印日志拦截器
• 6. 最佳实践
• 7. 注意事项
• 8. 总结
• 参考资料

1. 简介

RestTemplate 是 Spring 框架提供的一个用于发送 HTTP 请求的同步客户端工具类。在 SpringBoot 3.x 版本中，我们依然可以使用 RestTemplate 来进行 REST API 的调用。本文将详细介绍如何在 SpringBoot 3 项目中配置和使用 RestTemplate。

2. 环境要求

• JDK 17+
• Spring Boot 3.x
• Maven/Gradle

3. 基础配置

3.1 添加依赖

首先在pom.xml中添加相关依赖：

<parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>3.2.5</version></parent><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency></dependencies>

3.2 RestTemplate配置类

创建一个配置类来注册RestTemplate Bean：

packagecom.coderjia.springboot304web.config;importorg.springframework.boot.web.client.RestTemplateBuilder;importorg.springframework.context.annotation.Bean;importorg.springframework.context.annotation.Configuration;importorg.springframework.web.client.RestTemplate;importjava.time.Duration;/** * @author CoderJia * @create 2024/12/1 下午 04:24 * @Description **/@ConfigurationpublicclassRestTemplateConfig{@BeanpublicRestTemplaterestTemplate(RestTemplateBuilder builder){return builder .setConnectTimeout(Duration.ofSeconds(5)).setReadTimeout(Duration.ofSeconds(5)).build();}}

4. 高级配置

4.1 自定义连接池配置

为了提高性能，我们可以使用 Apache HttpClient 连接池：

<dependency><groupId>org.apache.httpcomponents.client5</groupId><artifactId>httpclient5</artifactId><version>5.2.1</version></dependency>

配置连接池：

@ConfigurationpublicclassRestTemplateConfig{@BeanpublicRestTemplaterestTemplate(){PoolingHttpClientConnectionManager connectionManager =newPoolingHttpClientConnectionManager(); connectionManager.setMaxTotal(200);// 最大连接数为 200 connectionManager.setDefaultMaxPerRoute(20);// 每个路由的最大连接数为 20CloseableHttpClient httpClient =HttpClients.custom()// 建 HTTP 客户端.setConnectionManager(connectionManager).build();// 创建请求工HttpComponentsClientHttpRequestFactory factory =newHttpComponentsClientHttpRequestFactory(httpClient);// 返回 RestTemplatereturnnewRestTemplate(factory);}}

4.2 错误处理配置

自定义错误处理器：

publicclassCustomResponseErrorHandlerimplementsResponseErrorHandler{@OverridepublicbooleanhasError(ClientHttpResponse response)throwsIOException{return response.getStatusCode().is4xxClientError()|| response.getStatusCode().is5xxServerError();}@OverridepublicvoidhandleError(ClientHttpResponse response)throwsIOException{if(response.getStatusCode().is5xxServerError()){thrownewRuntimeException("服务器错误: "+ response.getStatusCode());}elseif(response.getStatusCode().is4xxClientError()){thrownewRuntimeException("客户端错误: "+ response.getStatusCode());}}}

将错误处理器添加到 RestTemplate：

@BeanpublicRestTemplaterestTemplate(RestTemplateBuilder builder){return builder .errorHandler(newCustomResponseErrorHandler()).build();}

5. 使用示例

5.1 RestTemplate方法列表

这个表格展示了 RestTemplate 提供的所有主要方法，每个方法都有其特定的用途和场景。从简单的GET请求到复杂的自定义请求处理，RestTemplate 都提供了相应的支持。

5.2 基本使用

@Slf4j@RestControllerpublicclassRestTemplateController{@ResourceprivateRestTemplate restTemplate;// get@GetMapping("/get")publicJSONObjectget(@RequestParam("q1")String q1,@RequestParam("q2")String q2){ log.info("get");String url ="https://echo.apifox.com/get";return restTemplate.getForObject(url,JSONObject.class, q1, q2);}// post@GetMapping("/post")publicJSONObjectpost(@RequestParam("q1")String q1,@RequestParam("q2")String q2){ log.info("post");String url ="https://echo.apifox.com/post";JSONObject body =newJSONObject(); body.put("q1", q1); body.put("q2", q2);return restTemplate.postForObject(url, body,JSONObject.class);}// delete@GetMapping("/delete")publicStringdelete(@RequestParam("id")Long id){ log.info("delete");String url ="https://echo.apifox.com/delete"; restTemplate.delete(url, id);return"Data deleted successfully!";}// put@GetMapping("/put")publicStringput(@RequestParam("id")Long id,@RequestParam("name")String name){ log.info("put");String url ="https://echo.apifox.com/put";JSONObject body =newJSONObject(); body.put("id", id); body.put("name", name); restTemplate.put(url, body, id);return"Data updated successfully!";}}

请求响应

5.3 使用请求头

publicUsergetUserWithHeaders(Long id){String url ="http://api.example.com/users/{id}";HttpHeaders headers =newHttpHeaders(); headers.set("Authorization","Bearer token123"); headers.setContentType(MediaType.APPLICATION_JSON);HttpEntity<String> entity =newHttpEntity<>(headers);ResponseEntity<User> response = restTemplate.exchange( url,HttpMethod.GET, entity,User.class, id );return response.getBody();}

5.4 处理复杂响应

@GetMapping("/getAnyThing")publicJSONObjectgetList(@RequestParam("q1")String q1,@RequestParam("q2")String q2){ log.info("getAnyThing");String url ="https://echo.apifox.com/post";JSONObject jsonObject =newJSONObject(); jsonObject.put("q1", q1); jsonObject.put("q2", q2);HttpEntity<JSONObject> entity =newHttpEntity<>(jsonObject);// 定义了一个泛型类型的引用 typeRef，用于指定 restTemplate.exchange 方法返回的响应体类型为 JSONObject。ParameterizedTypeReference<JSONObject> typeRef =newParameterizedTypeReference<>(){};ResponseEntity<JSONObject> response = restTemplate.exchange( url,HttpMethod.POST, entity, typeRef );return response.getBody();}

5.5 打印日志拦截器

packagecom.coderjia.springboot304web.config;importlombok.extern.slf4j.Slf4j;importorg.springframework.http.HttpRequest;importorg.springframework.http.client.ClientHttpRequestExecution;importorg.springframework.http.client.ClientHttpRequestInterceptor;importorg.springframework.http.client.ClientHttpResponse;importjava.io.IOException;/** * @author CoderJia * @create 2024/12/1 下午 05:02 * @Description **/@Slf4jpublicclassLoggingInterceptorimplementsClientHttpRequestInterceptor{@OverridepublicClientHttpResponseintercept(HttpRequest request,byte[] body,ClientHttpRequestExecution execution)throwsIOException{ log.info("Request: "+ request.getMethod()+" "+ request.getURI());ClientHttpResponse response = execution.execute(request, body); log.info("Response: "+ response.getStatusCode());return response;}}

RestTemplate设置拦截器：

List<ClientHttpRequestInterceptor> interceptors =newArrayList<>(); interceptors.add(newLoggingInterceptor());RestTemplate build = builder .errorHandler(newCustomResponseErrorHandler()).build(); build.setInterceptors(interceptors);

6. 最佳实践

1. 超时设置：始终设置合适的连接超时和读取超时时间。
2. 错误处理：实现自定义的错误处理器来处理异常情况。
3. 连接池：在高并发场景下使用连接池来提升性能。
4. 重试机制：对于不稳定的服务，考虑添加重试机制。
5. 日志记录：添加适当的日志记录来跟踪请求和响应。

7. 注意事项

1. RestTemplate 在 Spring 5.0 之后被标记为维护模式，建议在新项目中考虑使用 WebClient。
2. 在生产环境中，要注意设置合理的超时时间和连接池参数。
3. 处理响应时要注意检查响应状态和错误处理。
4. 使用 HTTPS 时需要适当配置SSL证书。

8. 总结

本文详细介绍了在 SpringBoot 3.x 中如何配置和使用 RestTemplate，包括基本配置、高级配置以及各种使用场景。虽然 RestTemplate 目前处于维护模式，但它仍然是一个稳定且易用的HTTP客户端工具。对于新项目，也可以考虑使用响应式的WebClient作为替代方案。

参考资料

• Spring官方文档
• SpringBoot官方文档