http方法_像本地方法一样调用http服务,feign框架springboot项目实践
概述
微服務(wù)在如今后臺系統(tǒng)建設(shè)上大行其道,各子服務(wù)間接口交互方式,http請求協(xié)議又是首選。而相比遠(yuǎn)程方法調(diào)用的rmi接口形式,http服務(wù)對接口消費方會產(chǎn)生更大的接入成本。有沒有兩全其美,合二為一的方案?服務(wù)交互既滿足通用的http協(xié)議,又能減少服務(wù)消費方的接入成本。
答案揭曉,netflix公司開源的feign框架即為該問題的完美解決方案。本文將帶領(lǐng)大家,通過使用feign框架,在springboot項目中,實現(xiàn)和遠(yuǎn)程方法調(diào)用一樣的本地方法調(diào)用效果。
環(huán)境
- spring-boot 2.1.0.RELEASE
- spring-cloud Greenwich.SR2
feign框架是基于springcloud發(fā)布的,所以項目中請?zhí)砑雍蛃pringboot匹配的springcloud包。注意spring-boot 最好不低于2.1.0.RELEASE版本,因為低版本依賴的feign某些功能缺失,將損失服務(wù)client jar包發(fā)布時接口構(gòu)建靈活性。
依賴
項目中添加相關(guān)依賴
springboot依賴
springcloud依賴
openfeign依賴
項目結(jié)構(gòu)
risk-control-app:服務(wù)提供方項目模塊。
risk-control-app-client:服務(wù)提供方對外開放的client接口模塊。
risk-control-app-consume:服務(wù)消費方模塊。
接口服務(wù)定義
由于服務(wù)接口是對外開放的,并以client jar文件方式集成到使用端。
在risk-control-app-client模塊中定義,UserResource和ProdResource兩個服務(wù)。
在ProdResource接口定義服務(wù)接口。
@FeignClient是feign框架提供的注解。通過該注解定義的接口,在服務(wù)調(diào)用時框架會自動轉(zhuǎn)換為http請求,調(diào)用遠(yuǎn)程對應(yīng)服務(wù)。
name屬性:為feign客戶端唯一標(biāo)示,若微服務(wù)接入了注冊中心,name對應(yīng)服務(wù)注冊名。
contextId屬性:服務(wù)上下文標(biāo)示,有時對外開放服務(wù)可能是多個接口,不同接口可以通過該屬性加以區(qū)分。比如ProdResource和UserResource不同的資源。
注意feign老版本是沒有contextId屬性的,這意味著老版本的feign框架,服務(wù)提供方對外的接口輸出文件只能有一個,因為FeignClient注解對應(yīng)的name不能重復(fù),沒有contextId區(qū)分,FeignClient實例將無法初始化。
url屬性:定義FeignClient訪問的接口服務(wù)地址。主要用于微服務(wù)未接入注冊中心的場景。若以接入注冊中心,該屬性可以不定義。
細(xì)心的朋友可能發(fā)現(xiàn)了,demo中name和url的賦值,使用了spring屬性注入的方式,而不是直接寫死。這樣有一個好處,不同環(huán)境的FeignClient引用時,只需集成端配置文件修改相關(guān)值,無需服務(wù)提供方重新編譯打包,提高配置的靈活性。
UserResource方式和ProdResource類似,不再累述。
接口服務(wù)實現(xiàn)
接口服務(wù)實現(xiàn)在risk-control-app模塊中。引入risk-control-app-client依賴。并添加ProdController和UserController實現(xiàn)。結(jié)構(gòu)如下:
接口實現(xiàn)如下:
接口服務(wù)消費方
risk-control-app-consume模塊作為服務(wù)消費方,在項目中添加risk-control-app-client依賴,即可像調(diào)用本地方法樣調(diào)用遠(yuǎn)程http服務(wù)。
application.yml配置文件中添加遠(yuǎn)程服務(wù)設(shè)置。在服務(wù)啟動時能動態(tài)注入@FeignClient實例的name和url值。
入口Application類中添加EnableFeignClients注解,啟用Feign。basePackages值為Feign client掃描的包路徑。
業(yè)務(wù)實現(xiàn)類中直接添加服務(wù)資源組件屬性,在方法邏輯中即可像直接調(diào)用本地方法一樣,調(diào)用遠(yuǎn)程的http服務(wù)。
到此所有demo完成,是不是感覺so easy,http服務(wù)調(diào)用瞬間簡單了起來。
總結(jié)
本文介紹了Feigin框架在springboot項目中的使用。通過實例講解了,如何將http對外服務(wù)以rmi方式提供給消費端使用。定義主要步驟如下:
- 接口分模塊構(gòu)建,便于對外提供client jar文件分發(fā)。接口通過@FeignClient注解標(biāo)注。
- 基于接口實現(xiàn)服務(wù)端邏輯。
- 消費端通過接口的client jar依賴,使用具體接口服務(wù)方法。
總結(jié)
以上是生活随笔為你收集整理的http方法_像本地方法一样调用http服务,feign框架springboot项目实践的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: qtextedit改变单个字的颜色_发协
- 下一篇: jrebel热部署不起作用_5种Spri