目錄

一、環境準備

二、啟用Feign客戶端

三、定義Feign客戶端接口

四、定義請求/響應DTO

五、調用Feign客戶端

六、高級配置

1. 添加請求頭（如認證）

2. 超時配置（application.yml）

3. 日志配置

七、錯誤處理

自定義錯誤解碼器

八、測試調用

常見問題解決

---

以下是Spring Boot項目通過Feign調用第三方接口的詳細教程，包含完整步驟和代碼示例：

---

一、環境準備

1. 創建Spring Boot項目
   使用Spring Initializr生成項目，選擇依賴：

   • Spring Web
   • OpenFeign

2. pom.xml依賴

   <dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-openfeign</artifactId><version>3.1.3</version> <!-- 與Spring Boot版本匹配 --></dependency>
   </dependencies>
   

---

二、啟用Feign客戶端

在啟動類添加注解：

@SpringBootApplication
@EnableFeignClients // 關鍵注解
public class DemoApplication {public static void main(String[] args) {SpringApplication.run(DemoApplication.class, args);}
}

---

三、定義Feign客戶端接口

創建接口聲明第三方API調用：

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;@FeignClient(name = "thirdPartyApi", url = "https://api.example.com" // 第三方接口基地址
)
public interface ThirdPartyClient {// 示例：GET請求@GetMapping("/users/{id}")UserResponse getUser(@PathVariable("id") Long userId);// 示例：POST請求@PostMapping("/orders")OrderResponse createOrder(@RequestBody OrderRequest request);
}

---

四、定義請求/響應DTO

// 請求示例
public class OrderRequest {private String productId;private Integer quantity;// getters/setters
}// 響應示例
public class UserResponse {private Long id;private String name;private String email;// getters/setters
}

---

五、調用Feign客戶端

在Service中注入并使用：

@Service
public class ApiService {@Autowiredprivate ThirdPartyClient thirdPartyClient; // 注入Feign客戶端public UserResponse fetchUser(Long userId) {return thirdPartyClient.getUser(userId); // 調用第三方API}public void createNewOrder(OrderRequest request) {OrderResponse response = thirdPartyClient.createOrder(request);System.out.println("Order created: " + response.getOrderId());}
}

---

六、高級配置

1. 添加請求頭（如認證）

@FeignClient(name = "authApi", url = "https://api.example.com")
public interface AuthClient {@GetMapping("/profile")ProfileResponse getProfile(@RequestHeader("Authorization") String token // 動態傳遞Header);
}

2. 超時配置（application.yml）

feign:client:config:default:connectTimeout: 5000  # 連接超時(ms)readTimeout: 10000     # 讀取超時(ms)

3. 日志配置

@Configuration
public class FeignConfig {@BeanLogger.Level feignLoggerLevel() {return Logger.Level.FULL; // 輸出完整請求日志}
}

在application.yml啟用日志：

logging:level:com.example.demo.client.ThirdPartyClient: DEBUG

---

七、錯誤處理

自定義錯誤解碼器

public class CustomErrorDecoder implements ErrorDecoder {@Overridepublic Exception decode(String methodKey, Response response) {if (response.status() == 404) {return new ResourceNotFoundException("API resource not found");}return new FeignException.BadRequest("API request failed");}
}

在配置類注冊：

@Bean
public ErrorDecoder errorDecoder() {return new CustomErrorDecoder();
}

---

八、測試調用

@RestController
public class DemoController {@Autowiredprivate ApiService apiService;@GetMapping("/user/{id}")public UserResponse getUser(@PathVariable Long id) {return apiService.fetchUser(id);}
}

---

常見問題解決

1. 404錯誤

   • 檢查第三方URL是否正確
   • 確認接口路徑是否包含上下文路徑（如/api/v1）

2. 超時問題
   調整配置：

   ribbon:ConnectTimeout: 3000ReadTimeout: 60000
   

3. JSON解析錯誤
   確保DTO字段名與JSON屬性名匹配，或使用@JsonProperty注解

4. 啟用GZIP壓縮（提升性能）

   feign:compression:request:enabled: trueresponse:enabled: true
   

提示：實際調用前建議使用Postman測試第三方接口可用性。