前面介紹了Spring Cloud 中的靈魂擺渡者Nacos,和它的前輩們相比不僅僅功能強(qiáng)大,而且部署非常簡單。
今天介紹一款服務(wù)調(diào)用的組件:OpenFeign,同樣是一款超越先輩(Ribbon、Feign)的狠角色。
文章目錄如下:
圖片
Feign也是一個狠角色,F(xiàn)eign旨在使得Java Http客戶端變得更容易。
Feign集成了Ribbon、RestTemplate實現(xiàn)了負(fù)載均衡的執(zhí)行Http調(diào)用,只不過對原有的方式(Ribbon+RestTemplate)進(jìn)行了封裝,開發(fā)者不必手動使用RestTemplate調(diào)服務(wù),而是定義一個接口,在這個接口中標(biāo)注一個注解即可完成服務(wù)調(diào)用,這樣更加符合面向接口編程的宗旨,簡化了開發(fā)。
圖片
但遺憾的是Feign現(xiàn)在停止迭代了,當(dāng)然現(xiàn)在也是有不少企業(yè)在用。
有想要學(xué)習(xí)Feign的讀者可以上spring Cloud官網(wǎng)學(xué)習(xí),陳某這里也不再詳細(xì)介紹了,不是今天的重點。
前面介紹過停止迭代的Feign,簡單點來說:OpenFeign是springcloud在Feign的基礎(chǔ)上支持了SpringMVC的注解,如@RequestMapping等等。OpenFeign的@FeignClient可以解析SpringMVC的@RequestMapping注解下的接口,并通過動態(tài)代理的方式產(chǎn)生實現(xiàn)類,實現(xiàn)類中做負(fù)載均衡并調(diào)用其他服務(wù)。
官網(wǎng)地址:https://docs.spring.io/spring-cloud-openfeign/docs/2.2.10.BUILD-SNAPSHOT/reference/html
Feign | openFiegn |
Feign是SpringCloud組件中一個輕量級RESTful的HTTP服務(wù)客戶端,F(xiàn)eign內(nèi)置了Ribbon,用來做客戶端負(fù)載均衡,去調(diào)用服務(wù)注冊中心的服務(wù)。Feign的使用方式是:使用Feign的注解定義接口,調(diào)用這個接口,就可以調(diào)用服務(wù)注冊中心的服務(wù) | OpenFeign 是SpringCloud在Feign的基礎(chǔ)上支持了SpringMVC的注解,如@RequestMapping等。OpenFeign 的@FeignClient可以解析SpringMVC的@RequestMapping注解下的接口,并通過動態(tài)代理的方式產(chǎn)生實現(xiàn)類,實現(xiàn)類中做負(fù)載均衡并調(diào)用其他服務(wù)。 |
本篇文章Spring Cloud版本、JDK環(huán)境、項目環(huán)境均和上一篇Nacos的環(huán)境相同:五十五張圖告訴你微服務(wù)的靈魂擺渡者Nacos究竟有多強(qiáng)?。
注冊中心就不再使用Eureka了,直接使用Nacos作為注冊和配置中心,有不會的可以查看Nacos文章。
本篇文章搭建的項目結(jié)構(gòu)如下圖:
圖片
注冊中心使用Nacos,創(chuàng)建個微服務(wù),分別為服務(wù)提供者Produce,服務(wù)消費者Consumer。
既然是微服務(wù)之間的相互調(diào)用,那么一定會有服務(wù)提供者了,創(chuàng)建openFeign-provider9005,注冊進(jìn)入Nacos中,配置如下:
server: port: 9005spring: application: ## 指定服務(wù)名稱,在nacos中的名字 name: openFeign-provider cloud: nacos: discovery: # nacos的服務(wù)地址,nacos-server中IP地址:端口號 server-addr: 127.0.0.1:8848management: endpoints: web: exposure: ## yml文件中存在特殊字符,必須用單引號包含,否則啟動報錯 include: '*'
注意:此處的spring.application.name指定的名稱將會在openFeign接口調(diào)用中使用。
項目源碼都會上傳,關(guān)于如何注冊進(jìn)入Nacos,添加什么依賴源碼都會有,結(jié)合陳某上篇Nacos文章,這都不是難事!
新建一個模塊openFeign-consumer9006作為消費者服務(wù),步驟如下。
除了Nacos的注冊中心的依賴,還要添加openFeign的依賴,如下:
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId></dependency>
老套路了,在Spring boot 主啟動類上添加一個注解@EnableFeignClients,開啟openFeign功能,如下:
@SpringBootApplication@EnableDiscoveryClient@EnableFeignClientspublic class OpenFeignConsumer9006Application{ public static void main(String[] args) { SpringApplication.run(OpenFeignConsumer9006Application.class, args); }}
新建一個openFeign接口,使用@FeignClient注解標(biāo)注,如下:
@FeignClient(value = "openFeign-provider")public interface OpenFeignService {}
注意:該注解@FeignClient中的value屬性指定了服務(wù)提供者在nacos注冊中心的服務(wù)名。
新建一個controller用來調(diào)試接口,直接調(diào)用openFeign的接口,如下:
@RestController@RequestMapping("/openfeign")public class OpenFeignController { }
好了,至此一個openFeign的微服務(wù)就搭建好了,并未實現(xiàn)具體的功能,下面一點點實現(xiàn)。
開發(fā)中接口傳參的方式有很多,但是在openFeign中的傳參是有一定規(guī)則的,下面詳細(xì)介紹。
這個也是接口開發(fā)中常用的傳參規(guī)則,在Spring Boot 中通過@RequestBody標(biāo)識入?yún)ⅰ?span style="display:none">smp28資訊網(wǎng)——每日最新資訊28at.com
provider接口中JSON傳參方法如下:
@RestController@RequestMapping("/openfeign/provider")public class OpenFeignProviderController { @PostMapping("/order2") public Order createOrder2(@RequestBody Order order){ return order; }}
consumer中openFeign接口中傳參代碼如下:
@FeignClient(value = "openFeign-provider")public interface OpenFeignService { /** * 參數(shù)默認(rèn)是@RequestBody標(biāo)注的,這里的@RequestBody可以不填 * 方法名稱任意 */ @PostMapping("/openfeign/provider/order2") Order createOrder2(@RequestBody Order order);}
注意:openFeign默認(rèn)的傳參方式就是JSON傳參(@RequestBody),因此定義接口的時候可以不用@RequestBody注解標(biāo)注,不過為了規(guī)范,一般都填上。
這種傳參方式也是比較常用,參數(shù)使用POJO對象接收。
provider服務(wù)提供者代碼如下:
@RestController@RequestMapping("/openfeign/provider")public class OpenFeignProviderController { @PostMapping("/order1") public Order createOrder1(Order order){ return order; }}
consumer消費者openFeign代碼如下:
@FeignClient(value = "openFeign-provider")public interface OpenFeignService { /** * 參數(shù)默認(rèn)是@RequestBody標(biāo)注的,如果通過POJO表單傳參的,使用@SpringQueryMap標(biāo)注 */ @PostMapping("/openfeign/provider/order1") Order createOrder1(@SpringQueryMap Order order);}
網(wǎng)上很多人疑惑POJO表單方式如何傳參,官方文檔明確給出了解決方案,如下:
圖片
openFeign提供了一個注解@SpringQueryMap完美解決POJO表單傳參。
此種方式針對restful方式中的GET請求,也是比較常用請求方式。
provider服務(wù)提供者代碼如下:
@RestController@RequestMapping("/openfeign/provider")public class OpenFeignProviderController { @GetMapping("/test/{id}") public String test(@PathVariable("id")Integer id){ return "accept one msg id="+id;}
consumer消費者openFeign接口如下:
@FeignClient(value = "openFeign-provider")public interface OpenFeignService { @GetMapping("/openfeign/provider/test/{id}") String get(@PathVariable("id")Integer id);}
使用注解@PathVariable接收url中的占位符,這種方式很好理解。
此種方式傳參不建議使用,但是也有很多開發(fā)在用。
provider服務(wù)提供者代碼如下:
@RestController@RequestMapping("/openfeign/provider")public class OpenFeignProviderController { @PostMapping("/test2") public String test2(String id,String name){ return MessageFormat.format("accept on msg id={0},name={1}",id,name); }}
consumer消費者openFeign接口傳參如下:
@FeignClient(value = "openFeign-provider")public interface OpenFeignService { /** * 必須要@RequestParam注解標(biāo)注,且value屬性必須填上參數(shù)名 * 方法參數(shù)名可以任意,但是@RequestParam注解中的value屬性必須和provider中的參數(shù)名相同 */ @PostMapping("/openfeign/provider/test2") String test(@RequestParam("id") String arg1,@RequestParam("name") String arg2);}
傳參的方式有很多,比如文件傳參.....陳某這里只是列舉了四種常見得傳參方式。
想要理解超時處理,先看一個例子:我將provider服務(wù)接口睡眠3秒鐘,接口如下:
@PostMapping("/test2")public String test2(String id,String name) throws InterruptedException { Thread.sleep(3000); return MessageFormat.format("accept on msg id={0},name={1}",id,name);}
此時,我們調(diào)用consumer的openFeign接口返回結(jié)果如下圖:
圖片
很明顯的看出程序異常了,返回了接口調(diào)用超時。what?why?...........
openFeign其實是有默認(rèn)的超時時間的,默認(rèn)分別是連接超時時間10秒、讀超時時間60秒,源碼在feign.Request.Options#Options()這個方法中,如下圖:
圖片
那么問題來了:為什么我只設(shè)置了睡眠3秒就報超時呢?
其實openFeign集成了Ribbon,Ribbon的默認(rèn)超時連接時間、讀超時時間都是是1秒,源碼在org.springframework.cloud.openfeign.ribbon.FeignLoadBalancer#execute()方法中,如下圖:
圖片
源碼大致意思:如果openFeign沒有設(shè)置對應(yīng)得超時時間,那么將會采用Ribbon的默認(rèn)超時時間。
理解了超時設(shè)置的原理,由之產(chǎn)生兩種方案也是很明了了,如下:
設(shè)置很簡單,在配置文件中添加如下設(shè)置:
ribbon: # 值的是建立鏈接所用的時間,適用于網(wǎng)絡(luò)狀況正常的情況下, 兩端鏈接所用的時間 ReadTimeout: 5000 # 指的是建立鏈接后從服務(wù)器讀取可用資源所用的時間 ConectTimeout: 5000
openFeign設(shè)置超時時間非常簡單,只需要在配置文件中配置,如下:
feign: client: config: ## default 設(shè)置的全局超時時間,指定服務(wù)名稱可以設(shè)置單個服務(wù)的超時時間 default: connectTimeout: 5000 readTimeout: 5000
default設(shè)置的是全局超時時間,對所有的openFeign接口服務(wù)都生效
但是正常的業(yè)務(wù)邏輯中可能涉及到多個openFeign接口的調(diào)用,如下圖:
圖片
上圖中的偽代碼如下:
public T invoke(){ //1. 調(diào)用serviceA serviceA(); //2. 調(diào)用serviceA serviceB(); //3. 調(diào)用serviceA serviceC();}
那么上面配置的全局超時時間能不能通過呢?很顯然是serviceA、serviceB能夠成功調(diào)用,但是serviceC并不能成功執(zhí)行,肯定報超時。
此時我們可以給serviceC這個服務(wù)單獨配置一個超時時間,配置如下:
feign: client: config: ## default 設(shè)置的全局超時時間,指定服務(wù)名稱可以設(shè)置單個服務(wù)的超時時間 default: connectTimeout: 5000 readTimeout: 5000 ## 為serviceC這個服務(wù)單獨配置超時時間 serviceC: connectTimeout: 30000 readTimeout: 30000
注意:單個配置的超時時間將會覆蓋全局配置。
openFeign雖然提供了日志增強(qiáng)功能,但是默認(rèn)是不顯示任何日志的,不過開發(fā)者在調(diào)試階段可以自己配置日志的級別。
openFeign的日志級別如下:
配置起來也很簡單,步驟如下:
需要自定義一個配置類,在其中設(shè)置日志級別,如下:
注意:這里的logger是feign包里的。
只需要在配置文件中調(diào)整指定包或者openFeign的接口日志級別,如下:
logging: level: cn.myjszl.service: debug
這里的cn.myjszl.service是openFeign接口所在的包名,當(dāng)然你也可以配置一個特定的openFeign接口。
上述步驟將日志設(shè)置成了FULL,此時發(fā)出請求,日志效果如下圖:
日志中詳細(xì)的打印出了請求頭、請求體的內(nèi)容。
Feign在默認(rèn)情況下使用的是JDK原生的URLConnection發(fā)送HTTP請求,沒有連接池,但是對每個地址會保持一個長連接,即利用HTTP的persistence connection。
在生產(chǎn)環(huán)境中,通常不使用默認(rèn)的http client,通常有如下兩種選擇:
至于哪個更好,其實各有千秋,我比較傾向于ApacheHttpClient,畢竟老牌子了,穩(wěn)定性不在話下。
那么如何替換掉呢?其實很簡單,下面演示使用ApacheHttpClient替換。
在openFeign接口服務(wù)的pom文件添加如下依賴:
<!-- 使用Apache HttpClient替換Feign原生httpclient--> <dependency> <groupId>org.apache.httpcomponents</groupId> <artifactId>httpclient</artifactId> </dependency> <dependency> <groupId>io.github.openfeign</groupId> <artifactId>feign-httpclient</artifactId> </dependency>
為什么要添加上面的依賴呢?從源碼中不難看出,請看org.springframework.cloud.openfeign.FeignAutoConfiguration.HttpClientFeignConfiguration這個類,代碼如下:
上述紅色框中的生成條件,其中的@ConditionalOnClass(ApacheHttpClient.class),必須要有ApacheHttpClient這個類才會生效,并且feign.httpclient.enabled這個配置要設(shè)置為true。
在配置文件中要配置開啟,代碼如下:
feign: client: httpclient: # 開啟 Http Client enabled: true
其實很簡單,在feign.SynchronousMethodHandler#executeAndDecode()這個方法中可以清楚的看出調(diào)用哪個client,如下圖:
上圖中可以看到最終調(diào)用的是ApacheHttpClient。
上述步驟僅僅演示一種替換方案,剩下的一種不再演示了,原理相同。
在講如何優(yōu)化之前先來看一下GZIP 壓縮算法,概念如下:
gzip是一種數(shù)據(jù)格式,采用用deflate算法壓縮數(shù)據(jù);gzip是一種流行的數(shù)據(jù)壓縮算法,應(yīng)用十分廣泛,尤其是在Linux平臺。
當(dāng)GZIP壓縮到一個純文本數(shù)據(jù)時,效果是非常明顯的,大約可以減少70%以上的數(shù)據(jù)大小。
網(wǎng)絡(luò)數(shù)據(jù)經(jīng)過壓縮后實際上降低了網(wǎng)絡(luò)傳輸?shù)淖止?jié)數(shù),最明顯的好處就是可以加快網(wǎng)頁加載的速度。網(wǎng)頁加載速度加快的好處不言而喻,除了節(jié)省流量,改善用戶的瀏覽體驗外,另一個潛在的好處是GZIP與搜索引擎的抓取工具有著更好的關(guān)系。例如 Google就可以通過直接讀取GZIP文件來比普通手工抓取更快地檢索網(wǎng)頁。
GZIP壓縮傳輸?shù)脑砣缦聢D:
按照上圖拆解出的步驟如下:
openFeign支持請求/響應(yīng)開啟GZIP壓縮,整體的流程如下圖:
上圖中涉及到GZIP傳輸?shù)闹挥袃蓧K,分別是Application client -> Application Service、 Application Service->Application client。
注意:openFeign支持的GZIP僅僅是在openFeign接口的請求和響應(yīng),即是openFeign消費者調(diào)用服務(wù)提供者的接口。
openFeign開啟GZIP步驟也是很簡單,只需要在配置文件中開啟如下配置:
feign: ## 開啟壓縮 compression: request: enabled: true ## 開啟壓縮的閾值,單位字節(jié),默認(rèn)2048,即是2k,這里為了演示效果設(shè)置成10字節(jié) min-request-size: 10 mime-types: text/xml,application/xml,application/json response: enabled: true
上述配置完成之后,發(fā)出請求,可以清楚看到請求頭中已經(jīng)攜帶了GZIP壓縮,如下圖:
常見的熔斷降級框架有Hystrix、Sentinel,openFeign默認(rèn)支持的就是Hystrix,這個在官方文檔上就有體現(xiàn),畢竟是一奶同胞嘛,哈哈...........
但是阿里的Sentinel無論是功能特性、簡單易上手等各方面都完全秒殺Hystrix,因此此章節(jié)就使用openFeign+Sentinel進(jìn)行整合實現(xiàn)服務(wù)降級。
說明:此處并不著重介紹Sentinel,陳某打算放在下一篇文章詳細(xì)介紹Sentinel的強(qiáng)大之處。
在openFeign-consumer9006消費者的pom文件添加sentinel依賴(由于使用了聚合模塊,不指定版本號),如下:
<dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId></dependency>
要想openFeign使用sentinel的降級功能,還需要在配置文件中開啟,添加如下配置:
feign: sentinel: enabled: true
這個類一定要和openFeign接口實現(xiàn)同一個類,如下圖:
OpenFeignFallbackService這個是降級回調(diào)的類,一旦OpenFeignService中對應(yīng)得接口出現(xiàn)了異常則會調(diào)用這個類中對應(yīng)得方法進(jìn)行降級處理。
在@FeignClient中添加fallback屬性,屬性值是降級回調(diào)的類,如下:
@FeignClient(value = "openFeign-provider",fallback = OpenFeignFallbackService.class)public interface OpenFeignService {}
經(jīng)過如上4個步驟,openFeign的熔斷降級已經(jīng)設(shè)置完成了,此時演示下效果。
通過postman調(diào)用http://localhost:9006/openfeign/order3這個接口,正常邏輯返回如下圖:
現(xiàn)在手動造個異常,在服務(wù)提供的接口中拋出異常,如下圖:
此時重新調(diào)用http://localhost:9006/openfeign/order3,返回如下圖:
哦豁,可以很清楚的看到服務(wù)已經(jīng)成功降級調(diào)用,哦了,功能完成。
注意:實際開發(fā)中返回結(jié)果應(yīng)該根據(jù)架構(gòu)統(tǒng)一定制,陳某這里只是為了演示方便,不要借鑒,哈哈。。。
本文鏈接:http://www.tebozhan.com/showinfo-26-76562-0.htmlOpenFeign奪命連環(huán)九問
聲明:本網(wǎng)頁內(nèi)容旨在傳播知識,若有侵權(quán)等問題請及時與本網(wǎng)聯(lián)系,我們將在第一時間刪除處理。郵件:2376512515@qq.com
上一篇: Spring事件如何異步執(zhí)行?