SpringCloud(10)之Consul服务注册与发现

以你之姓@ 2022-11-26 11:58 264阅读 0赞

学习在 Spring Cloud 中使用 Consul 实现服务注册与发现，它是 Eureka 之外的另一种选择。

# 一、概述 #

在 Spring Cloud 中，大部分组件都有备选方案，例如服务注册中心，除了常见`Eureka` 之外，还有 `Zookeeper` 和 `Consul` 等。Consul 是 HashiCorp 公司推出来的开源产品，主要提供了**「服务发现、服务隔离、服务配置」**等功能。Zookeeper和Consul在前面的博客已经有介绍到了，大家有什么不懂的可以去查阅一下我之前的博客。

相比于 Eureka 和 Zookeeper ，**「Consul 配置更加一站式」**，因为它内置了很多微服务常见的需求，比如：**「服务发现与注册、分布式一致性协议实现、健康检查、键值对存储、多数据中心」**等，我们不再需要借助第三方组件来实现这些功能。这里服务发现与注册只是Consul的一面，不过他是用Go语言编写的。

# 二、安装 #

不同于 Eureka ，Consul 使用 Go 语言开发，所以使用 Consul 我们需要先 下载 并安装软件，作为我们的 `Consul Server` ，即服务注册中心。

*  Linux

# 下载
    wget https://releases.hashicorp.com/consul/1.6.2/consul_1.6.2_linux_amd64.zip
    
    # 解压，解压完成后，我们在当前目录下就可以看到 consul 文件
    unzip consul_1.6.2_linux_amd64.zip
    
    # 启动
    ./consul agent -dev -ui -node=consul-dev -client=127.0.0.1

*  Windows

# 下载
    # consul_1.7.2_windows_amd64.zip
    
    # 启动
    consul.exe agent -dev -ui -node=consul-dev -client=127.0.0.1

启动成功后，通过 http://127.0.0.1:8500 访问 Consul 的后台管理页面，如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2pva2VNcWM_size_16_color_FFFFFF_t_70][]

# 三、使用 #

创建 Spring Boot 项目 `consul-client-provider` ，作为我们的**「服务提供者」**，添加 `Web/Consul/Actuator` 依赖，如下：

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-consul-discovery</artifactId>
        </dependency>
    
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

其实大家不难发现，其他的依赖跟我们之前的eureka、zookeeper注册中心的都差不多，唯一不同的是spring-cloud-starter-consul-discovery，不同的注册中心springCloud都有对应的集成，所以对于新技术，我的观点就是核心理念八九不离十，套路都是一样的。

项目创建成功后，修改 `application.properties` 配置文件，将 provider 注册到 Consul 服务上，如下：

spring.application.name=consul-client-provider
    server.port=2000
    
    # Consul 相关配置
    spring.cloud.consul.host=127.0.0.1
    spring.cloud.consul.port=8500
    spring.cloud.consul.discovery.service-name=consul-client-provider

接着，在项目启动类上添加 `@EnableDiscoveryClient` 注解，开启服务发现的功能，如下：

@SpringBootApplication
    @EnableDiscoveryClient // 开启服务发现的功能
    public class ConsulClientProviderApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(ConsulClientProviderApplication.class, args);
        }
    
    }

接下来，启动项目，访问 http://127.0.0.1:8500 可以看到 provider 的注册信息。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2pva2VNcWM_size_16_color_FFFFFF_t_70 1][]

当然 provider 也可以集群化部署，下面对 consul-client-provider 进行打包，之后我们在命令行启动两个 provider 实例：

java -jar consul-client-provider-0.0.1-SNAPSHOT.jar --server.port=2000
    java -jar consul-client-provider-0.0.1-SNAPSHOT.jar --server.port=2001

启动成功后，再去 Consul 后台管理页面，就可以看到有两个实例了：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2pva2VNcWM_size_16_color_FFFFFF_t_70 2][]

最后在 provider 中提供一个 hello 接口，用于后续服务消费者 consumer 来消费，如下：

@RestController
    public class ProviderController {
        @Value("${server.port}")
        Integer port; // 支持启动多个实例，做负载均衡，用端口区分
    
        @GetMapping("/hello")
        public String hello() {
            return "hello cxy35: " + port;
        }
    }

# 四、创建服务消费者 #

创建 Spring Boot 项目 `consul-client-consumer` ，作为我们的**「服务消费者」**，添加 `Web/Consul/Actuator` 依赖，如下：

项目创建成功后，修改 `application.properties` 配置文件，将 consumer 注册到 Consul 服务上，如下：

spring.application.name=consul-client-consumer
    server.port=2002
    
    # Consul 相关配置
    spring.cloud.consul.host=127.0.0.1
    spring.cloud.consul.port=8500
    spring.cloud.consul.discovery.service-name=consul-client-consumer

接着，在项目启动类上添加 `@EnableDiscoveryClient` 注解，开启服务发现的功能，并添加 RestTemplate ，如下：

@SpringBootApplication
    @EnableDiscoveryClient // 开启服务发现的功能
    public class ConsulClientConsumerApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(ConsulClientConsumerApplication.class, args);
        }
    
        @Bean
        RestTemplate restTemplate() {
            return new RestTemplate();
        }
    }

最后在 consumer 中新增测试接口，去实现服务调用，从而消费 provider 中提供的接口，如下：

@RestController
    public class ConsumerController {
        @Autowired
        LoadBalancerClient loadBalancerClient;
        @Autowired
        RestTemplate restTemplate;
    
        @GetMapping("/testConsul")
        public String testConsul() {
            ServiceInstance choose = loadBalancerClient.choose("consul-client-provider");
            System.out.println("服务地址：" + choose.getUri());
            System.out.println("服务名称：" + choose.getServiceId());
            String s = restTemplate.getForObject(choose.getUri() + "/hello", String.class);
            return s;
        }
    }

我们通过 `LoadBalancerClient` 实例，可以获取要调用的 `ServiceInstance` 。获取到调用地址之后，再用 RestTemplate 去调用。访问 http://127.0.0.1:2002/testConsul 完成测试，**「这个请求自带负载均衡功能」**。

好啦，对于SpringCloud的服务注册中心的解决方案大体已经差不多介绍完了，然后还剩下阿里的Nacos没有介绍，这一块我们先慢慢学习完SpringCloud剩下模块，然后后面再学习阿里的，好了，今天的介绍到这里介绍了，让我们一起共同努力共同进步，加油！

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2pva2VNcWM_size_16_color_FFFFFF_t_70]: /images/20221124/5f05ff396e134511ba9a9b372d605e8c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2pva2VNcWM_size_16_color_FFFFFF_t_70 1]: /images/20221124/253097ad5da7464c835cf77271c20592.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2pva2VNcWM_size_16_color_FFFFFF_t_70 2]: /images/20221124/68bbb614f2914026abcc21aca7d6792b.png