Spring Cloud-Consul服务注册发现与配置中心

简介

Spring Cloud Consul为SpringBoot应用提供了Consul的支持，Consul既可以作为注册中心使用，也可以作为配置中心使用，本文将对其用法进行详细介绍。

Consul是HashiCorp公司推出的开源软件，提供了微服务系统中的服务治理、配置中心、控制总线等功能。这些功能中的每一个都可以根据需要单独使用，也可以一起使用以构建全方位的服务网格。

Spring Cloud Consul具有如下特性：

支持服务治理：Consul作为注册中心时，微服务中的应用可以向Consul注册自己，并且可以从Consul获取其他应用信息；
支持客户端负载均衡：包括Ribbon和Spring Cloud LoadBalancer；
支持Zuul：当Zuul作为网关时，可以从Consul中注册和发现应用；
支持分布式配置管理：Consul作为配置中心时，使用键值对来存储配置信息；
支持控制总线：可以在整个微服务系统中通过Control Bus分发事件消息；

使用Consul作为注册中心

安装Consul

Consul下载地址：
https://www.consul.io/downloads.html

下载后解压缩，在cmd中进入consul目录，执行以下命令查看版本号；
consul --version

springcloud-consul-00.png

使用开发模式启动命令：
consul agent -dev

启动后，通过以下地址访问Consul首页：
http://localhost:8500

springcloud-consul-01.png

创建应用注册到Consul

我们通过改造user-service和ribbon-service来演示服务注册与发现的功能，主要是将应用原来的Eureka注册中心支持改为Consul注册中心支持。

创建consul-user-service模块和consul-ribbon-service模块；

修改相关依赖，把原来的Eureka注册发现的依赖修改为Consul的，并添加SpringBoot Actuator的依赖，对应pom.xml主要内容为：

<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-actuator</artifactId>
</dependency>

修改application.yml，将Eureka的注册发现配置改为Consul的，application.yml配置内容为：

# 指定服务端口
server:
  port: 8306
# 指定服务名称
spring:
  application:
    name: consul-ribbon-service
  cloud:
    consul:
      # 将服务注册到consul
      host: localhost
      port: 8500
      discovery:
        service-name: ${spring.application.name}

运行两个consul-user-service和一个consul-ribbon-service，在Consul页面可以看到如下信息：

springcloud-consul-02.png

springcloud-consul-03.png

Consul负载均衡功能

由于我们运行了两个consul-user-service，而consul-ribbon-service默认会去调用它的接口，所以我们调用consul-ribbon-service的接口来演示下负载均衡功能。

多次调用接口：http://localhost:8306/user/ribbon/100
可以发现两个consul-user-service的控制台交替打印如下信息：
consul-user-service(8206)日志：

01-08 01:12:00.585  INFO 76752 --- [nio-8206-exec-3] c.w.s.u.UserServiceImpl : 查询用户 100
01-08 01:12:02.645  INFO 76752 --- [nio-8206-exec-2] c.w.s.u.UserServiceImpl : 查询用户 100
01-08 01:12:03.440  INFO 76752 --- [nio-8206-exec-5] c.w.s.u.UserServiceImpl : 查询用户 100
01-08 01:12:14.015  INFO 76752 --- [nio-8206-exec-7] c.w.s.u.UserServiceImpl : 查询用户 100
01-08 01:12:15.257  INFO 76752 --- [nio-8206-exec-8] c.w.s.u.UserServiceImpl : 查询用户 100

consul-user-service(8207)日志：

01-08 01:12:02.067  INFO 80104 --- [nio-8207-exec-2] c.w.s.u.UserServiceImpl : 查询用户 100
01-08 01:12:03.027  INFO 80104 --- [nio-8207-exec-4] c.w.s.u.UserServiceImpl : 查询用户 100
01-08 01:12:13.311  INFO 80104 --- [nio-8207-exec-6] c.w.s.u.UserServiceImpl : 查询用户 100
01-08 01:12:14.472  INFO 80104 --- [nio-8207-exec-7] c.w.s.u.UserServiceImpl : 查询用户 100
01-08 01:12:15.679  INFO 80104 --- [nio-8207-exec-8] c.w.s.u.UserServiceImpl : 查询用户 100

使用Consul作为配置中心

我们通过创建consul-config-client模块，并在Consul中添加配置信息来演示下配置管理的功能。

创建consul-config-client模块

在pom.xml中添加依赖：

<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-config</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-consul-discovery</artifactId>
</dependency>

添加配置文件application.yml，启动dev环境的配置：

spring:
  profiles:
    active: dev

添加配置文件bootstrap.yml，主要是对Consul的配置功能进行配置：

server:
  port: 9101
spring:
  application:
    name: consul-config-client
  cloud:
    consul:
      host: localhost
      port: 8500
      discovery:
        service-name: consul-config-client
      config:
        # 是否启用配置中心
        enabled: true
        # 设置配置的格式
        format: yaml
        # 设置配置所在目录
        prefix: config
        # 设置配置的分隔符
        profile-separator: ':'
        # 配置key的名字，由于consul是K/V存储，配置存储在对应K的V中
        data-key: data

创建ConfigClientController，从Consul配置中心获取配置信息：

@RefreshScope
@RestController
public class ConfigClientController {

    @Value("${config.info}")
    private String configInfo;

    @GetMapping("/configInfo")
    public String getConfigInfo() {
        return configInfo;
    }

}

在Consul中添加配置

在consul中添加配置存储的key为：
config/consul-config-client:dev/data

在consul中添加配置存储的value为：

config:
  info: "config info for dev"

如下图示保存即可；

springcloud-consul-04.png

启动consul-config-client，调用如下接口查看配置信息：
http://localhost:9101/configInfo

Consul的动态刷新配置

我们只需修改下Consul中的配置信息，再次调用查看配置的接口，就会发现配置已经刷新。

回想下在使用Spring Cloud Config的时候，我们需要调用接口，通过Spring Cloud Bus才能刷新配置。Consul使用其自带的Control Bus实现了一种事件传递机制，从而实现了动态刷新功能。

Gitee项目源码地址：
https://gitee.com/whwtree/springcloud-learning.git

（完）

简介