Java微服務(wù)之Feign遠(yuǎn)程調(diào)用方式
1.Feign替代RestTemplate
Fegin的使用步驟如下:
1)引入依賴
我們?cè)趏rder-service服務(wù)的pom文件中引入feign的依賴:
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency>
2)添加注解
在order-service的啟動(dòng)類添加注解開(kāi)啟Feign的功能:
package cn.itcast.order; import com.netflix.loadbalancer.IRule; import com.netflix.loadbalancer.RandomRule; import org.mybatis.spring.annotation.MapperScan; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.client.loadbalancer.LoadBalanced; import org.springframework.cloud.openfeign.EnableFeignClients; import org.springframework.context.annotation.Bean; import org.springframework.web.client.RestTemplate; @MapperScan("cn.itcast.order.mapper") @SpringBootApplication @EnableFeignClients public class OrderApplication { public static void main(String[] args) { SpringApplication.run(OrderApplication.class, args); } /* * 創(chuàng)建RestTemplate并注入Spring容器 * */ @Bean @LoadBalanced public RestTemplate restTemplate() { return new RestTemplate(); }
3)編寫(xiě)Feign的客戶端
在order-service中新建一個(gè)接口,內(nèi)容如下:
package cn.itcast.order.client; import cn.itcast.order.pojo.User; import org.springframework.cloud.openfeign.FeignClient; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; @FeignClient("userservice") public interface UserClient { @GetMapping("/user/{id}") User findById(@PathVariable("id") Long id); }
這個(gè)客戶端主要是基于SpringMVC的注解來(lái)聲明遠(yuǎn)程調(diào)用的信息,比如:
- 服務(wù)名稱:userservice
- 請(qǐng)求方式:GET
- 請(qǐng)求路徑:/user/{id}
- 請(qǐng)求參數(shù):Long id
- 返回值類型:User
這樣,F(xiàn)eign就可以幫助我們發(fā)送http請(qǐng)求,無(wú)需自己使用RestTemplate來(lái)發(fā)送了。
4)測(cè)試
修改order-service中的OrderService類中的queryOrderById方法,使用Feign客戶端代替RestTemplate:
@Autowired private UserClient userClient; public Order queryOrderById(Long orderId) { // 1.查詢訂單 Order order = orderMapper.findById(orderId); // 2.查詢用戶 User user = userClient.findById(order.getUserId()); // 3.封裝user信息 order.setUser(user); // 4.返回 return order; }
5)總結(jié)
使用Feign的步驟:
① 引入依賴
② 添加@EnableFeignClients注解
③ 編寫(xiě)FeignClient接口
④ 使用FeignClient中定義的方法代替RestTemplate
2.自定義配置
Feign可以支持很多的自定義配置,如下表所示:
類型 | 作用 | 說(shuō)明 |
---|---|---|
feign.Logger.Level | 修改日志級(jí)別 | 包含四種不同的級(jí)別:NONE、BASIC、HEADERS、FULL |
feign.codec.Decoder | 響應(yīng)結(jié)果的解析器 | http遠(yuǎn)程調(diào)用的結(jié)果做解析,例如解析json字符串為java對(duì)象 |
feign.codec.Encoder | 請(qǐng)求參數(shù)編碼 | 將請(qǐng)求參數(shù)編碼,便于通過(guò)http請(qǐng)求發(fā)送 |
feign. Contract | 支持的注解格式 | 默認(rèn)是SpringMVC的注解 |
feign. Retryer | 失敗重試機(jī)制 | 請(qǐng)求失敗的重試機(jī)制,默認(rèn)是沒(méi)有,不過(guò)會(huì)使用Ribbon的重試 |
一般情況下,默認(rèn)值就能滿足我們使用,如果要自定義時(shí),只需要?jiǎng)?chuàng)建自定義的@Bean覆蓋默認(rèn)Bean即可。
下面以日志為例來(lái)演示如何自定義配置。
2.1.配置文件方式
基于配置文件修改feign的日志級(jí)別可以針對(duì)單個(gè)服務(wù):
feign: client: config: userservice: # 針對(duì)某個(gè)微服務(wù)的配置 loggerLevel: FULL # 日志級(jí)別
也可以針對(duì)所有服務(wù):
feign: client: config: default: # 這里用default就是全局配置,如果是寫(xiě)服務(wù)名稱,則是針對(duì)某個(gè)微服務(wù)的配置 loggerLevel: FULL # 日志級(jí)別
而日志的級(jí)別分為四種:
- NONE:不記錄任何日志信息,這是默認(rèn)值。
- BASIC:僅記錄請(qǐng)求的方法,URL以及響應(yīng)狀態(tài)碼和執(zhí)行時(shí)間
- HEADERS:在BASIC的基礎(chǔ)上,額外記錄了請(qǐng)求和響應(yīng)的頭信息
- FULL:記錄所有請(qǐng)求和響應(yīng)的明細(xì),包括頭信息、請(qǐng)求體、元數(shù)據(jù)。
2.2.Java代碼方式
也可以基于Java代碼來(lái)修改日志級(jí)別,先聲明一個(gè)類,然后聲明一個(gè)Logger.Level的對(duì)象:
public class DefaultFeignConfiguration { @Bean public Logger.Level feignLogLevel(){ return Logger.Level.BASIC; // 日志級(jí)別為BASIC } }
如果要全局生效,將其放到啟動(dòng)類的@EnableFeignClients這個(gè)注解中:
@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)
如果是局部生效,則把它放到對(duì)應(yīng)的@FeignClient這個(gè)注解中:
@FeignClient(value = "userservice", configuration = DefaultFeignConfiguration .class)
3.Feign使用優(yōu)化
Feign底層發(fā)起http請(qǐng)求,依賴于其它的框架。其底層客戶端實(shí)現(xiàn)包括:
- URLConnection:默認(rèn)實(shí)現(xiàn),不支持連接池
- Apache HttpClient :支持連接池
- OKHttp:支持連接池
因此提高Feign的性能主要手段就是使用連接池代替默認(rèn)的URLConnection。
這里我們用Apache的HttpClient來(lái)演示。
1)引入依賴
在order-service的pom文件中引入Apache的HttpClient依賴:
<!--httpClient的依賴 --> <dependency> <groupId>io.github.openfeign</groupId> <artifactId>feign-httpclient</artifactId> </dependency>
2)配置連接池
在order-service的application.yml中添加配置:
feign: client: config: default: # default全局的配置 loggerLevel: BASIC # 日志級(jí)別,BASIC就是基本的請(qǐng)求和響應(yīng)信息 httpclient: enabled: true # 開(kāi)啟feign對(duì)HttpClient的支持 max-connections: 200 # 最大的連接數(shù) max-connections-per-route: 50 # 每個(gè)路徑的最大連接數(shù)
接下來(lái),在FeignClientFactoryBean中的loadBalance方法中打斷點(diǎn):
總結(jié),F(xiàn)eign的優(yōu)化:
1.日志級(jí)別盡量用basic
2.使用HttpClient或OKHttp代替URLConnection
① 引入feign-httpClient依賴
② 配置文件開(kāi)啟httpClient功能,設(shè)置連接池參數(shù)
4.最佳實(shí)踐
4.1.繼承方式
一樣的代碼可以通過(guò)繼承來(lái)共享:
1)定義一個(gè)API接口,利用定義方法,并基于SpringMVC注解做聲明。
2)Feign客戶端和Controller都集成改接口
優(yōu)點(diǎn):
- 簡(jiǎn)單
- 實(shí)現(xiàn)了代碼共享
缺點(diǎn):
- 服務(wù)提供方、服務(wù)消費(fèi)方緊耦合
- 參數(shù)列表中的注解映射并不會(huì)繼承,因此Controller中必須再次聲明方法、參數(shù)列表、注解
4.2.抽取方式
將Feign的Client抽取為獨(dú)立模塊,并且把接口有關(guān)的POJO、默認(rèn)的Feign配置都放到這個(gè)模塊中,提供給所有消費(fèi)者使用。
例如,將UserClient、User、Feign的默認(rèn)配置都抽取到一個(gè)feign-api包中,所有微服務(wù)引用該依賴包,即可直接使用。
4.3.實(shí)現(xiàn)基于抽取的最佳實(shí)踐
1)抽取
首先創(chuàng)建一個(gè)module,命名為feign-api:
在feign-api中然后引入feign的starter依賴
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency>
然后,order-service中編寫(xiě)的UserClient、User、DefaultFeignConfiguration都復(fù)制到feign-api項(xiàng)目中
2)在order-service中使用feign-api
首先,刪除order-service中的UserClient、User、DefaultFeignConfiguration等類或接口。
在order-service的pom文件中中引入feign-api的依賴:
<dependency> <groupId>cn.itcast.demo</groupId> <artifactId>feign-api</artifactId> <version>1.0</version> </dependency>
修改order-service中的所有與上述三個(gè)組件有關(guān)的導(dǎo)包部分,改成導(dǎo)入feign-api中的包
3)重啟測(cè)試
重啟后,發(fā)現(xiàn)服務(wù)報(bào)錯(cuò)了:
這是因?yàn)閁serClient現(xiàn)在在cn.itcast.feign.clients包下,
而order-service的@EnableFeignClients注解是在cn.itcast.order包下,不在同一個(gè)包,無(wú)法掃描到UserClient。
4)解決掃描包問(wèn)題
方式一:
指定Feign應(yīng)該掃描的包:
@EnableFeignClients(basePackages = "cn.itcast.feign.clients")
方式二:
指定需要加載的Client接口:
@EnableFeignClients(clients = {UserClient.class})
總結(jié)
以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
相關(guān)文章
SpringBoot+Quartz實(shí)現(xiàn)定時(shí)任務(wù)的代碼模版分享
quartz?是一款開(kāi)源且豐富特性的Java?任務(wù)調(diào)度庫(kù),用于實(shí)現(xiàn)任務(wù)調(diào)度和定時(shí)任務(wù),本文主要和大家分享一個(gè)SpringBoot整合Quartz實(shí)現(xiàn)定時(shí)任務(wù)的代碼模版,需要的可以參考一下2023-06-06MyBatis CodeHelperPro激活方法詳細(xì)教程
MyBatisCodeHelper-Pro是IDEA下的一個(gè)插件,功能類似mybatis plugin,今天小編給大家分享MyBatis CodeHelperPro激活方法,需要的朋友跟隨小編一起看看吧2021-07-07全排列算法-遞歸與字典序的實(shí)現(xiàn)方法(Java)
下面小編就為大家?guī)?lái)一篇全排列算法-遞歸與字典序的實(shí)現(xiàn)方法(Java) 。小編覺(jué)得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-04-04Java實(shí)戰(zhàn)網(wǎng)上電子書(shū)城的實(shí)現(xiàn)流程
讀萬(wàn)卷書(shū)不如行萬(wàn)里路,只學(xué)書(shū)上的理論是遠(yuǎn)遠(yuǎn)不夠的,只有在實(shí)戰(zhàn)中才能獲得能力的提升,本篇文章手把手帶你用java+SSM+JSP+maven+Mysql實(shí)現(xiàn)一個(gè)網(wǎng)上電子書(shū)城,大家可以在過(guò)程中查缺補(bǔ)漏,提升水平2022-01-01SpringBoot+Vue中的Token續(xù)簽機(jī)制
本文主要介紹了SpringBoot+Vue中的Token續(xù)簽機(jī)制,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2024-06-06劍指Offer之Java算法習(xí)題精講二叉搜索樹(shù)與數(shù)組查找
跟著思路走,之后從簡(jiǎn)單題入手,反復(fù)去看,做過(guò)之后可能會(huì)忘記,之后再做一次,記不住就反復(fù)做,反復(fù)尋求思路和規(guī)律,慢慢積累就會(huì)發(fā)現(xiàn)質(zhì)的變化2022-03-03Java實(shí)現(xiàn)的動(dòng)態(tài)數(shù)字時(shí)鐘功能示例【顯示世界時(shí)間】
這篇文章主要介紹了Java實(shí)現(xiàn)的動(dòng)態(tài)數(shù)字時(shí)鐘功能,結(jié)合實(shí)例形式分析了java顯示北京、紐約、倫敦等世界時(shí)間的相關(guān)日期時(shí)間運(yùn)算操作技巧,需要的朋友可以參考下2019-03-03jsp+servlet實(shí)現(xiàn)簡(jiǎn)單登錄頁(yè)面功能(附demo)
本文主要介紹了jsp+servlet實(shí)現(xiàn)簡(jiǎn)單登錄頁(yè)面功能登錄成功跳轉(zhuǎn)新頁(yè)面,登錄失敗在原登錄界面提示登錄失敗信息,對(duì)初學(xué)者有一定的幫助,感興趣的可以了解一下2021-07-07