基于 Consul 的配置中心

最新推荐文章于 2023-08-25 16:41:11 发布
最新推荐文章于 2023-08-25 16:41:11 发布
阅读量1.6k 收藏 1
点赞数 1
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_43790623/article/details/105217987
版权

Spring Cloud Consul Config

依赖

  • 加入 spring-cloud-starter-consul-config

启用

  • 在 bootstrap.properties | yml 中 加入相关配置
    • spring.cloud.consul.host=localhost
    • spring.cloud.consul.port=8500
    • spring.cloud.consul.config.enabled=true
    开启consul配置中心支持

Consul 中的数据怎么存

配置项

  • spring.cloud.consul.config.format=
    KEY_VALUE | YAML | PROPERTIES | FILES
    配置数据存储的形式
  • /config/应用名,profile/data
    所有的配置 在这个data节点里面
  • /config/application,profile/data

如何定制

  • spring.cloud.consul.config.data-key=data
    配置key的名字，由于Consul是K/V存储，配置存储在对应K的V中

  • spring.cloud.consul.config.root=config

  • spring.cloud.consul.config.default-context=application
    指定consul配置的配置文件父路径

  • spring.cloud.consul.config.profile-separator=’,’
    置配置的分隔符

配置项变更

自动刷新配置

  • spring.cloud.consul.config.watch.enabled=true

  • spring.cloud.consul.config.watch.delay=1000
    刷新时间为每隔一秒钟

实现原理

  • 单线程 ThreadPoolTaskScheduler
  • ConsulConfigAutoConfiguration.CONFIG_WATCH_TASK_SCHEDULER_NAME
    使用 ThreadPoolTaskScheduler 每隔一秒钟 去检测 看看有没有发生变化 如果有变化 就发一个event事件出来

实例

在这里插入图片描述
需要修改的代码

bootstrap.properties

spring.application.name=waiter-service

spring.cloud.consul.host=localhost
spring.cloud.consul.port=8500
spring.cloud.consul.discovery.prefer-ip-address=true

spring.cloud.consul.config.enabled=true
#是否启用配置中心功能
spring.cloud.consul.config.format=yaml
#设置配置值的格式

pom文件

<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-cache</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-data-jpa</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-actuator</artifactId>
		</dependency>
		
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-consul-discovery</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-consul-config</artifactId>
		</dependency>

		<dependency>
			<groupId>io.github.resilience4j</groupId>
			<artifactId>resilience4j-spring-boot2</artifactId>
			<version>0.14.1</version>
		</dependency>

		<dependency>
			<groupId>io.micrometer</groupId>
			<artifactId>micrometer-registry-prometheus</artifactId>
		</dependency>

		<dependency>
			<groupId>org.joda</groupId>
			<artifactId>joda-money</artifactId>
			<version>1.0.1</version>
		</dependency>
		<dependency>
			<groupId>org.jadira.usertype</groupId>
			<artifactId>usertype.core</artifactId>
			<version>6.0.1.GA</version>
		</dependency>
		<!-- 增加Jackson的Hibernate类型支持 -->
		<dependency>
			<groupId>com.fasterxml.jackson.datatype</groupId>
			<artifactId>jackson-datatype-hibernate5</artifactId>
			<version>2.9.8</version>
		</dependency>

		<dependency>
			<groupId>org.apache.commons</groupId>
			<artifactId>commons-lang3</artifactId>
		</dependency>

		<dependency>
			<groupId>com.h2database</groupId>
			<artifactId>h2</artifactId>
			<scope>runtime</scope>
		</dependency>
		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<optional>true</optional>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
	</dependencies>
	<dependencyManagement>
		<dependencies>
			<dependency>
				<groupId>org.springframework.cloud</groupId>
				<artifactId>spring-cloud-dependencies</artifactId>
				<version>${spring-cloud.version}</version>
				<type>pom</type>
				<scope>import</scope>
			</dependency>
		</dependencies>
	</dependencyManagement>

结果分析

启动 consul
输入 http://localhost:8500 进入 consul 在 key/Value 中 新建一个 key/Value 为yaml格式
在这里插入图片描述

启动程序 使用 postman 进行订单的创建 我们之前在consul写入的配置 成功 配置
在这里插入图片描述

将 折扣进行调整 变成 50 控制台显示discount的变更在这里插入图片描述
在这里插入图片描述

使用 postman 继续进行测试 结果中的discount已经成功修改
在这里插入图片描述

源码分析

ConsulConfigBootstrapConfiguration

@Configuration
@ConditionalOnConsulEnabled
public class ConsulConfigBootstrapConfiguration {
    public ConsulConfigBootstrapConfiguration() {
    }

    @Configuration
    @EnableConfigurationProperties
    @Import({ConsulAutoConfiguration.class})
    @ConditionalOnProperty(
        name = {"spring.cloud.consul.config.enabled"},
        matchIfMissing = true
    )
    protected static class ConsulPropertySourceConfiguration {
        @Autowired
        private ConsulClient consul;

        protected ConsulPropertySourceConfiguration() {
        }

        @Bean
        @ConditionalOnMissingBean
        public ConsulConfigProperties consulConfigProperties() {
            return new ConsulConfigProperties();
        }

        @Bean     //配置 consulPropertySourceLocator   通过 consulPropertySourceLocator 找到对应的 PropertySource
        public ConsulPropertySourceLocator consulPropertySourceLocator(ConsulConfigProperties consulConfigProperties) {
            return new ConsulPropertySourceLocator(this.consul, consulConfigProperties);
        }
    }
}

ConsulConfigAutoConfiguration

@Configuration
@ConditionalOnConsulEnabled
@ConditionalOnProperty(
    name = {"spring.cloud.consul.config.enabled"},
    matchIfMissing = true
)
public class ConsulConfigAutoConfiguration {
    public static final String CONFIG_WATCH_TASK_SCHEDULER_NAME = "configWatchTaskScheduler";

    public ConsulConfigAutoConfiguration() {
    }

    @Configuration
    @ConditionalOnClass({RefreshEndpoint.class})
    protected static class ConsulRefreshConfiguration {
        protected ConsulRefreshConfiguration() {
        }

        @Bean
        @ConditionalOnProperty(
            name = {"spring.cloud.consul.config.watch.enabled"},
            matchIfMissing = true
        )
        //在 configWatch 中 会用到一个单线程的 ThreadPoolTaskScheduler  在创建的时候 将 name 这个常量传入
        public ConfigWatch configWatch(ConsulConfigProperties properties, ConsulPropertySourceLocator locator, ConsulClient consul, @Qualifier("configWatchTaskScheduler") TaskScheduler taskScheduler) {
            return new ConfigWatch(properties, consul, locator.getContextIndexes(), taskScheduler);
        }

        @Bean(
            name = {"configWatchTaskScheduler"}
        )
        @ConditionalOnProperty(
            name = {"spring.cloud.consul.config.watch.enabled"},
            matchIfMissing = true
        )
        public TaskScheduler configWatchTaskScheduler() {
            return new ThreadPoolTaskScheduler();
        }
    }
}

ConfigWatch

public class ConfigWatch implements ApplicationEventPublisherAware, SmartLifecycle {
    private static final Log log = LogFactory.getLog(ConfigWatch.class);
    private final ConsulConfigProperties properties;
    private final ConsulClient consul;
    private final TaskScheduler taskScheduler;
    private final AtomicBoolean running;
    private LinkedHashMap<String, Long> consulIndexes;
    private ApplicationEventPublisher publisher;
    private boolean firstTime;
    private ScheduledFuture<?> watchFuture;

    public ConfigWatch(ConsulConfigProperties properties, ConsulClient consul, LinkedHashMap<String, Long> initialIndexes) {
        this(properties, consul, initialIndexes, getTaskScheduler());
    }

    public ConfigWatch(ConsulConfigProperties properties, ConsulClient consul, LinkedHashMap<String, Long> initialIndexes, TaskScheduler taskScheduler) {
        this.running = new AtomicBoolean(false);
        this.firstTime = true;
        this.properties = properties;
        this.consul = consul;
        this.consulIndexes = new LinkedHashMap(initialIndexes);
        this.taskScheduler = taskScheduler;
    }

    private static ThreadPoolTaskScheduler getTaskScheduler() {
        ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler();
        taskScheduler.initialize();
        return taskScheduler;
    }

    public void setApplicationEventPublisher(ApplicationEventPublisher publisher) {
        this.publisher = publisher;
    }

    public void start() {//在启动的时候 设置它的时间 从 properties 中 找出时间的参数（有默认的）
        if (this.running.compareAndSet(false, true)) {
            this.watchFuture = this.taskScheduler.scheduleWithFixedDelay(this::watchConfigKeyValues, (long)this.properties.getWatch().getDelay());
        }

    }

    public boolean isAutoStartup() {
        return true;
    }

    public void stop(Runnable callback) {
        this.stop();
        callback.run();
    }

    public int getPhase() {
        return 0;
    }

    public void stop() {
        if (this.running.compareAndSet(true, false) && this.watchFuture != null) {
            this.watchFuture.cancel(true);
        }

    }

    public boolean isRunning() {
        return this.running.get();
    }

    @Timed("consul.watch-config-keys")
    public void watchConfigKeyValues() {//是一个定时任务 每隔一秒钟 会跑一次  在这里面 做了一个 从 Consul 中获取值的动作
        if (this.running.get()) {
            Iterator var1 = this.consulIndexes.keySet().iterator();

            while(var1.hasNext()) {
                String context = (String)var1.next();
                if (this.properties.getFormat() != Format.FILES && !context.endsWith("/")) {
                    context = context + "/";
                }

                try {
                    Long currentIndex = (Long)this.consulIndexes.get(context);
                    if (currentIndex == null) {
                        currentIndex = -1L;
                    }

                    log.trace("watching consul for context '" + context + "' with index " + currentIndex);
                    String aclToken = this.properties.getAclToken();
                    if (StringUtils.isEmpty(aclToken)) {
                        aclToken = null;
                    }

                    Response<List<GetValue>> response = this.consul.getKVValues(context, aclToken, new QueryParams((long)this.properties.getWatch().getWaitTime(), currentIndex));//取得kv的值 将取回来的值 进行判断 是否发生看变化  如果 变了 就publish一个RefreshEvent消息出去  推出去之后 我们就去刷新 这里 所有需要的refreshsource  加了source的这些bean 它好会被刷新掉 
                    if (response.getValue() != null && !((List)response.getValue()).isEmpty()) {
                        Long newIndex = response.getConsulIndex();
                        if (newIndex != null && !newIndex.equals(currentIndex)) {
                            if (!this.consulIndexes.containsValue(newIndex) && !currentIndex.equals(-1L)) {
                                log.trace("Context " + context + " has new index " + newIndex);
                                ConfigWatch.RefreshEventData data = new ConfigWatch.RefreshEventData(context, currentIndex, newIndex);
                                this.publisher.publishEvent(new RefreshEvent(this, data, data.toString()));
                            } else if (log.isTraceEnabled()) {
                                log.trace("Event for index already published for context " + context);
                            }

                            this.consulIndexes.put(context, newIndex);
                        } else if (log.isTraceEnabled()) {
                            log.trace("Same index for context " + context);
                        }
                    } else if (log.isTraceEnabled()) {
                        log.trace("No value for context " + context);
                    }
                } catch (Exception var8) {
                    if (this.firstTime && this.properties.isFailFast()) {
                        log.error("Fail fast is set and there was an error reading configuration from consul.");
                        ReflectionUtils.rethrowRuntimeException(var8);
                    } else if (log.isTraceEnabled()) {
                        log.trace("Error querying consul Key/Values for context '" + context + "'", var8);
                    } else if (log.isWarnEnabled()) {
                        log.warn("Error querying consul Key/Values for context '" + context + "'. Message: " + var8.getMessage());
                    }
                }
            }
        }

        this.firstTime = false;
    }

    static class RefreshEventData {
        private final String context;
        private final Long prevIndex;
        private final Long newIndex;

        RefreshEventData(String context, Long prevIndex, Long newIndex) {
            this.context = context;
            this.prevIndex = prevIndex;
            this.newIndex = newIndex;
        }

        public String getContext() {
            return this.context;
        }

        public Long getPrevIndex() {
            return this.prevIndex;
        }

        public Long getNewIndex() {
            return this.newIndex;
        }

        public boolean equals(Object o) {
            if (this == o) {
                return true;
            } else if (o != null && this.getClass() == o.getClass()) {
                ConfigWatch.RefreshEventData that = (ConfigWatch.RefreshEventData)o;
                return Objects.equals(this.context, that.context) && Objects.equals(this.prevIndex, that.prevIndex) && Objects.equals(this.newIndex, that.newIndex);
            } else {
                return false;
            }
        }

        public int hashCode() {
            return Objects.hash(new Object[]{this.context, this.prevIndex, this.newIndex});
        }

        public String toString() {
            return (new ToStringCreator(this)).append("context", this.context).append("prevIndex", this.prevIndex).append("newIndex", this.newIndex).toString();
        }
    }
}

ConsulConfigProperties
在这个里面 有默认的时间参数

 public static class Watch {
        private int waitTime = 55;
        private boolean enabled = true;
        private int delay = 1000;
L# S@
关注
  • 1
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
springcloud使用consul作为配置中心
08-27
主要介绍了springcloud使用consul作为配置中心，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
SpringCloud实战十七：Spring Cloud Consul 服务发现与配置中心
热门推荐
zhuyu19911016520
03-04 1万+
  Consul 用于实现分布式系统的服务发现与配置。与其他服务注册与发现相比，Consul更“一站式”，内置了服务注册与发现框架、分布一致性协议实现、健康检查、Key/Value存储、多数据中心方案，不再需要依赖其他工具（比如ZooKeeper等）。使用起来也较为简单。Consul使用Go语言编写，因此具有天然可移植性(支持Linux、windows和Mac OS X)；安装包仅包含一个可执行文...
Spring Cloud中的Consul的相关配置
一路斜阳的专栏
05-05 8230
在这里主要介绍在Consul的相关配置。在这里使用yml的格式进行配置。 spring: cloud: consul: enabled: true //是否启用consul host: ip // consul server的ip地址 port: 8500 // consul运行的端口号 ...
SpringCloud技术指南系列（八）配置管理之Consul配置中心
feiyangtianyao的专栏
08-20 880
SpringCloud技术指南系列（八）配置管理之Consul配置中心 Spring Boot应用的配置文件有多种： 我们可以将配置内容写入application.yml 设置多个profile，也可以用多个application-{profile}.properties文件配置 命令行参数 自定义配置文件 配置中心 以上，除了配置中心，其他方式都不能动...
springcloud+consul配置中心、服务注册
鸢尾_的博客
01-04 2553
consul配置中心、服务注册 简介 consul用于微服务下的服务治理，主要特点有：服务发现、服务配置、健康检查、键值存储、安全服务通信、多数据中心等 关于consul的安装和持久化就不再赘叙，有兴趣可以去windows+consul安装及持久化看一下 配置中心 添加maven依赖 <!--cloud consul 配置中心--> <dependency> <groupId>org.springframework.cloud</groupId&gt
Spring Cloud Consul 中文参考手册
Mr_chen的博客
01-09 922
Spring Cloud Consul 中文参考手册 Spring Cloud Consul 1.2.0.RELEASE 该项目通过自动配置并绑定到Spring环境和其他Spring编程模型成语，为Spring Boot应用程序提供Consul集成。通过几个简单的注释，您可以快速启用和配置应用程序中的常见模式，并使用基于Consul的组件构建大型分布式系统。提供的模式包括服务发现，控制总线和...
服务治理consul之配置中心
qq_36851469的博客
08-25 743
作为配置中心是通过核心类实现的。
配置中心-Consul(一)
华小灼
04-03 2398
配置中心-Consul
使用consul作为配置中心
haohaoxuexiyai的博客
05-06 224
https://www.cnblogs.com/jpfss/p/11319234.html
微服务系列之Consul配置中心
qq_41490913的博客
05-20 378
微服务系列之Consul配置中心
.NETCore微服务之基于Consul实现服务治理
02-25
Consul是HashiCorp公司推出的开源工具，用于实现分布式系统的服务发现与配置。与其他分布式服务注册与发现的方案，比如Airbnb的SmartStack等相比，Consul的方案更“一站式”，内置了服务注册与发现框架、分布一致性...
.NET Core 3.0之创建基于Consul的Configuration扩展组件
01-20
相信大家对Consul已经比较了解了，很多项目都会使用Consul作为配置中心，此处也不做其他阐述了，主要是讲一下，创建Consul配置扩展的一些思路。使用Consul配置功能时，我们可以将信息转成JSON格式后再存储，那么我们...
hazelcast-consul-discovery-spi:基于Consul的发现策略SPI，用于启用Hazelcast的应用程序
05-23
hazelcast领事发现spi 为启用了Hazlecast 3.6+的应用程序提供基于Consul的发现策略。 这是一种易于配置的即插即用Hazlecast DiscoveryStrategy，可有选择地向Consul注册您的每个Hazelcast实例，并使Hazelcast节点...
consul-alerts：一个简单的守护程序，用于基于Consul运行状况检查发送通知
02-27
创建通知配置文件，一组通知程序的功能，当超过可配置的阈值时，这些通知程序将响应给定的警报 警报的通知者和黑名单的多级自定义（服务，检查ID或主机） 要求 领事0.4+。 得到它。 配置的GOPATH 。 发布 稳定的...
consul-系统学习3-springBoot整合Consul
zhou920786312的博客
03-03 1706
一、springBoot+Consul注册中心 1.1、代码 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
配置中心—Consul配置管理
weixin_37648525的博客
04-19 8324
配置中心—Consul配置管理Consul Key/Value存储.Net Core集成Consul配置中心 Consul Key/Value存储 Consul 是 HashiCorp 公司推出的开源工具，用于实现分布式系统的服务发现与配置。与其它分布式服务注册与发现的方案，Consul 的方案更“一站式”，内置了服务注册与发现框架、分布式一致性协议实现、健康检查、Key/Value 存储（配置中心）、多数据中心方案，不再需要依赖其它工具（比如 ZooKeeper 等），使用起来也较为简单。 请注意这里，C
使用consul做为配置中心
llianlianpay的博客
01-10 2897
config: enabled: true data-key: myconf format: PROPERTIES@ConfigurationProperties() public class Config { private String name;缺点：不能自动更新 Consul-template 是C
SpringCloud使用Consul作为配置中心
怪咖@的博客
07-03 4817
这一篇文章我们主要学习Consul作为配置中心来使用，每一个步骤都很详细，包括Consul管理界面的介绍与使用，Consul和SpringCloud的Config相比较而言，不需要额外的git、svn、数据库等配合，且无需配合Bus即可实现配置刷新。......
consul再探--作为配置中心
qq_44691484的博客
05-09 83
以往spring cloud项目中，consul作为注册中心，将接口注册到consul中，方便作为服务方被调用； 最近在新项目组，发现也可以作为配置中心使用： consul配置 2. 使用
基于consul配置skywalking告警
最新发布
01-13
基于Consul配置Skywalking告警的步骤如下： 1. 在Consul中创建一个新的Key-Value存储路径，用于存储Skywalking的告警配置信息。 2. 在Consul中设置告警规则的配置信息。可以使用Consul的API或者Consul的Web界面来...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值