springcloud之FeignClient使用詳解

更新時間：2024年12月31日 15:16:22 作者：Aikes902

Feign是一種聲明式、模板化的HTTP客戶端,可以簡化微服務之間的遠程過程調用,通過Feign,開發(fā)者可以像調用本地方法一樣調用遠程服務,而無需感知這是一個HTTP請求,引入Feign后,微服務之間的調用流程更加簡化,結合Ribbon實現了路由負載、超時熔斷等功能

前言

在微服務項目中會存在多個微服務之間互相調用的情況，如何高效便捷的進行遠程過程調用便成為新的議論話題。spring-cloud中提供的feign方式可以有效解決該問題。

Feign是一種聲明式、模板化的HTTP客戶端。在Spring Cloud中使用Feign, 我們可以做到使用HTTP請求遠程服務時能與調用本地方法一樣的編碼體驗，開發(fā)者完全感知不到這是遠程方法，更感知不到這是個HTTP請求。

如下testMicroServiceAccess方法便是feignClient調用，但是外部看起來和普通方法無二。

業(yè)務場景

假設同一個注冊中心上有兩個微服務：A和B，為完成某個業(yè)務功能，B微服務需要調用A微服務中的某個方法邏輯獲取返回結果，并且二者是不能作為jar互相依賴的，按照傳統方式只能如下處理：

請求——>外部網關——>應用層——>內部網關——>B微服務——>外部網關——>應用層——>內部網關——>A微服務——>結束

即便是拆掉外部網關和應用層，也需要通過內部網關中轉才能訪問到A微服務，況且還要考慮超時熔斷、路由負載等問題。

引入feign后簡化流程，并且其結合ribbon實現路由負載超時熔斷等措施，具體流程如下：

請求——>外部網關——>應用層——>內部網關——>B微服務——>feignClient——>A微服務——>結束

架構說明

按照上述業(yè)務假設進行架構說明：

1、為保持系統良好的可擴展性，降低模塊耦合度，新建A-FeignClient模塊，用于提供feign接口和相關實體類。后期作為jar文件推送到Maven私服中，供A、B微服務各自引用。

2、A微服務中僅需要在啟動類上增加開啟feign的注解，可以考慮增加A-FeignClient依賴，這樣三個模塊使用同一份實體類，保證一致性。

3、B微服務中增加A-FeignClient模塊的依賴，編寫客戶端調用代碼。

調用邏輯

1、A-FeignClient

a、在A-FeignClient中增加接口，通過spring注解標識其提供服務的真正接口路徑。
b、@FeignClient注解中name值目標微服務名，contextId用于標識FeignClient名。
c、方法名上的postmapping用于標識該方法需要轉發(fā)的接口路徑。下圖代碼示例中意思即：調用該方法后會代理到A微服務的/demoServer/testMicroServiceAccess接口中。
d、通過實現該接口的方式新建一個類，可以用于feign調用失敗后的容錯處理。

package com.demo.DemoFeignClient;

/**
 * 微服務之間調用的核心接口     Aikes
 * 注解@FeignClient中contextID參數用于標識client，防止多個接口共用同一個目標FeignClient沖突
 */
@FeignClient(name = "A-server" ,contextId = "DemoFeignClient", fallback = DemoFeignClientFallback.class )
public interface DemoFeignClient{

    @PostMapping("/demoServer/testMicroServiceAccess")
    public ApiResponse<String> testMicroServiceAccess(@RequestBody ServerAccessRequest<DemoPo> cServerAccessRequest);
}

/**
 * 增加訪問失敗時的處理邏輯
 */
@Component
class DemoFeignClientFallback implements DemoFeignClient{

    @Override
    public ApiResponse<String> testMicroServiceAccess(ServerAccessRequest<DemoPo> cServerAccessRequest) {
        ApiResponse<String> tApiResponse = new ApiResponse<>();
        tApiResponse.setStatus(ApiResponse.BUSY);
        return tApiResponse;
    }
}

2、A微服務

作為服務提供方，只需要正常編寫業(yè)務邏輯即可，重點需要考慮請求入參的實體類把控，建議引用A-FeignClient中，保證一致性。

package com.demo.DemoFeignServerController;

/**
 * 服務提供方    Aikes
 */
@Controller
@RequestMapping("demoServer")
@RestController
@Slf4j
public class DemoFeignServerController {

    @PostMapping("/testMicroServiceAccess")
    public ApiResponse<String> testMicroServiceAccess(@RequestBody ServerAccessRequest<DemoPo> cServerAccessRequest) {
        log.info(cServerAccessRequest.toString());
        log.info("This is FeignServerController");
        ApiResponse<String> tApiResponse = new ApiResponse<String>();
        tApiResponse.setStatus(ApiResponse.SUCCESS);
        tApiResponse.setStatusText(ApiResponse.SUCCESS_TEXT);
        tApiResponse.setData(cServerAccessRequest.getData().getDemoName());
        return tApiResponse;
    }
}

3、B微服務

作為服務消費方，在核心邏輯處理中，通過調用引入的A-FeignClient模塊的接口，由feign負責代理轉發(fā)到A微服務，實現調用A微服務的相關邏輯。

package com.demo.DemoFeignClientController;

/**
 * 服務消費方    Aikes
 */
public class DemoFeignClientController {

    @Autowired
    private DemoFeignClient mDemoFeignClient;

    public void doService() {
        //TODO 業(yè)務處理
        ApiResponse<String> tApiResponse = this.testFeign();//調用 A微服務 處理邏輯
        //TODO 處理返回結果
    }

    public ApiResponse<String> testFeign() {
        ServerAccessRequest<DemoPo> tServerAccessRequest = new ServerAccessRequest<DemoPo>();
        tServerAccessRequest.setBusinessNo("TEST001");
        return mDemoFeignClient.testMicroServiceAccess(tServerAccessRequest);
    }
}