目錄

步驟1: 添加依賴

步驟2: 配置HTTP客戶端

配置RestTemplate

配置WebClient

步驟3: 在Service層調用接口

使用RestTemplate示例

使用WebClient示例

步驟4: 在Controller層調用Service

注意事項

總結

---

Spring Boot項目中調用第三方接口

在Spring Boot項目中調用第三方接口（如RESTful API）是常見的需求，通常通過HTTP客戶端實現。Spring Boot提供了多種工具，如RestTemplate（同步）和WebClient（異步）。下面我將逐步解釋如何實現，確保回答真實可靠。整個過程包括添加依賴、配置客戶端、發送請求和處理響應。我將以調用一個簡單的GET接口為例。

步驟1: 添加依賴

首先，在項目的pom.xml文件中添加Spring Boot Starter Web依賴（如果使用RestTemplate）或Starter WebFlux依賴（如果使用WebClient）。以下是RestTemplate的依賴：

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

如果選擇WebClient（推薦用于響應式編程），添加：

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-webflux</artifactId>
</dependency>

步驟2: 配置HTTP客戶端

在Spring Boot中，你可以通過配置類定義Bean。以下是兩種方法的配置：

• 使用RestTemplate（同步）：適合簡單請求。
• 使用WebClient（異步）：適合高并發場景，支持非阻塞IO。

配置RestTemplate

創建一個配置類，定義RestTemplate Bean：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;@Configuration
public class AppConfig {@Beanpublic RestTemplate restTemplate() {return new RestTemplate();}
}

配置WebClient

創建一個配置類，定義WebClient Bean：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.reactive.function.client.WebClient;@Configuration
public class AppConfig {@Beanpublic WebClient webClient() {return WebClient.create();}
}

步驟3: 在Service層調用接口

創建一個Service類，注入HTTP客戶端，并編寫方法發送請求。以下示例調用一個假想的第三方API（URL：https://api.example.com/data），假設返回JSON數據。

使用RestTemplate示例

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.web.client.RestTemplate;@Service
public class ApiService {private final RestTemplate restTemplate;@Autowiredpublic ApiService(RestTemplate restTemplate) {this.restTemplate = restTemplate;}public String callThirdPartyApi() {String url = "https://api.example.com/data"; // 替換為實際接口URL// 發送GET請求，返回String類型（假設接口返回文本或JSON）return restTemplate.getForObject(url, String.class);}// 如果需要POST請求，示例：public String postData(String requestBody) {String url = "https://api.example.com/post";return restTemplate.postForObject(url, requestBody, String.class);}
}

使用WebClient示例

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.web.reactive.function.client.WebClient;
import reactor.core.publisher.Mono;@Service
public class ApiService {private final WebClient webClient;@Autowiredpublic ApiService(WebClient webClient) {this.webClient = webClient;}public Mono<String> callThirdPartyApi() {String url = "https://api.example.com/data"; // 替換為實際接口URL// 發送GET請求，返回Mono<String>（響應式編程）return webClient.get().uri(url).retrieve().bodyToMono(String.class);}// 如果需要POST請求，示例：public Mono<String> postData(String requestBody) {String url = "https://api.example.com/post";return webClient.post().uri(url).bodyValue(requestBody).retrieve().bodyToMono(String.class);}
}

步驟4: 在Controller層調用Service

創建一個Controller，注入Service并暴露API端點，供前端或其他服務調用。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;@RestController
public class ApiController {private final ApiService apiService;@Autowiredpublic ApiController(ApiService apiService) {this.apiService = apiService;}@GetMapping("/call-api")public String callApi() {// 使用RestTemplate版本return apiService.callThirdPartyApi();// 如果使用WebClient，需處理異步響應（例如：.block()或返回Mono）}
}

注意事項

1. 錯誤處理：添加異常處理，例如使用try-catch塊捕獲RestClientException或WebClientResponseException。
   • 示例：在Service方法中添加：

     try {return restTemplate.getForObject(url, String.class);
     } catch (RestClientException e) {throw new RuntimeException("調用接口失敗: " + e.getMessage());
     }
     

2. 請求頭與參數：如果需要設置請求頭（如認證token），使用HttpHeaders。
   • 對于RestTemplate：使用HttpEntity封裝頭和體。
   • 對于WebClient：使用.header()方法。
3. 依賴管理：確保Spring Boot版本兼容（建議使用Spring Boot 2.x或3.x）。
4. 測試：使用單元測試（如JUnit和Mockito）模擬HTTP調用。
5. 性能：對于高負載應用，優先使用WebClient以避免線程阻塞。
6. 第三方庫：如果接口復雜，考慮使用Feign（聲明式REST客戶端），添加spring-cloud-starter-openfeign依賴。

總結

在Spring Boot中調用第三方接口，核心步驟是添加依賴、配置客戶端Bean、在Service層發送請求。RestTemplate簡單易用，適合初學者；WebClient更現代，支持響應式編程。根據項目需求選擇，并始終添加錯誤處理和日志記錄。如果接口需要認證或復雜參數，參考Spring官方文檔進一步優化。