Spring框架中??RestTemplate的使用及說明
當(dāng)然可以！下面我將為你詳細(xì)講解 Spring 框架中 ??RestTemplate 的使用方法??，包括它的基本概念、核心功能、常見用法、配置方式、以及在實(shí)際項(xiàng)目中的最佳實(shí)踐，并附帶代碼示例，幫助你全面掌握。
一、什么是 RestTemplate？
??RestTemplate?? 是 Spring Framework 提供的一個(gè)用于訪問 RESTful 服務(wù)的同步客戶端工具類，它是對(duì) HTTP 客戶端的一層封裝，簡(jiǎn)化了與 REST 服務(wù)交互的過程，比如：
- 發(fā)送 GET、POST、PUT、DELETE 請(qǐng)求
- 設(shè)置請(qǐng)求頭、請(qǐng)求參數(shù)、請(qǐng)求體
- 處理響應(yīng)數(shù)據(jù)（JSON / XML 等）
- 錯(cuò)誤處理
它適用于 ??服務(wù)與服務(wù)之間（如微服務(wù)架構(gòu)）的 HTTP 通信??，在 Spring Boot 2.x 之前非常常用。但從 ??Spring 5 開始，官方推薦使用 WebClient（響應(yīng)式非阻塞）作為 RestTemplate 的替代方案??，不過 ??RestTemplate 仍然被廣泛使用，特別是在傳統(tǒng) Spring MVC 項(xiàng)目中??。
二、RestTemplate 的核心特點(diǎn)
特性 | 說明 |
|---|---|
同步阻塞 | RestTemplate 是 ??同步、阻塞式?? 的 HTTP 客戶端，調(diào)用線程會(huì)等待響應(yīng)返回 |
支持多種 HTTP 方法 | GET、POST、PUT、DELETE、PATCH 等 |
支持請(qǐng)求/響應(yīng)的序列化與反序列化 | 比如自動(dòng)將 Java 對(duì)象轉(zhuǎn)為 JSON 發(fā)送，或者將返回的 JSON 轉(zhuǎn)為 Java 對(duì)象 |
靈活的請(qǐng)求構(gòu)造 | 可以設(shè)置 URL、請(qǐng)求頭、請(qǐng)求參數(shù)、請(qǐng)求體等 |
支持多種響應(yīng)處理方式 | 比如直接獲取字符串、字節(jié)數(shù)組、對(duì)象等 |
易于使用 | 相比原生 HttpURLConnection 或 HttpClient，使用更簡(jiǎn)單 |
三、RestTemplate 的基本使用步驟
步驟 1：引入依賴（Spring Boot 項(xiàng)目中通常已包含）
如果你使用的是 Spring Boot，一般無需額外引入，因?yàn)?nbsp;spring-web已經(jīng)包含 RestTemplate（在 spring-boot-starter-web 中）。
但如果你想自定義或明確引入，可以檢查你的 pom.xml是否有以下依賴：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>?? 注意：從 Spring Boot 2.7 開始，RestTemplate 不再自動(dòng)配置，你需要手動(dòng)創(chuàng)建 Bean；Spring Boot 3.x 推薦使用 WebClient。
步驟 2：創(chuàng)建 RestTemplate 實(shí)例
方式一：直接 new（不推薦，無連接池等優(yōu)化）
RestTemplate restTemplate = new RestTemplate();
方式二：通過 Spring Bean 方式注入（推薦）
你可以在配置類中定義一個(gè) RestTemplate Bean：
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;
@Configuration
public class RestTemplateConfig {
@Bean
public RestTemplate restTemplate() {
return new RestTemplate();
}
}然后就可以通過 ??@Autowired?? 注入使用：
@Autowired private RestTemplate restTemplate;
步驟 3：使用 RestTemplate 發(fā)送請(qǐng)求
下面介紹最常用的幾種 HTTP 方法的使用。
1. GET 請(qǐng)求
① 獲取字符串響應(yīng)
String url = "https://jsonplaceholder.typicode.com/posts/1"; String result = restTemplate.getForObject(url, String.class); System.out.println(result);
② 獲取對(duì)象（自動(dòng)反序列化 JSON 到 Java 對(duì)象）
假設(shè)有一個(gè)類：
public class Post {
private Integer userId;
private Integer id;
private String title;
private String body;
// getters / setters ...
}調(diào)用：
String url = "https://jsonplaceholder.typicode.com/posts/1"; Post post = restTemplate.getForObject(url, Post.class); System.out.println(post.getTitle());
③ 帶路徑參數(shù)的 GET 請(qǐng)求
String url = "https://jsonplaceholder.typicode.com/posts/{id}";
Map<String, Object> params = new HashMap<>();
params.put("id", 1);
Post post = restTemplate.getForObject(url, Post.class, params);
// 或者
Post post = restTemplate.getForObject(url, Post.class, 1); // 直接傳參④ 帶請(qǐng)求頭的 GET 請(qǐng)求
需要使用 HttpHeaders和 HttpEntity、RestTemplate.exchange()：
String url = "https://jsonplaceholder.typicode.com/posts/1";
HttpHeaders headers = new HttpHeaders();
headers.set("Authorization", "Bearer your_token_here");
headers.setAccept(Collections.singletonList(MediaType.APPLICATION_JSON));
HttpEntity<String> entity = new HttpEntity<>(headers);
ResponseEntity<Post> response = restTemplate.exchange(
url,
HttpMethod.GET,
entity,
Post.class
);
Post post = response.getBody();
System.out.println(post.getTitle());2. POST 請(qǐng)求
① 發(fā)送對(duì)象并接收對(duì)象（常用）
String url = "https://jsonplaceholder.typicode.com/posts";
Post newPost = new Post();
newPost.setTitle("Hello");
newPost.setBody("This is a test post");
// userId 可以根據(jù) API 要求設(shè)置
Post createdPost = restTemplate.postForObject(url, newPost, Post.class);
System.out.println(createdPost.getId());② 帶請(qǐng)求頭的 POST 請(qǐng)求
String url = "https://example.com/api/posts";
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
headers.set("Authorization", "Bearer xxxx");
Post newPost = new Post();
newPost.setTitle("Hello");
newPost.setBody("Content");
HttpEntity<Post> requestEntity = new HttpEntity<>(newPost, headers);
ResponseEntity<Post> response = restTemplate.exchange(
url,
HttpMethod.POST,
requestEntity,
Post.class
);
Post result = response.getBody();3. PUT 請(qǐng)求（更新資源）
String url = "https://jsonplaceholder.typicode.com/posts/1";
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
Post updatedPost = new Post();
updatedPost.setId(1);
updatedPost.setTitle("Updated Title");
updatedPost.setBody("Updated Body");
HttpEntity<Post> requestEntity = new HttpEntity<>(updatedPost, headers);
restTemplate.exchange(url, HttpMethod.PUT, requestEntity, Void.class);
// 如果你不需要返回值，可以用 Void.class4. DELETE 請(qǐng)求
String url = "https://jsonplaceholder.typicode.com/posts/1"; restTemplate.delete(url);
如果帶路徑參數(shù)：
String url = "https://jsonplaceholder.typicode.com/posts/{id}";
Map<String, Object> params = Collections.singletonMap("id", 1);
restTemplate.delete(url, params);四、RestTemplate 的高級(jí)用法
1. 使用 exchange() 方法（最靈活）
exchange()是 RestTemplate 最強(qiáng)大的方法，支持所有 HTTP 方法，可以自定義請(qǐng)求頭、請(qǐng)求體，且能獲取完整的響應(yīng)信息（狀態(tài)碼、響應(yīng)頭、響應(yīng)體）。
ResponseEntity<Post> response = restTemplate.exchange(
url, // 請(qǐng)求URL
HttpMethod.GET, // 請(qǐng)求方法
entity, // 請(qǐng)求實(shí)體（可含headers、body）
Post.class // 響應(yīng)體類型
);
HttpStatus statusCode = response.getStatusCode(); // 如 HttpStatus.OK
HttpHeaders responseHeaders = response.getHeaders(); // 響應(yīng)頭
Post responseBody = response.getBody(); // 響應(yīng)體2. 使用 ResponseEntity 接收更豐富的響應(yīng)信息
ResponseEntity<String> response = restTemplate.getForEntity(url, String.class); System.out.println(response.getStatusCode()); // 如 200 OK System.out.println(response.getBody());
3. 錯(cuò)誤處理
默認(rèn)情況下，如果服務(wù)端返回 4xx 或 5xx，RestTemplate 會(huì)拋出異常，比如：
- HttpClientErrorException（4xx）
- HttpServerErrorException（5xx）
你可以捕獲這些異常做處理：
try {
Post post = restTemplate.getForObject(url, Post.class);
} catch (HttpClientErrorException e) {
System.err.println("客戶端錯(cuò)誤: " + e.getStatusCode() + ", " + e.getResponseBodyAsString());
} catch (HttpServerErrorException e) {
System.err.println("服務(wù)端錯(cuò)誤: " + e.getStatusCode());
} catch (RestClientException e) {
System.err.println("Rest請(qǐng)求異常: " + e.getMessage());
}五、RestTemplate 的配置（可選）
你可以通過自定義 RestTemplate的構(gòu)建過程，配置例如：
- 消息轉(zhuǎn)換器（如支持 JSON、XML）
- 攔截器（添加統(tǒng)一 Header、日志等）
- 超時(shí)設(shè)置（需要使用 HttpComponentsClientHttpRequestFactory 或 SimpleClientHttpRequestFactory）
示例：配置超時(shí)和攔截器
@Bean
public RestTemplate restTemplate() {
RestTemplate restTemplate = new RestTemplate();
// 設(shè)置請(qǐng)求工廠（可配置超時(shí)）
SimpleClientHttpRequestFactory factory = new SimpleClientHttpRequestFactory();
factory.setConnectTimeout(5000); // 連接超時(shí)時(shí)間 ms
factory.setReadTimeout(5000); // 讀取超時(shí)時(shí)間 ms
restTemplate.setRequestFactory(factory);
// 添加攔截器（比如統(tǒng)一加 Token）
restTemplate.getInterceptors().add((request, body, execution) -> {
request.getHeaders().add("Authorization", "Bearer xxx");
return execution.execute(request, body);
});
return restTemplate;
}如果你要更高級(jí)的 HTTP 客戶端功能（如連接池、更靈活的超時(shí)控制），可以考慮使用 ??Apache HttpClient?? 或 ??OkHttp?? 作為底層實(shí)現(xiàn)，然后傳入對(duì)應(yīng)的 ClientHttpRequestFactory。
六、RestTemplate vs WebClient
對(duì)比項(xiàng) | RestTemplate | WebClient |
|---|---|---|
類型 | 同步阻塞 | 異步非阻塞（響應(yīng)式） |
適用場(chǎng)景 | 傳統(tǒng) MVC、簡(jiǎn)單調(diào)用 | 高并發(fā)、響應(yīng)式編程、WebFlux |
是否推薦新項(xiàng)目使用 | ? 不推薦（尤其 Spring 6 / Boot 3） | ? 推薦 |
學(xué)習(xí)曲線 | 簡(jiǎn)單 | 較復(fù)雜（需了解 Reactor） |
Spring Boot 3 支持 | 已移除自動(dòng)配置 | ? 官方主推 |
如果你使用的是 ??Spring Boot 3+ 或 Spring 6+，官方已移除 RestTemplate 自動(dòng)配置，推薦使用 WebClient??。
七、總結(jié)：RestTemplate 使用要點(diǎn)
項(xiàng)目 | 說明 |
|---|---|
作用 | 用于同步調(diào)用 RESTful API，簡(jiǎn)化 HTTP 客戶端操作 |
推薦使用場(chǎng)景 | 傳統(tǒng) Spring MVC 項(xiàng)目，簡(jiǎn)單 HTTP 調(diào)用 |
創(chuàng)建方式 | 推薦通過 @Bean 方式注入 |
常用方法 | getForObject、postForObject、exchange、delete 等 |
請(qǐng)求構(gòu)造 | 支持 URL、參數(shù)、Header、Body |
響應(yīng)處理 | 支持 String、JSON 對(duì)象、ResponseEntity 等 |
錯(cuò)誤處理 | 捕獲 HttpClientErrorException / HttpServerErrorException |
配置優(yōu)化 | 可配置超時(shí)、攔截器、消息轉(zhuǎn)換器等 |
替代方案 | WebClient（響應(yīng)式，Spring 5+ 推薦） |
八、附：完整示例代碼（GET + POST）
@Service
public class ApiService {
@Autowired
private RestTemplate restTemplate;
// GET 示例
public Post getPostById(int id) {
String url = "https://jsonplaceholder.typicode.com/posts/{id}";
return restTemplate.getForObject(url, Post.class, id);
}
// POST 示例
public Post createPost(Post newPost) {
String url = "https://jsonplaceholder.typicode.com/posts";
return restTemplate.postForObject(url, newPost, Post.class);
}
}以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。
相關(guān)文章
這篇文章主要介紹了Java多線程編程中線程鎖與讀寫鎖的使用示例,鎖是控制程序多線程并發(fā)的重要手段,需要的朋友可以參考下2016-04-04
IDEA編輯器中打開properties文件時(shí)出現(xiàn)中文亂碼,可以通過修改文件編碼格式來解決,具體步驟為：設(shè)置》Setting》Editor》FileEncodings,將編碼格式更改為UTF-82025-01-01
Spring 事務(wù)的隔離級(jí)別是一個(gè)重要的概念,它定義了事務(wù)之間的隔離程度,以防止并發(fā)問題（如臟讀、不可重復(fù)讀和幻讀）,本文給大家介紹Spring事務(wù)的隔離級(jí)別,感興趣的朋友跟隨小編一起看看吧2025-11-11
java中關(guān)于getProperties方法的使用
這篇文章主要介紹了java中關(guān)于getProperties方法的使用,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-12-12
解決Springboot-application.properties中文亂碼問題
這篇文章主要介紹了解決Springboot-application.properties中文亂碼問題，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-11-11
mybatis通過if語句實(shí)現(xiàn)增刪改查操作
這篇文章主要介紹了mybatis通過if語句實(shí)現(xiàn)增刪改查操作，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2020-11-11
這篇文章主要介紹了Java中的ArrayList類常用方法和遍歷，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2022-02-02
SpringMVC 參數(shù)綁定相關(guān)知識(shí)總結(jié)
這篇文章主要介紹了SpringMVC 參數(shù)綁定相關(guān)知識(shí)總結(jié)，幫助大家更好的理解和學(xué)習(xí)使用SpringMVC，感興趣的朋友可以了解下2021-03-03
java實(shí)現(xiàn)簡(jiǎn)易版圖形界面計(jì)算器
這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)簡(jiǎn)易版圖形界面計(jì)算器，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2020-05-05
Spring Boot啟動(dòng)及退出加載項(xiàng)的方法
這篇文章主要介紹了Spring Boot啟動(dòng)及退出加載項(xiàng)的方法，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-04-04