SpringCloud整合OpenFeign實現(xiàn)微服務間的通信
1. 前言
1.1 為什么要使用OpenFeign?
雖說RestTemplate 對HTTP封裝后, 已經?直接使?HTTPClient簡單?便很多, 但是還存在?些問題.
- 需要拼接URL, 靈活性?, 但是封裝臃腫, URL復雜時, 容易出錯.
- 代碼可讀性差, ?格不統(tǒng)?。
1.2 介紹一下微服務之間的通信方式
微服務之間的通信?式, 通常有兩種: RPC 和 HTTP.
在SpringCloud中, 默認是使?HTTP來進?微服務的通信, 最常?的實現(xiàn)形式有兩種:
- RestTemplate
- OpenFeign
RPC(Remote Procedure Call)遠程過程調?,是?種通過?絡從遠程計算機上請求服務,?不需要了解底層?絡通信細節(jié)。RPC可以使?多種?絡協(xié)議進?通信, 如HTTP、TCP、UDP等, 并且在TCP/IP?絡四層模型中跨越了傳輸層和應?層。簡?之RPC就是像調?本地?法?樣調?遠程?法。
常?的RPC框架有:
- Dubbo: Apache Dubbo 中?
- Thrift : Apache Thrift - Home
- gRPC: gRPC
1.3 OpenFeign介紹
OpenFeign 是?個聲明式的 Web Service 客戶端. 它讓微服務之間的調?變得更簡單, 類似于controller,調?service, 只需要創(chuàng)建?個接?,然后添加注解即可使?OpenFeign。OpenFeign是一個基于Java的HTTP客戶端,它使得編寫和維護RESTful服務之間的通信變得更加簡單。通過使用注解和接口定義,開發(fā)者可以輕松地創(chuàng)建RESTful服務的客戶端,并且無需編寫大量的樣板代碼。
1.4 OpenFeign 的前?
Feign 是 Netflix 公司開源的?個組件.
- 2013年6?, Netflix發(fā)布 Feign的第?個版本 1.0.0
- 2016年7?, Netflix發(fā)布Feign的最后?個版本 8.18.0
- 2016年,Netflix 將 Feign 捐獻給社區(qū)
- 2016年7? OpenFeign 的?個版本 9.0.0 發(fā)布,之后?直持續(xù)發(fā)布到現(xiàn)在.
可以簡單理解為 Netflix Feign 是OpenFeign的祖先, 或者說OpenFeign 是Netflix Feign的升級版.
OpenFeign 是Feign的?個更強?更靈活的實現(xiàn).
2. OpenFeign的使用步驟
2.1 添加maven依賴
<!--添加openFeign 的依賴--> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency>
2.2 添加注解
在啟動類上添加注解 @EnableFeignClients ,表示開啟OpenFeign的功能,Spring Boot 將會掃描指定的包路徑下的 Feign 客戶端接口,并自動創(chuàng)建代理對象。這些代理對象可以直接調用遠程服務的 API,而無需手動編寫 HTTP 請求代碼。
@EnableEurekaServer 注解會啟動一個嵌入式的Eureka Server實例,該實例將會接受其他微服務的注冊,并且提供給其他微服務進行服務發(fā)現(xiàn)和調用。這樣可以方便地構建基于Eureka的服務注冊與發(fā)現(xiàn)系統(tǒng)。
注意:@Enable開頭的注解都表示:啟用某種特定的功能或配置。因為它們的主要作用是開啟一些特定的功能或配置選項。
2.3 編寫OpenFeign的客戶端
//聲明一個Feign客戶端,value屬性指定了要調用的服務的名稱 //value屬性指定的服務名稱去服務注冊中心尋找對應的服務,無需手動編寫HTTP請求代碼 @FeignClient(value = "product-service",path = "/product") public interface ProductApi { @RequestMapping("/product/{productId}")//指定跟哪個方法進行綁定 Product getProduct(@PathVariable Integer productId); }
@FeignClient 注解作?在接?上, 參數(shù)說明:
- name/value:指定FeignClient的名稱, 也就是微服務的名稱,?于服務發(fā)現(xiàn), Feign底層會使?
- Spring Cloud LoadBalance進?負載均衡. 也可以使? url 屬性指定?個具體的url.
- path: 定義當前FeignClient的統(tǒng)?前綴.
2.4 修改遠程調用的方法
3. OpenFeign的參數(shù)傳遞
這里介紹參數(shù)傳遞就是因為:OpenFeign接收參數(shù)使用的注解和SpringMvc不同。
傳遞簡單類型參數(shù) -> @RequestParam("參數(shù)名")
這里的注解是必須書寫的,不像mvc會根據(jù)名稱自動映射,你不寫就是null。
@RequestMapping("/p1") String p1(@RequestParam("id") Integer id); @RequestMapping("/p2") String o2(@RequestParam("id") Integer id, @RequestParam("name") String name);
傳遞JavaBean對象 -> @SpringQueryMap
傳遞Json 數(shù)據(jù) -> @RequestBody
4.最佳實踐
最佳實踐:其實也就是經過歷史的迭代, 在項?中的實踐過程中, 總結出來的最好的使用方式。
最佳實踐就是幫助我們繼續(xù)優(yōu)化代碼,我們也能看出來, Feign的客戶端與服務提供者的controller代碼非常相似。所以我們可以對其抽取一個類,需要的繼承即可?;蛘呶覀兛梢猿槿〕梢粋€jar包需要的時候導入依賴即可。
4.1 Feign 的繼承
Feign ?持繼承的方式, 我們可以把?些常?的操作封裝到接口里。我們可以定義好?個接?, 服務提供?實現(xiàn)這個接?, 服務消費?編寫Feign 接?的時候, 直接繼承這個接?。 具體參考: Spring Cloud OpenFeign Features :: Spring Cloud Openfeign 因為這種不是最優(yōu)的解法,我就不過多介紹了。
4.2 Feign 的抽取
官?推薦Feign的使??式為繼承的方式, 但是企業(yè)開發(fā)中, 更多是把Feign接?抽取為?個獨?的模塊 (做法和繼承相似, 但理念不同).
操作?法: 將Feign的Client抽取為?個獨?的模塊, 并把涉及到的實體類等都放在這個模塊中, 打成?個Jar. 服務 消費?只需要依賴該Jar包即可. 這種?式在企業(yè)中?較常?, Jar包通常由服務提供?來實現(xiàn).
實現(xiàn)步驟
1.創(chuàng)建新的模塊
2. 引入maven的依賴
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency>
3. 編寫api
@FeignClient(value = "product-service",path = "/product") public interface ProductApiInterface { @RequestMapping("/{productId}")//指定跟哪個方法進行綁定 Product getProduct(@PathVariable Integer productId); }
4.安裝到本地倉庫
5.服務消費方引入依賴并將其注入
<!--引入自定義的product的feign客戶端--> <dependency> <groupId>com.csy</groupId> <artifactId>product-api</artifactId> <version>1.0-SNAPSHOT</version> <scope>compile</scope> </dependency>
@EnableFeignClients(clients = {ProductApiInterface.class}) 在配置類,修改就會掃描,否則 SpringBoot只會掃描當前包及其子包的Bean,所以第三方Bean需要聲明在配置類,但是 Feign開發(fā)商也想到這一點了,就提供了對應的屬性。
不設置就會報下述錯誤:
你@Autowired注入了productApi這個Bean,但是我沒有找到。
結語
通過本文的介紹,我們了解了什么是OpenFeign以及如何在Spring Cloud應用中使用
OpenFeign來實現(xiàn)微服務之間的通信。OpenFeign的強大功能和Spring Cloud的深度集成使得微服
以上就是SpringCloud整合OpenFeign實現(xiàn)微服務間的通信的詳細內容,更多關于SpringCloud OpenFeign通信的資料請關注腳本之家其它相關文章!