SpringCloudRibbon與OpenFeign詳解如何實(shí)現(xiàn)服務(wù)調(diào)用

第SpringCloudRibbon與OpenFeign詳解如何實(shí)現(xiàn)服務(wù)調(diào)用目錄Ribbon初識(shí)RibbonRibbon是什么Ribbon能干什么使用Ribbon實(shí)現(xiàn)負(fù)載均衡RestTemplate三步走負(fù)載均衡算法輪詢算法OpenFeign初識(shí)OpenFeign什么是OpenFeign如何使用OpenFeignOpenFeign超時(shí)控制OpenFeign日志打印

Ribbon

初識(shí)Ribbon

Ribbon是什么

Ribbon是Netflix發(fā)布的開源項(xiàng)目，主要功能是提供對(duì)客戶端進(jìn)行負(fù)載均衡算法的一套工具，將Netflix的中間層服務(wù)連接在一起。Ribbon客戶端組件提供一系列完善的配置項(xiàng)如連接超時(shí)，重試等。簡(jiǎn)單的說，就是在配置文件中列出LoadBalancer（簡(jiǎn)稱LB）后面所有的機(jī)器，Ribbon會(huì)自動(dòng)的幫助你基于某種規(guī)則（如簡(jiǎn)單輪詢，隨即連接等）去連接這些機(jī)器。我們也可以使用Ribbon實(shí)現(xiàn)自定義的負(fù)載均衡算法。

Ribbon能干什么

前面提到說Ribbon的作用就是向客戶端提供負(fù)載均衡算法的工具，那么什么是負(fù)載均衡呢？負(fù)載均衡就是將用戶發(fā)來的請(qǐng)求通過算法均攤到多個(gè)服務(wù)上，從而達(dá)到系統(tǒng)的HA(高可用性)

其中，負(fù)載均衡又可分為本地負(fù)載均衡(進(jìn)程內(nèi)LB)和服務(wù)端負(fù)載均衡(集中式LB)，服務(wù)端負(fù)載均衡以Nginx為例，用戶的所有請(qǐng)求都會(huì)交給Nginx，由其決定請(qǐng)求將被轉(zhuǎn)發(fā)到哪個(gè)服務(wù)器；Ribbon是本地負(fù)載均衡，在調(diào)用接口的時(shí)候從eureka注冊(cè)中心服務(wù)器端上獲取服務(wù)注冊(cè)信息列表緩存到本地，從而可以在本地實(shí)現(xiàn)RPC遠(yuǎn)程調(diào)用服務(wù)

使用Ribbon實(shí)現(xiàn)負(fù)載均衡

實(shí)際上Ribbon可以簡(jiǎn)單的理解為負(fù)載均衡算法+RestTemplate的調(diào)用，也就是說想要使用Ribbon實(shí)現(xiàn)負(fù)載均衡，就可以通過這兩個(gè)技術(shù)加以實(shí)現(xiàn)。

RestTemplate三步走

第一步：引入Ribbon場(chǎng)景啟動(dòng)器依賴，但是之前使用eureka的時(shí)候我們?cè)趐om文件中導(dǎo)入過netflix-eureka-server的依賴，其中就默認(rèn)引入了ribbon的場(chǎng)景啟動(dòng)器依賴（netflix-eureka-client也會(huì)默認(rèn)導(dǎo)入），如果再引一次也可以，但是真沒那必要。

第二步：使用配置文件開啟RestTemplate

/**

*@ClassName:ApplicationContextConfig

*@Description:程序配置類，用于開啟RestTemplate服務(wù)，以供后面使用

*@author:chenhao

*@date:2025/7/17

@Configuration

publicclassApplicationContextConfig{

@Bean

@LoadBalanced

publicRestTemplategetRestTemplate(){

returnnewRestTemplate();

}

第三步：使用RestTemplate的API實(shí)現(xiàn)負(fù)載均衡，RestTemplate的API根據(jù)請(qǐng)求方式的不同可以被分為get和post，根據(jù)返回類型又可以分為Object(響應(yīng)體轉(zhuǎn)化成的json串)和Entity(響應(yīng)的重要信息，包括響應(yīng)頭、狀態(tài)碼、響應(yīng)體等，可以使用對(duì)應(yīng)的get方法獲取到值)，所以說最主要的四個(gè)API是getForObject、postForObject、getForEntity、postForEntity，這里我把四種API的使用方法都向大家介紹一下

@RestController

@Slf4j

@RequestMapping("consumer")

@Api("消費(fèi)者的訂單管理類")

publicclassOrderController{

//先注入RestTemplate對(duì)象

@Resource

privateRestTemplaterestTemplate;

//使用API實(shí)現(xiàn)負(fù)載均衡

@ApiOperation(value="創(chuàng)建一條支付記錄",tags=ApiVersionConstant.v1_0)

@PostMapping(value="/payment/create",produces={"application/json;charset=UTF-8"})

publicCommonResultIntegercreate(@RequestBodyPaymentpayment){

returnrestTemplate.postForObject(UrlConstant.CLUSTER_PAYMENT_URL+"/payment/create",payment,CommonResult.class);

@ApiOperation(value="根據(jù)ID查詢支付記錄",tags=ApiVersionConstant.v1_0)

@GetMapping(value="/payment/get/{id}",produces={"application/json;charset=UTF-8"})

publicCommonResultPaymentgetPayment(@PathVariable("id")Integerid){

returnrestTemplate.getForObject(UrlConstant.CLUSTER_PAYMENT_URL+"/payment/get/"+id,CommonResult.class);

@ApiOperation(value="根據(jù)ID查詢支付記錄Entity",tags=ApiVersionConstant.v1_0)

@GetMapping(value="/payment/getForEntity/{id}",produces={"application/json;charset=UTF-8"})

publicCommonResultPaymentgetPaymentEntity(@PathVariable("id")Integerid){

ResponseEntityCommonResultentity=restTemplate.getForEntity(UrlConstant.CLUSTER_PAYMENT_URL+"/payment/get/"+id,CommonResult.class);

if(entity.getStatusCode().is2xxSuccessful()){

returnentity.getBody();

}else{

returnnewCommonResult(444,"操作失敗");

@ApiOperation(value="創(chuàng)建一條支付記錄Entity",tags=ApiVersionConstant.v1_0)

@PostMapping(value="/payment/createEntity",produces={"application/json;charset=UTF-8"})

publicCommonResultIntegercreateEntity(@RequestBodyPaymentpayment){

returnrestTemplate.postForEntity(UrlConstant.CLUSTER_PAYMENT_URL+"/payment/create",payment,CommonResult.class)

.getBody();

}

負(fù)載均衡算法

經(jīng)過我們上面的嘗試，不難發(fā)現(xiàn)使用RestTemplate實(shí)現(xiàn)的負(fù)載均衡算法是輪詢機(jī)制，實(shí)際上IRule中不僅僅只提供了一種算法

IRule實(shí)現(xiàn)算法切換

第一步：新建一個(gè)package，在官方文檔中聲明了IRule的配置類不能放到@ComponentScan注解所能掃描到的當(dāng)前包以及子包下，否則自定義的配置類就會(huì)被Ribbon的所有客戶端所共享，以至于失去客戶端定制化的可能性。主程序入口上的@SpringBootApplication注解是復(fù)合注解，其中就包含@ComponentScan注解，而且是直接掃描主程序入口所在的當(dāng)前包以及子包，也就是說配置類必須放到主程序入口之外的包下，于是需要新建一個(gè)package

第二步：在新建的包中新建一個(gè)MySelfRule規(guī)則類，用于設(shè)置輪詢算法，如果不設(shè)置的話就默認(rèn)為輪詢

@Configuration

publicclassMySelfRule{

@Bean

publicIRulemyRule(){

//修改輪詢算法為隨機(jī)算法

returnnewRandomRule();

第三步：主啟動(dòng)類上使用@RibbonClient(name=CLOUD-PAYMENT-SERVICE,configuration=MySelfRule.class)注解，用于指定應(yīng)用服務(wù)和自定義算法規(guī)則的配置類

@SpringBootApplication

@EnableEurekaClient

@RibbonClient(name="CLOUD-PAYMENT-SERVICE",configuration=MySelfRule.class)

publicclassOrderMain80{

publicstaticvoidmain(String[]args){

SpringApplication.run(OrderMain80.class,args);

輪詢算法

所謂的輪詢算法就是根據(jù)所有的服務(wù)，依次將請(qǐng)求均攤到所有的服務(wù)依次訪問，它的算法實(shí)現(xiàn)就是用RestTemplate接收到的請(qǐng)求數(shù)量對(duì)服務(wù)器集群的數(shù)量進(jìn)行取模運(yùn)算，余數(shù)就是服務(wù)在服務(wù)列表中對(duì)應(yīng)的索引位置，所以說可以實(shí)現(xiàn)輪詢。但是如果中途服務(wù)器關(guān)掉的話接收到的請(qǐng)求數(shù)量就會(huì)從1重新計(jì)數(shù)

OpenFeign

初識(shí)OpenFeign

什么是OpenFeign

openFeign是要聲明式的web服務(wù)客戶端，或叫做聲明式REST客戶端，它讓編寫web服務(wù)客戶端變得簡(jiǎn)單。它將提供者的restful服務(wù)偽裝成接口進(jìn)行消費(fèi)，消費(fèi)者只需要通過feign接口+注解就可以直接調(diào)用提供者的服務(wù)接口，也就是可以實(shí)現(xiàn)接口對(duì)接口的調(diào)用，而無需像ribbon一樣通過restTemplate方式對(duì)提供者的服務(wù)進(jìn)行調(diào)用

值得注意的一點(diǎn)是，openFeign內(nèi)置了負(fù)載均衡器-Ribbon，所以說openfeign也可以使用負(fù)載均衡算法

如何使用OpenFeign

第一步：引入相關(guān)依賴

!--openfeign--

dependency

groupIdorg.springframework.cloud/groupId

artifactIdspring-cloud-starter-openfeign/artifactId

/dependency

第二步：配置配置文件，只是基本配置和注冊(cè)，沒有OpenFeign獨(dú)有的配置

server:

port:80

eureka:

client:

register-with-eureka:false

service-url:

defaultZone:http://localhost:7001/eureka,

http://localhost:7002/eureka,

http://localhost:7003/eureka

第三步：主啟動(dòng)類開啟OpenFeign客戶端

@SpringBootApplication

@EnableFeignClients

publicclassOrderFeignMain80{

publicstaticvoidmain(String[]args){

SpringApplication.run(OrderFeignMain80.class,args);

第四步：之前使用ribbon是直接在controller里調(diào)用payment服務(wù)的controller，但是openfeign則是通過service調(diào)用，于是第三步就是創(chuàng)建一個(gè)service接口用于調(diào)用payment服務(wù)的接口

@Component

@FeignClient(value="CLOUD-PAYMENT-SERVICE")//用于指定服務(wù)名，可在eureka或者服務(wù)的配置文件中查看

publicinterfacePaymentFeignService{

@GetMapping(value="/payment/get/{id}",produces={"application/json;charset=UTF-8"})

CommonResultPaymentgetPaymentById(@PathVariable("id")Integerid);

第五步：controller層調(diào)用service接口

@RestController

@RequestMapping("consumer")

publicclassOrderFeignController{

@Autowired

privatePaymentFeignServicepaymentFeignService;

@GetMapping(value="/payment/get/{id}",produces={"application/json;charset=UTF-8"})

publicCommonResultPaymentgetPaymentById(@PathVariable("id")Integerid){

returnpaymentFeignService.getPaymentById(id);

如此操作也可實(shí)現(xiàn)order服務(wù)對(duì)payment服務(wù)的調(diào)用，而且由于OpenFeign默認(rèn)引入Ribbon，去進(jìn)行order服務(wù)訪問的時(shí)候，后端會(huì)默認(rèn)輪詢名為是CLOUD-PAYMENT-SERVICE的微服務(wù)，也就是兩個(gè)payment服務(wù)

OpenFeign超時(shí)控制

使用OpenFeign調(diào)用服務(wù)接口，默認(rèn)等待時(shí)間為1秒，超時(shí)就會(huì)直接報(bào)