一篇文章教你如何在SpringCloud項目中使用OpenFeign

更新時間：2021年08月15日 17:17:49 作者：小小張自由—>張有博

這篇文章主要介紹了SpringCloud 使用Open feign 優(yōu)化詳解，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧

OpenFeign的介紹

OpenFeign是一種聲明式、模板化的HTTP客戶端。

何為聲明式？

就像調(diào)用本地方法一樣調(diào)用遠(yuǎn)程方法，無需感知操作遠(yuǎn)程http請求。

何為模板化？

Feign會為每一個Feign接口方法創(chuàng)建一個RequestTemplate對象，該對象封裝了HTTP請求的全部信息，F(xiàn)eign的模板化就體現(xiàn)在這里。

OpenFeign與Feign的之間的關(guān)系

OpenFeign是由Feign演變過來，平時說的Feign指的是Netflix旗下的Feign，現(xiàn)在我們使用的是 OpenFeign是Pivotal 提供的。

注：Pivotal 公司可謂是大牛云集，公司的開源產(chǎn)品有：Spring 以及 Spring 衍生產(chǎn)品、Web 服務(wù)器 Tomcat、緩存中間件 Redis、消息中間件 RabbitMQ、平臺即服務(wù)的 Cloud Foundry、Greenplum 數(shù)據(jù)引擎、還有大名鼎鼎的 GemFire（12306 系統(tǒng)解決方案組件之一）

Feign

Fegin是Spring Cloud組件中的輕量級RESTful的HTTP服務(wù)客戶端，F(xiàn)eign內(nèi)置了Ribbon，用來做客戶端負(fù)載均衡，去調(diào)用服務(wù)注冊中心的服務(wù)。Feign本身不支持Spring MVC的注解，它有一套自己的注解

OpenFeign

OpenFeign是Spring Cloud 在Feign的基礎(chǔ)上支持了Spring MVC的注解，如@RequesMapping等等。OpenFeign的@FeignClient可以解析SpringMVC的@RequestMapping注解下的接口，并通過動態(tài)代理的方式產(chǎn)生實現(xiàn)類，實現(xiàn)類中做負(fù)載均衡并調(diào)用其他服務(wù)。

springcloud F 及F版本以上 springboot 2.0 以上基本上使用openfeign，openfeign 如果從框架結(jié)構(gòu)上看就是2019年feign停更后出現(xiàn)版本，也可以說大多數(shù)新項目都用openfeign ，2018年以前的項目在使用feign

OpenFegin中的兩個常用注解

@FeignClient：

用于通知Feign組件對該接口進(jìn)行代理(不需要編寫接口實現(xiàn))，使用者可直接通過@Autowired注入。

@EnableFeignClients

Spring Cloud應(yīng)用在啟動時，F(xiàn)eign會掃描標(biāo)有@FeignClient注解的接口，生成代理，并注冊到Spring容器中。

在項目中使用OpenFeign

調(diào)用關(guān)系圖

provider是具體的業(yè)務(wù)提供者，provider-api是對應(yīng)服務(wù)抽出來的Api,供其他服務(wù)調(diào)用。假如provider-socre中需要調(diào)用中provider-vidoe的接口，須在provider-vidoe-api中暴露相應(yīng)的接口，provider-socre中引入provider-vidoe-api的依賴，直接調(diào)用。

導(dǎo)入依賴

在服務(wù)中引入OpenFegin的依賴（provider-socre與provider-vidoe-api中都需要引入）

 <!--openfeign的依賴-->
<dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-openfeign</artifactId>
      <version>2.2.1.RELEASE</version>
</dependency>

使用注解@FeignClient @EnableFeignClients

在provider-video-api中使用@FeignClient

@Component
@FeignClient(value="video")  //value值是對應(yīng)的服務(wù)名
//通過聲明式的注解,提供一個供其它服務(wù)調(diào)用的 Client。
public interface VideoBulletchatFeignApi {
    
    @GetMapping("/videoBulletchat/querySumBulletChat/{id}")
    public Wrapper querySumBulletChat(@PathVariable String id);
}

注意很重要：在video服務(wù)中需要有provider-video-api對應(yīng)的實現(xiàn)

@RestController
@Slf4j
@RequestMapping("/videoBulletchat")
public class VideoBulletchatController {
    @Resource
    private VideoBulletChatService videoBulletChatService;
    @Value("${server.port}")
    private String port;
   
    @GetMapping("querySumBulletChat/{id}")
    public Wrapper querySumBulletChat(@PathVariable String id){
        log.info("視頻id為 "+id+" 正在查詢彈幕訪問量！");
        log.info("端口號 "+port);
        return WrapMapper.wrap(Wrapper.SUCCESS_CODE,Wrapper.SUCCESS_MESSAGE,videoBulletChatService.querySumBulletChat(id));
    }
}

在provider-score中使用@EnableFeignClients

/**
 * @author 小小張自由
 */
@EnableDiscoveryClient
@EnableFeignClients
@SpringBootApplication
public class ScoreApplication {
    public static void main(String[] args) {
        SpringApplication.run(ScoreApplication.class,args);
    }
}

注入對象、調(diào)用

在provider-score中引用OpenFegin依賴的同時，還要引用provider-video-api 的依賴

@Slf4j
@Service
public class ScoreService {

    @Autowired
    //當(dāng)需要調(diào)用其他服務(wù)時，
    // 直接注入OpenFeign接口對象就可以像調(diào)用本地方法一樣調(diào)用遠(yuǎn)程服務(wù)。
    private VideoBulletchatFeignApi feignApi;

   // 測試Feign
    public int testFegin(String id) {
        log.info("開始調(diào)用Fegin");
        Wrapper Result = feignApi.querySumBulletChat(id);
        log.info("調(diào)用Fegin返回成功！");
        return (Integer) Result.getResult();
    }

}

總結(jié)：

我們在主程序入口添加@EnableFeignClients注解開啟對Feign Client掃描加載處理，根據(jù)Feign Client的開發(fā)規(guī)范，定義接口并添加@FeignClient注解。

當(dāng)程序啟動時，會進(jìn)行包掃描，掃描所有@FeignClient的注解的類，并將這些信息注入Spring IOC容器中。當(dāng)定義的Feign接口中的方法被調(diào)用時，通過JDK的代理的方式，來生成具體的RequestTemplate。當(dāng)生成代理時，F(xiàn)eign會為每個接口方法創(chuàng)建一個RequestTemplate對象，該對象封裝了HTTP請求的全部信息。如請求參數(shù)名、請求方法等信息都是在這個過程中確定的。

然后由RequestTemplate生成Request，然后把Request交給Client去處理。這里的Client可以是JDK原生的URLConnection、Apache的Http Client，也可以是OKhttp。最后Client被封裝到LoadBalanceClient類，這個類結(jié)合Ribbon負(fù)載均衡發(fā)起服務(wù)之間的調(diào)用。

本篇文章就到這里了，希望能給你帶來幫助，也希望您能夠多多關(guān)注腳本之家的更多內(nèi)容！

您可能感興趣的文章: