Spring Boot 中 RestTemplate 的核心用法指南
更新時間：2025年12月13日 11:09:25 作者：一勺菠蘿丶
本文詳細(xì)介紹了RestTemplate的使用,包括基礎(chǔ)用法、進(jìn)階配置技巧、實戰(zhàn)案例以及最佳實踐建議,通過一個騰訊地圖路線規(guī)劃的案例,展示了如何在實際項目中應(yīng)用RestTemplate進(jìn)行服務(wù)間通信,感興趣的朋友跟隨小編一起看看吧
在分布式系統(tǒng)開發(fā)中，服務(wù)間通信是常見需求。作為 Spring 框架的重要組件，RestTemplate 為開發(fā)者提供了簡潔優(yōu)雅的 HTTP 客戶端解決方案。本文將從零開始講解 RestTemplate 的核心用法，并附贈真實地圖 API 對接案例。
一、環(huán)境準(zhǔn)備
在 Spring Boot 項目中添加依賴：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>通過配置類初始化 RestTemplate：
@Configuration
public class RestTemplateConfig {
@Bean
public RestTemplate restTemplate() {
return new RestTemplate();
}
}
用的時候引入
@Autowired
private RestTemplate restTemplate;
二、基礎(chǔ)用法全解析
1. GET 請求的三種姿勢
方式一：路徑參數(shù)（推薦）
String url = "https://api.example.com/users/{id}";
Map<String, Object> params = new HashMap<>();
params.put("id", 1001);
User user = restTemplate.getForObject(url, User.class, params);方式二：顯式拼接參數(shù)
String url = "https://api.example.com/users?id=1001"; User user = restTemplate.getForObject(url, User.class);
方式三：URI 構(gòu)造器
UriComponentsBuilder builder = UriComponentsBuilder
.fromUriString("https://api.example.com/users")
.queryParam("name", "John")
.queryParam("age", 25);
User user = restTemplate.getForObject(builder.toUriString(), User.class);2. POST 請求深度實踐
發(fā)送表單數(shù)據(jù)：
MultiValueMap<String, String> formData = new LinkedMultiValueMap<>();
formData.add("username", "admin");
formData.add("password", "123456");
ResponseEntity<String> response = restTemplate.postForEntity(
"https://api.example.com/login",
formData,
String.class
);提交 JSON 對象：
User newUser = new User("Alice", 28);
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<User> request = new HttpEntity<>(newUser, headers);
User createdUser = restTemplate.postForObject(
"https://api.example.com/users",
request,
User.class
);三、進(jìn)階配置技巧
1. 超時控制
@Bean
public RestTemplate customRestTemplate() {
return new RestTemplateBuilder()
.setConnectTimeout(Duration.ofSeconds(5))
.setReadTimeout(Duration.ofSeconds(10))
.build();
}
2. 攔截器實戰(zhàn)
public class LoggingInterceptor implements ClientHttpRequestInterceptor {
@Override
public ClientHttpResponse intercept(HttpRequest request, byte[] body,
ClientHttpRequestExecution execution) throws IOException {
logRequest(request, body);
ClientHttpResponse response = execution.execute(request, body);
logResponse(response);
return response;
}
private void logRequest(HttpRequest request, byte[] body) {
// 實現(xiàn)請求日志記錄
}
private void logResponse(ClientHttpResponse response) {
// 實現(xiàn)響應(yīng)日志記錄
}
}注冊攔截器：
@Bean
public RestTemplate restTemplate() {
RestTemplate restTemplate = new RestTemplate();
restTemplate.setInterceptors(Collections.singletonList(new LoggingInterceptor()));
return restTemplate;
}四、實戰(zhàn)案例：騰訊地圖路線規(guī)劃
@Service
public class MapService {
@Value("${tencent.map.key}")
private String apiKey;
@Autowired
private RestTemplate restTemplate;
public DrivingRoute calculateRoute(Location start, Location end) {
String url = "https://apis.map.qq.com/ws/direction/v1/driving/"
+ "?from={start}&to={end}&key={key}";
Map<String, String> params = new HashMap<>();
params.put("start", start.toString());
params.put("end", end.toString());
params.put("key", apiKey);
ResponseEntity<MapResponse> response = restTemplate.getForEntity(
url,
MapResponse.class,
params
);
if (response.getStatusCode() == HttpStatus.OK &&
response.getBody().getStatus() == 0) {
return response.getBody().getResult().getRoutes().get(0);
}
throw new MapServiceException("路線規(guī)劃失敗");
}
}五、最佳實踐建議
- 響應(yīng)處理策略
- 使用
ResponseEntity<T>獲取完整響應(yīng)信息 - 實現(xiàn)自定義錯誤處理器
ResponseErrorHandler - 對于復(fù)雜 JSON 結(jié)構(gòu)，建議定義完整的 DTO 類
- 使用
- 性能優(yōu)化
- 啟用連接池（推薦 Apache HttpClient）
- 合理設(shè)置超時時間
- 考慮異步調(diào)用（結(jié)合 AsyncRestTemplate）
- 安全防護(hù)
- 啟用 HTTPS
- 敏感參數(shù)加密處理
- 配置請求頻率限制
六、常見問題排查
問題1：收到 400 Bad Request
- 檢查請求參數(shù)格式
- 確認(rèn) Content-Type 設(shè)置正確
- 驗證請求體 JSON 結(jié)構(gòu)
問題2：出現(xiàn)亂碼
- 設(shè)置正確的字符編碼
- 檢查服務(wù)端和客戶端的編碼一致性
- 在 headers 中明確指定
charset=UTF-8
問題3：超時配置不生效
- 確認(rèn)使用的 RestTemplate 實例正確
- 檢查連接池配置是否覆蓋超時設(shè)置
- 驗證網(wǎng)絡(luò)防火墻設(shè)置
到此這篇關(guān)于Spring Boot 中 RestTemplate 的核心用法指南的文章就介紹到這了,更多相關(guān)Spring Boot RestTemplate使用內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
您可能感興趣的文章:
- SpringBoot3使用RestTemplate請求接口忽略SSL證書的問題解決
- SpringBoot下使用RestTemplate實現(xiàn)遠(yuǎn)程服務(wù)調(diào)用的詳細(xì)過程
- Springboot之restTemplate配置及使用方式
- SpringBoot使用RestTemplate如何通過http請求將文件下載到本地
- SpringBoot3 RestTemplate配置與使用詳解
- SpringBoot使用RestTemplate實現(xiàn)HTTP請求詳解
- SpringBoot中的RestTemplate使用方法詳解
- SpringBoot中RestTemplate的使用詳解
- 關(guān)于springboot 中使用httpclient或RestTemplate做MultipartFile文件跨服務(wù)傳輸?shù)膯栴}
相關(guān)文章
這篇文章主要介紹了Mybatis使用命令生成逆向工程的方法,本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-01-01
在Java?編程中,經(jīng)常需要對集合進(jìn)行一些操作,比如取兩個集合的交集、并集和差集,下面這篇文章主要給大家介紹了關(guān)于Java兩個集合取差集的4種方式,需要的朋友可以參考下2024-08-08
SpringSecurity集成圖片驗證碼的詳細(xì)過程
SpringSecurity是通過過濾器鏈來完成的,接下來的驗證碼,可以嘗試創(chuàng)建一個過濾器放到Security的過濾器鏈中,在自定義的過濾器中比較驗證碼,本文通過實例代碼介紹SpringSecurity集成圖片驗證碼的詳細(xì)過程,感興趣的朋友一起看看吧2023-12-12
Java?Web應(yīng)用小案例之實現(xiàn)用戶登錄功能全過程
在Java開發(fā)過程中實現(xiàn)用戶的注冊功能是最基本的,這篇文章主要給大家介紹了關(guān)于Java?Web應(yīng)用小案例之實現(xiàn)用戶登錄功能的相關(guān)資料,文中通過圖文介紹的非常詳細(xì),需要的朋友可以參考下2024-01-01
一個事件需要經(jīng)過多個對象處理是一個挺常見的場景，譬如采購審批流程，請假流程，軟件開發(fā)中的異常處理流程，web請求處理流程等各種各樣的流程，可以考慮使用責(zé)任鏈模式來實現(xiàn)2021-09-09
這篇文章主要介紹了JPA默認(rèn)值設(shè)置沒有效果的解決方案，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-11-11
idea?maven項目啟動項目不編譯target?文件的問題及解決方法
代碼編輯器中無編譯錯誤，通過maven 的clean 、compile、package進(jìn)行各種操作也都沒問題，但是單擊綠色箭頭運(yùn)行（默認(rèn)會先執(zhí)行IDE本身的Build操作）卻報：程序包xxx不存在，這篇文章主要介紹了解決idea maven項目啟動項目不編譯target文件問題,需要的朋友可以參考下2023-05-05
這篇文章主要介紹了idea 如何查找類中的某個方法，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2021-02-02
這篇文章主要介紹了通過實例解析傳統(tǒng)jar包引用方式,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2020-07-07
這篇文章主要為大家詳細(xì)介紹了Java服務(wù)器處理圖片上傳，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-06-06