SpringBoot動態(tài)Feign服務(wù)調(diào)用詳解

更新時間：2022年12月21日 10:11:02 作者：xp_xpxp

Feign是Netflix公司開發(fā)的一個聲明式的REST調(diào)用客戶端; Ribbon負(fù)載均衡、 Hystrⅸ服務(wù)熔斷是我們Spring Cloud中進行微服務(wù)開發(fā)非?；A(chǔ)的組件,在使用的過程中我們也發(fā)現(xiàn)它們一般都是同時出現(xiàn)的,而且配置也都非常相似

1.Feign傳統(tǒng)方式的不足

①.在微服務(wù)架構(gòu)中,當(dāng)我們使用Feign傳統(tǒng)方式進行服務(wù)調(diào)用的時候,需要在每個服務(wù)消費者中添加FeignClient接口,編寫對應(yīng)的方法,而且當(dāng)服務(wù)生產(chǎn)者Handler新增方法之后,服務(wù)消費者也要在FeignClient接口中添加方法,這樣的話,會有些累贅.

那么能不能在調(diào)用服務(wù)提供者方法的時候,傳入生產(chǎn)者服務(wù)名稱的動態(tài)生成FeignClient對象,然后通過一個通用的方法,指定Handler的URL以及參數(shù)就可以調(diào)用到指定的方法呢?

當(dāng)然可以!

2.動態(tài)Feign

2.1.服務(wù)生產(chǎn)者

由于微服務(wù)項目創(chuàng)建過程并不是重點,所以后續(xù)只展示關(guān)鍵的代碼.

Handler方法

@RestController
public class OrderController {
    // 模擬數(shù)據(jù)庫存儲數(shù)據(jù)
    private static Map<String, Object> maps = new HashMap<>(10);
    static {
        maps.put("1", "筆記本");
    }
    @GetMapping(value = "/getOrderById/{oId}")
    public Object getOrderById(@PathVariable(name = "oId") String oid) {
        return maps.get(oid);
    }
    @PostMapping(value = "/addOrder")
    public boolean addOrder(@RequestBody Map<String, String> orderMap) {
        try {
            maps.putAll(orderMap);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }
}

2.2.動態(tài)Feign

為了方便在多個服務(wù)消費者模塊中使用動態(tài)Feign的功能,可以將動態(tài)Feign相關(guān)的功能單獨抽取出來作為一個公共的模塊,之后在服務(wù)消費者模塊中直接依賴該公共模塊即可.

①.pom.xml

<dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
    </dependencies>

②.通用方法

/**
 * Description: 通用接口,里面定義通用方法
 *  注意: 由于服務(wù)生產(chǎn)者所有的接口的返回值都是json格式的字符串,
 *         所以這里的通用接口的返回值最好使用String類型!!!
 */
public interface DynamicService {
    /**
     * post方法對應(yīng)的方法
     * @param url 服務(wù)生產(chǎn)者Handler方法請求映射地址
     * @param params 服務(wù)生產(chǎn)者Handler方法參數(shù)
     * @return
     */
    @PostMapping(value = "{url}")
    String executePostRequest(@PathVariable("url") String url, @RequestBody Object params);
    @GetMapping(value = "{url}")
    String executeGetRequest(@PathVariable("url") String url, @SpringQueryMap Object params);
    @PutMapping(value = "{url}")
    String executePutRequest(@PathVariable("url") String url, @RequestBody Object params);
    @DeleteMapping(value = "{url}")
    String executeDeleteRequest(@PathVariable("url") String url, @RequestBody Object params);
}

②.Feign工廠類

/**
 * Description: FeignClient工廠類,根據(jù)服務(wù)名稱創(chuàng)建FeignClient對象(代理對象)
 */
@Component
public class DynamicFeignClientFactory <T>{
    private FeignClientBuilder feignClientBuilder;
    public DynamicFeignClientFactory(ApplicationContext applicationContext){
        this.feignClientBuilder = new FeignClientBuilder(applicationContext);
    }
    //動態(tài)生成feignClient對象(代理對象)
    public T getFeignClient(final Class<T> type,String ServiceID){
        return this.feignClientBuilder.forType(type,ServiceID).build();
    }
}

③.動態(tài)FeignClient類

/**
 * Description: 通過FeignClient工廠獲取到的FeignClient對象通過指定的請求去調(diào)用生產(chǎn)者方法!
 */
@Component
public class DynamicClient {
    @Autowired
    private DynamicFeignClientFactory<DynamicService> dynamicDynamicFeignClientFactory;
    public Object executePostApi(String feignName,String url,Object params){
        DynamicService dynamicService = dynamicDynamicFeignClientFactory.getFeignClient(DynamicService.class,feignName);
        return dynamicService.executePostRequest(url,params);
    }
    public Object executeGetApi(String feignName,String url,Object params){
        DynamicService dynamicService = dynamicDynamicFeignClientFactory.getFeignClient(DynamicService.class,feignName);
        return dynamicService.executeGetRequest(url, params);
    }
    //省略了兩個方法...
}

動態(tài)Feign一旦定義好之后,不管后續(xù)服務(wù)生產(chǎn)者中添加加多少Handler方法,這里的代碼基本上不需要修改,對于服務(wù)消費者來說也不會產(chǎn)生任何影響(有點類似于設(shè)計模式里面的"開閉原則");

2.3.服務(wù)消費者

①.引入動態(tài)Feign模塊

<dependency>
            <groupId>com.xp</groupId>
            <artifactId>dynamic-feign</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>

②.Handler接口

@RestController
public class UserController {
    //注入動態(tài)FeignClient對象
    @Autowired
    private DynamicClient dynamicClient;
    @GetMapping(value = "/getorder/{oid}")
    public Object getOrderById(@PathVariable(value = "oid") String oid) {
        //通過動態(tài)FeignClient,指定服務(wù)名稱,Handler方法URL,參數(shù)等信息即可調(diào)用生產(chǎn)者對應(yīng)的方法
        return this.dynamicClient.executeGetApi("cloud-order", "/getOrderById/".concat(oid),new HashMap<>());
    }
    @PostMapping(value = "/addOrder")
    public Object addOrder(@RequestBody Map<String,Object> map){
        return this.dynamicClient.executePostApi("cloud-order", "/addOrder", map);
    }
}

③.啟動類

@SpringBootApplication
@EnableDiscoveryClient   //服務(wù)治理
@EnableFeignClients //開啟Feign功能(不寫也可以!)
public class UserApplication {
    public static void main(String[] args) {
        SpringApplication.run(UserApplication.class,args);
    }
}

代碼完成之后,啟動相關(guān)的服務(wù),就可以進行測試