Spring Cloud Ribbon集成

Posted 2022-08-25 java_wxid

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Spring Cloud Ribbon集成相关的知识，希望对你有一定的参考价值。

【java_wxid项目】【第三章】【Spring Cloud Open Feign集成】讲了Spring Cloud Alibaba Nacos集成，博文地址：https://liaozhiwei.blog.csdn.net/article/details/126463469
本章会结合上一章节的spring-cloud-alibaba-nacos-demo项目一起讲解Spring Cloud Ribbon集成

文章目录

创建spring-cloud-ribbon-demo项目

项目结构如下（示例）：

修改pom.xml文件

代码如下（示例）：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>spring-cloud-ribbon-demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>spring-cloud-ribbon-demo</name>
    <description>Demo project for Spring Boot</description>

    <!--    属性配置-->
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <!--引入 Spring Boot、Spring Cloud、Spring Cloud Alibaba 三者 BOM 文件，进行依赖版本的管理，防止不兼容。
        在 https://dwz.cn/mcLIfNKt 文章中，Spring Cloud Alibaba 开发团队推荐了三者的依赖关系-->
        <spring.boot.version>2.3.12.RELEASE</spring.boot.version>
        <spring.cloud.version>Hoxton.SR12</spring.cloud.version>
        <spring.cloud.alibaba.version>2.2.7.RELEASE</spring.cloud.alibaba.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <!--        代表web模块，在这个模块中含了许多JAR包，有spring相关的jar，内置tomcat服务器，jackson等，这些web项目中常用的的功能都会自动引入-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- Alibaba Nacos 配置 -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>
        <!--        在SpringBoot 2.4.x的版本之后，对于bootstrap.properties/bootstrap.yaml配置文件(我们合起来成为Bootstrap配置文件)的支持，其实这个jar包里什么都没有，就只有一个标识类Marker，用来标识要开启Bootstrap配置文件的支持，由于父类用了2.5.6版本需要导入如下的依赖-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-bootstrap</artifactId>
            <version>3.1.0</version>
        </dependency>
    </dependencies>


    <!--
        引入 Spring Boot、Spring Cloud、Spring Cloud Alibaba 三者 BOM 文件，进行依赖版本的管理，防止不兼容。
        在 https://dwz.cn/mcLIfNKt 文章中，Spring Cloud Alibaba 开发团队推荐了三者的依赖关系
     -->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-parent</artifactId>
                <version>$spring.boot.version</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>$spring.cloud.version</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>$spring.cloud.alibaba.version</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>


    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>2.4</version>
                <configuration>
                    <source>$java.version</source>
                    <target>$java.version</target>
                    <encoding>$project.build.sourceEncoding</encoding>
                </configuration>
            </plugin>
        </plugins>
    </build>


</project>

创建bootstrap.yml文件

代码如下（示例）：

#bootstrap.yml优先级比application.yml优先级高
spring:
  #prefix−spring.profile.active.$file-extension
  #nacos会根据当前环境去拼接配置名称查找相应配置文件，
  #示例：spring.application.name-spring.profiles.active-spring.cloud.nacos.config.file-extension
  #获取到值：nacos-autoconfig-service-dev.yml
  profiles:
    #开发环境dev，测试环境test，生产环境prod
    active: dev
  application:
    #配置应用的名称，用于获取配置
    name: ribbon-demo
  cloud:
    nacos:
      discovery:
        # 服务注册地址
        server-addr: ip:8848
      config:
        #nacos配置中心地址
        server-addr: ip:8848
        #配置中心的命名空间id
        namespace: 9e50b6d9-6c3d-4e7a-b701-10f085e4b98d
        #配置分组，默认没有也可以
        group: DEFAULT_GROUP
        #配置文件后缀，用于拼接配置配置文件名称，目前只支持yaml和properties
        file-extension: yaml
        #配置自动刷新
        refresh-enabled: true
        #配置文件的前缀，默认是application.name的值，如果配了prefix，就取prefix的值
        #prefix: nacos-autoconfig-service-$spring.profile.active
        # 配置编码
        encode: UTF-8
        username: nacos
        password: nacos

修改启动类SpringCloudRibbonDemoApplication

代码如下（示例）：

package com.example.springcloudribbondemo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;

@SpringBootApplication
public class SpringCloudRibbonDemoApplication 

    public static void main(String[] args) 
        SpringApplication.run(SpringCloudRibbonDemoApplication.class, args);
    

/*    Ribbon的负载均衡，主要通过LoadBalancerClient来实现的，而LoadBalancerClient具体交给了ILoadBalancer来处理，
    ILoadBalancer通过配置IRule、IPing等信息，并获取注册列表的信息，并默认10秒一次发送“ping”,
    进而检查是否更新服务列表，最后，得到注册列表后，ILoadBalancer根据IRule的策略进行负载均衡。
    而RestTemplate 被@LoadBalance注解后，能过用负载均衡，主要是维护了一个被@LoadBalance注解的RestTemplate列表，
    并给列表中的RestTemplate添加拦截器，进而交给负载均衡器去处理。
    第一种实现方式：RestTemplate 结合@LoadBalanced 以及Ribbon依赖(nacos依赖中已经包含) 使用*/
    @Bean
    @LoadBalanced
    public RestTemplate restTemplate() 
        return new RestTemplate();

创建RibbonController

代码如下（示例）：

package com.example.springcloudribbondemo.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

/**
 * @Author: liaozhiwei
 * @Description: TODO
 * @Date: Created in 12:08 2022/8/23
 */
@RestController
public class RibbonController 

    @Autowired
    private RestTemplate restTemplate;

    @GetMapping("/getMsg")
    public Object getMsg() 
        return restTemplate.getForObject("http://nacos-config/getNacosConfigure", String.class);

改造spring-cloud-alibaba-nacos-demo项目

修改NacosConfigController

代码如下（示例）：

package com.example.springcloudalibabanacosdemo.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * @Author: liaozhiwei
 * @Description: TODO
 * @Date: Created in 21:22 2022/8/22
 */
@Controller
/*@EnableAutoConfiguration：这就是spring boot的核心功能，自动配置。就是根据当前引入的JAR包进行自动配置.
 比如：引入了jackson的jar包，那么就会自动配置json转换，所以这里可以使用@ResponseBody.
 比如：引入了spring boot的web模块，就会自动配置web.xml等与web项目相关的内容，所以这些配置都不需要我们自己配了*/
@EnableAutoConfiguration
public class NacosConfigController 

    @Value("$server.port")
    String port;

    @RequestMapping(value = "/getNacosConfigure",method = RequestMethod.GET)
    @ResponseBody
    public String getNacosConfigure()
        return "port:" + port;

启动spring-cloud-alibaba-nacos-demo三个实例

端口8771
如下图（示例）：
8772
如下图（示例）：

8773
如下图（示例）：

校验Ribbon是否可以工作

依次启动实例

请求三次，http://localhost:8804/getMsg
如下图（示例）：

如下图（示例）：

如下图（示例）：

可以发现ribbon已经可以正常工作了，这是SpringCloudRibbon使用@LoadBalanced注解通过LoadBalancerClient来实现的

Spring Cloud Ribbon基于@LoadBalanced注解底层实现负载均衡

主要通过LoadBalancerClient来实现的，而LoadBalancerClient具体交给了ILoadBalancer来处理，
ILoadBalancer通过配置IRule、IPing等信息，并获取注册列表的信息，并默认10秒一次发送“ping”,
进而检查是否更新服务列表，最后，得到注册列表后，ILoadBalancer根据IRule的策略进行负载均衡。
而RestTemplate 被@LoadBalance注解后，能过用负载均衡，主要是维护了一个被@LoadBalance注解的RestTemplate列表，
并给列表中的RestTemplate添加拦截器，进而交给负载均衡器去处理。

其实还有第二种方式，就是通过open-fegin来实现，大家可以找到【java_wxid项目】【第三章】【Spring Cloud Open Feign集成】，地址：https://liaozhiwei.blog.csdn.net/article/details/126475438

验证OpenFeign整合Ribbon来实现负载均衡

如下图（示例）：
这时spring-cloud-alibaba-nacos-demo有端口为8771的实例、有端口为8772的实例、有端口为8773的实例
spring-cloud-open-feign-demo有8803的实例，访问8803端口的项目接口，它远程调用了spring-cloud-alibaba-nacos-demo的接口
如下图（示例）：
连续访问三次，http://localhost:8803/feign/getNacosConfigure
如下图（示例）：

如下图（示例）：

如下图（示例）：

可以发现ribbon已经可以正常工作了，这是SpringCloudRibbon使用OpenFeign来实现的。

OpenFeign整合Ribbon底层实现负载均衡

OpenFeign在进行rpc调用的时候，会先进行接口的动态代理，把每个方法对应的MethodHandler进行拼接各种参数，组装成一个请求，随后交由Client接口的实现去发送请求，这是第一步。接着第二步会调用Client接口的execute方法的实现，方法里面有一堆操作，主要是从请求的URL中拿到了clientName，也就是服务名，类似 http://服务名/api/sayHello这种，所以可以通过路径拿到你锁请求的服务名。第三步FeignLoadBalancer的execute方法里面会重构请求路径，将服务名替换成某个具体的服务器所在的ip和端口，之后交给子类execute来处理。第四步由于不知道服务具体在哪台机器上，所以需要Ribbon这个负载均衡组件从服务所在的机器列表中选择一个，Ribbon中服务所在的机器列表是从注册中心拉取的，Ribbon提供了一个ServerList接口，注册中心实现之后，Ribbon就可以获取到服务所在的机器列表。

以上是关于Spring Cloud Ribbon集成的主要内容，如果未能解决你的问题，请参考以下文章

Spring Cloud之Ribbon

spring-cloud-ribbon负载均衡

Spring Cloud核心组件：Ribbon，Feign

解决Spring Cloud中Feign/Ribbon第一次请求失败的方法

我的spring cloud reset ribbon搭建

撸一撸Spring Cloud Ribbon的原理