一篇文章教你如何在SpringCloud項(xiàng)目中使用OpenFeign
OpenFeign的介紹
OpenFeign是一種聲明式 、模板化的HTTP客戶端。
何為聲明式?
就像調(diào)用本地方法一樣調(diào)用遠(yuǎn)程方法,無(wú)需感知操作遠(yuǎn)程http請(qǐng)求。
何為模板化?
Feign會(huì)為每一個(gè)Feign接口方法創(chuàng)建一個(gè)RequestTemplate對(duì)象,該對(duì)象封裝了HTTP請(qǐng)求的全部信息,F(xiàn)eign的模板化就體現(xiàn)在這里。
OpenFeign與Feign的之間的關(guān)系
OpenFeign是由Feign演變過(guò)來(lái),平時(shí)說(shuō)的Feign指的是Netflix旗下的Feign,現(xiàn)在我們使用的是 OpenFeign是Pivotal 提供的。
注:Pivotal 公司可謂是大牛云集,公司的開源產(chǎn)品有:Spring 以及 Spring 衍生產(chǎn)品、Web 服務(wù)器 Tomcat、緩存中間件 Redis、消息中間件 RabbitMQ、平臺(tái)即服務(wù)的 Cloud Foundry、Greenplum 數(shù)據(jù)引擎、還有大名鼎鼎的 GemFire(12306 系統(tǒng)解決方案組件之一)
Feign
Fegin是Spring Cloud組件中的輕量級(jí)RESTful的HTTP服務(wù)客戶端,F(xiàn)eign內(nèi)置了Ribbon,用來(lái)做客戶端負(fù)載均衡,去調(diào)用服務(wù)注冊(cè)中心的服務(wù)。Feign本身不支持Spring MVC的注解,它有一套自己的注解
OpenFeign
OpenFeign是Spring Cloud 在Feign的基礎(chǔ)上支持了Spring MVC的注解,如@RequesMapping等等。OpenFeign的@FeignClient可以解析SpringMVC的@RequestMapping注解下的接口,并通過(guò)動(dòng)態(tài)代理的方式產(chǎn)生實(shí)現(xiàn)類,實(shí)現(xiàn)類中做負(fù)載均衡并調(diào)用其他服務(wù)。
springcloud F 及F版本以上 springboot 2.0 以上基本上使用openfeign,openfeign 如果從框架結(jié)構(gòu)上看就是2019年feign停更后出現(xiàn)版本,也可以說(shuō)大多數(shù)新項(xiàng)目都用openfeign ,2018年以前的項(xiàng)目在使用feign
OpenFegin中的兩個(gè)常用注解
@FeignClient:
用于通知Feign組件對(duì)該接口進(jìn)行代理(不需要編寫接口實(shí)現(xiàn)),使用者可直接通過(guò)@Autowired注入 。
@EnableFeignClients
Spring Cloud應(yīng)用在啟動(dòng)時(shí),F(xiàn)eign會(huì)掃描標(biāo)有@FeignClient注解的接口,生成代理,并注冊(cè)到Spring容器中。
在項(xiàng)目中使用OpenFeign
調(diào)用關(guān)系圖
provider是具體的業(yè)務(wù)提供者,provider-api是對(duì)應(yīng)服務(wù)抽出來(lái)的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值是對(duì)應(yīng)的服務(wù)名 //通過(guò)聲明式的注解,提供一個(gè)供其它服務(wù)調(diào)用的 Client。 public interface VideoBulletchatFeignApi { @GetMapping("/videoBulletchat/querySumBulletChat/{id}") public Wrapper querySumBulletChat(@PathVariable String id); }
注意很重要:在video服務(wù)中需要有provider-video-api對(duì)應(yīng)的實(shí)現(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+" 正在查詢彈幕訪問(wèn)量!"); log.info("端口號(hào) "+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); } }
注入對(duì)象、調(diào)用
在provider-score中引用OpenFegin依賴的同時(shí),還要引用provider-video-api 的依賴
@Slf4j @Service public class ScoreService { @Autowired //當(dāng)需要調(diào)用其他服務(wù)時(shí), // 直接注入OpenFeign接口對(duì)象就可以像調(diào)用本地方法一樣調(diào)用遠(yuǎn)程服務(wù)。 private VideoBulletchatFeignApi feignApi; // 測(cè)試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é):
我們?cè)谥鞒绦蛉肟谔砑覢EnableFeignClients注解開啟對(duì)Feign Client掃描加載處理,根據(jù)Feign Client的開發(fā)規(guī)范,定義接口并添加@FeignClient注解。
當(dāng)程序啟動(dòng)時(shí),會(huì)進(jìn)行包掃描,掃描所有@FeignClient的注解的類,并將這些信息注入Spring IOC容器中。當(dāng)定義的Feign接口中的方法被調(diào)用時(shí),通過(guò)JDK的代理的方式,來(lái)生成具體的RequestTemplate。當(dāng)生成代理時(shí),F(xiàn)eign會(huì)為每個(gè)接口方法創(chuàng)建一個(gè)RequestTemplate對(duì)象,該對(duì)象封裝了HTTP請(qǐng)求的全部信息。如請(qǐng)求參數(shù)名、請(qǐng)求方法等信息都是在這個(gè)過(guò)程中確定的。
然后由RequestTemplate生成Request,然后把Request交給Client去處理。這里的Client可以是JDK原生的URLConnection、Apache的Http Client,也可以是OKhttp。最后Client被封裝到LoadBalanceClient類,這個(gè)類結(jié)合Ribbon負(fù)載均衡發(fā)起服務(wù)之間的調(diào)用。
本篇文章就到這里了,希望能給你帶來(lái)幫助,也希望您能夠多多關(guān)注腳本之家的更多內(nèi)容!
- SpringCloud?OpenFeign?服務(wù)調(diào)用傳遞?token的場(chǎng)景分析
- SpringCloud OpenFeign超詳細(xì)講解模板化遠(yuǎn)程通信的實(shí)現(xiàn)
- springcloud引入spring-cloud-starter-openfeign失敗的解決
- SpringCloud升級(jí)2020.0.x版之OpenFeign簡(jiǎn)介與使用實(shí)現(xiàn)思路
- 完美解決SpringCloud-OpenFeign使用okhttp替換不生效問(wèn)題
- SpringCloud OpenFeign Post請(qǐng)求400錯(cuò)誤解決方案
- SpringCloud OpenFeign超時(shí)控制示例詳解
相關(guān)文章
Spring?Boot配置文件的語(yǔ)法規(guī)則詳解(properties和yml)
這篇文章主要介紹了Spring?Boot配置文件的語(yǔ)法規(guī)則,主要介紹兩種配置文件的語(yǔ)法和格式,properties和yml,對(duì)于配置文件也有獨(dú)立的文件夾存放,主要用來(lái)存放一些需要經(jīng)過(guò)變動(dòng)的數(shù)據(jù)(變量值),感興趣的朋友跟隨小編一起看看吧2024-07-07java設(shè)計(jì)模式之簡(jiǎn)單工廠模式詳解
這篇文章主要介紹了java設(shè)計(jì)模式之簡(jiǎn)單工廠模式的相關(guān)資料,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2017-09-09MybatisPlus實(shí)現(xiàn)insertBatchSomeColumn進(jìn)行批量增加
本文主要介紹了MybatisPlus實(shí)現(xiàn)insertBatchSomeColumn進(jìn)行批量增加,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-03-03SpringBoot如何使用RateLimiter通過(guò)AOP方式進(jìn)行限流
這篇文章主要介紹了SpringBoot如何使用RateLimiter通過(guò)AOP方式進(jìn)行限流,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-06-06一文總結(jié) Shiro 實(shí)戰(zhàn)教程
shiro是apache的一個(gè)開源框架,是一個(gè)權(quán)限管理的框架,實(shí)現(xiàn) 用戶認(rèn)證、用戶授權(quán),這篇文章詳細(xì)總結(jié)了shiro用法,感興趣的同學(xué)可以參考閱讀2023-04-04RSA加密算法java簡(jiǎn)單實(shí)現(xiàn)方法(必看)
下面小編就為大家?guī)?lái)一篇RSA加密算法java簡(jiǎn)單實(shí)現(xiàn)方法(必看)。小編覺得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2016-09-09使用javax.sound實(shí)現(xiàn)簡(jiǎn)單音頻播放
這篇文章主要為大家詳細(xì)介紹了使用javax.sound實(shí)現(xiàn)簡(jiǎn)單音頻播放,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2018-03-03idea2019.2安裝MybatisCodeHelper插件的超詳細(xì)教程
這篇文章主要介紹了idea2019.2安裝MybatisCodeHelper插件的教程,本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-09-09SpringBoot中@Autowired注入service時(shí)出現(xiàn)循環(huán)依賴問(wèn)題的解決方法
在Spring Boot開發(fā)過(guò)程中,@Autowired注入Service時(shí)出現(xiàn)循環(huán)依賴是一個(gè)常見問(wèn)題,循環(huán)依賴指的是兩個(gè)或多個(gè)Bean相互依賴,形成閉環(huán),導(dǎo)致Spring容器無(wú)法正常初始化這些Bean,這里提供幾種解決Spring Boot中@Autowired注入Service時(shí)循環(huán)依賴問(wèn)題的方法2024-02-02