【SpringCloud】整合Consul实现配置中心

淩亂°似流年 2024-03-26 15:06 193阅读 0赞

Consul不仅能用来服务注册和发现，Consul而且支持Key/Value键值对的存储，可以用来做配置中心。

## 一、添加依赖 ##

本案例在上一个案例的consul-provider基础上进行改造。首先在工程的pom文件加上consul-config的起步依赖，代码如下：

引入pom

<dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-consul-config</artifactId>
    </dependency>

然后在配置文件application.yml加上以下的以下的配置，配置如下：

## 二、增加配置 ##

### **1、bootstrap.yml配置** ###

spring:
      profiles:
        active: dev

上面的配置指定了SpringBoot启动时的读取的profiles为dev。 然后再工程的启动配置文件bootstrap.yml文件中配置以下的配置：

spring:
      application:
        name: consul-provider
      cloud:
        consul:
          host: localhost
          port: 8500
          discovery:
            serviceName: consul-provider
          config:
            enabled: true
            format: yaml        
            prefix: config   
            profile-separator: ':'    
            data-key: data

关于spring.cloud.consul.config的配置项描述如下：

*  enabled 设置config是否启用，默认为true

*  format 设置配置的值的格式，可以yaml和properties

*  prefix 设置配的基本目录，比如config

*  defaultContext 设置默认的配置，被所有的应用读取，本例子没用的

*  profileSeparator profiles配置分隔符,默认为‘,’

*  date-key为应用配置的key名字，值为整个应用配置的字符串。

## 三、Consul添加值记录 ##

网页上访问consul的KV存储的管理界面，即[http://localhost:8500/ui/dc1/kv][http_localhost_8500_ui_dc1_kv]，创建一条记录，

key值为：**config/consul-provider:dev/data** value值如下

foo:
      bar: bar1

## 四、添加控制器 ##

FooBarController.java

使用spring cloud config作为配置中心的时候，可以使用spring cloud config bus支持动态刷新配置。Spring Cloud Comsul Config默认就支持动态刷新，只需要在需要动态刷新的类上加上@RefreshScope注解即可

package com.example.controller;
    
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.cloud.context.config.annotation.RefreshScope;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @RefreshScope
    public class FooBarController {
    
        @Value("${foo.bar}")
        String fooBar;
    
        @GetMapping("/foo")
        public String getFooBar() {
            return fooBar;
        }
    }

## 五、测试 ##

启动工程，可以看到程序的启动端口为8764，即是consul的配置中心配置的server.port端口。

工程启动完成后，在浏览器上访问[http://localhost:8764/foo][http_localhost_8764_foo]，页面显示bar1。

由此可知，应用consul-provider已经成功从consul的配置中心读取了配置foo.bar的配置。

![f4c466cc8f3563fdf3265184c16463e3.png][]

## 六、动态刷新 ##

修改consul里值为bar222

![73cd44e5eb0ea99e1beff9f615e7b926.png][]

不重新启动consul-provider，

在浏览器上访问http://localhost:8764/foo，页面显示bar222。可见foo.bar的最新配置在应用不重启的情况下已经生效。

![f53c92aac1a4145ce84aa0f4bac5b87c.png][]

## **七、注意事项** ##

*  consul支持的KV存储的Value值不能超过512KB

*  Consul的dev模式，所有数据都存储在内存中，重启Consul的时候会导致所有数据丢失，在正式的环境中，Consul的数据会持久化，数据不会丢失。

[http_localhost_8500_ui_dc1_kv]: http://localhost:8500/ui/dc1/kv
[http_localhost_8764_foo]: http://localhost:8764/foo
[f4c466cc8f3563fdf3265184c16463e3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/e52c58e94015449091fa2bf2ca5f09f2.png
[73cd44e5eb0ea99e1beff9f615e7b926.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/6270674efc1547d7b66b683d0a413689.png
[f53c92aac1a4145ce84aa0f4bac5b87c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/61793de09050498ab49cc713e1f1c027.png