首页 > 其他分享 >Spring Cloud开发实践(七): 集成Consul配置中心

Spring Cloud开发实践(七): 集成Consul配置中心

时间:2023-06-01 18:33:07浏览次数:47  
标签:Spring Consul data cloud spring config consul Cloud

目录

Spring Cloud Consul Config

Consul 通过 Key/Value 功能集中管理存储配置信息, 通过 Spring Cloud Consul Config 可以实现 Config Server 和 Client 的关联. 在 Spring 启动的 bootstrap 阶段, 配置会被载入环境上下文.

配置前缀, 路径和优先级

默认情况下, 配置的路径前缀是 /config , 不同的 application 和 profile 对应不同的配置路径, 例如对应应用 "testApp" 和 "dev" profile 的配置, 会涉及以下路径

config/testApp,dev/
config/testApp/
config/application,dev/
config/application/

这个列表从上往下分别对应的配置优先级从高到低, 优先级高的同样配置项会覆盖优先级低的配置项.

  • config/application/ 全局公共配置, 对应使用 config 前缀的所有应用
  • config/application,dev/ 全局dev公共配置, 对应使用 config 前缀的所有, 且启用 dev profile 的应用
  • config/testApp/ 对应使用 config 前缀的, 名称为 testApp 的应用
  • config/testApp,dev/ 对应使用 config 前缀的, 名称为 testApp, 且启用 dev profile 的应用

注意: 配置对应的 profile 和节点应用名是平级的, config/service-name,dev/data 这样, data 是配置的子项, 不要把 profile 加到 data 去了

在项目中启用 Consul Config

如果要使用 Consul 的分布式配置(Distributed Configuration), 需要添加 spring-cloud-starter-consul-config 的依赖

spring-cloud-starter-consul-discovery 不带 spring-cloud-starter-consul-config, 如果需要用 Consul Config, 需要单独添加依赖

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

也可以直接用 spring-cloud-starter-consul-all, 包含了 spring-cloud-starter-consul-discovery 和 spring-cloud-starter-consul-config

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

配置文件 application.yml

添加了 consul-config 依赖之后, 在 application.yml 就要增加对应的设置 spring.config.import = consul: 否则启动会报错,
Spring Boot 在 2.4 版本之后新增了这个项(spring.config.import property)用于导入配置, 并且是默认的配置方式.

# properties
spring.config.import=optional:consul:
# yaml
spring:
  config:
    import: 'consul:'

上面的配置, 如果启动时import失败会导致启动失败, 如果不强制 import, 可以加上 optional:

# properties
spring.config.import=optional:consul:
# yaml
spring:
  config:
  import: 'optional:consul:'

上面的这两个配置, 都会用默认的地址 http://localhost:8500 去请求 Consul 服务, 如果需要自定义地址, 可以通过配置spring.cloud.consul.hostspring.cloud.consul.port,

spring:
  cloud:
    consul:
      host: 10.123.123.123
      port: 8501

或者使用

spring.config.import=optional:consul:myhost:8500

对应以上配置, 在 Spring 启动的 bootstrap 阶段会通过 Consul 去获取 key = config/dummy-service/data 对应的 value (假定这个模块的 application.name = dummy-service),
对应value格式为 yaml, 需要增加配置

# yaml
spring:
  cloud:
    consul:
      config:
        format: YAML
        prefix: config
        data-key: data

其中

  • format: YAML 设置配置格式
  • prefix: config修改 config/dummy-service/data 的前缀
  • data-key: data修改 config/dummy-service/data 的后缀

默认的请求路径生成基于

  1. spring.cloud.consul.config.name , 值默认等于 spring.application.name
  2. spring.cloud.consul.config.default-context , 这个值默认等于 application
  3. spring.profiles.active , 可以在启动时通过 VM Option -Dspring.profiles.active=xxx 指定

如果不想用默认的, 想自己指定, 可以用如下的方式

# properties
spring.config.import=optional:consul:myhost:8500/config/custom/context/one;/config/custom/context/two

上面的设置将只从这两个Key/Value路径读取配置, 注意路径的对应关系, 在import中体现前缀 config, 但是不体现后缀 data

  • /config/custom/context/one/data
  • /config/custom/context/two/data

配置自动更新, Config Watch

Consul Config Watch 使用 consul 的路径前缀对配置更新进行检查, 当配置变化时会产生一个 Refresh Event, 等价于请求 /refresh actuator endpoint.

默认的检查频率为 1000 单位毫秒, 可以通过 spring.cloud.consul.config.watch.delay 配置

如果要禁用配置自动更新, 需要设置 spring.cloud.consul.config.watch.enabled=false

Consul 配置管理

通过 WEB 界面

默认为 http://127.0.0.1:8500 可以在 Key/Value 中直接添加, 记得格式要改为 YAML

通过命令行

读取

$ ./consul kv get foo
bar

$ ./consul kv get config/application/data
cassandra:
  host: 127.0.0.1:9042,127.0.0.2:9042
  user: my_user
  password: my_pass

使用文件data.yml中的内容, 直接写入

$  ./consul kv put config/application/data @data.yml
Success! Data written to: config/application/data
The data can be retrieved the same way,

使用配置

经过以上配置, 在项目中就可以通过 @Configuration 获取 Consul 中配置的信息

@Slf4j
@Configuration
public class CommonConfig {
    @Value("${common.name}")
    private String name = "Dummy";
    @Value("${common.code}")
    private String code = "001";

    public String getName() {return name;}
    public void setName(String name) {this.name = name;}
    public String getCode() {return code;}
    public void setCode(String code) {this.code = code;}

    @PostConstruct
    public void postConstruct() {
        log.info("name: {}", name);
        log.info("code: {}", code);
    }
}

参考

标签:Spring,Consul,data,cloud,spring,config,consul,Cloud
From: https://www.cnblogs.com/milton/p/17448461.html

相关文章

  • SMU Spring 2023 Trial Contest Round 11
    A.TheTextSplitting题意:给出字符串长度,给出p和q两种切割方式,任选其中一种,把字符串分割输出结果。 题解:先进行判断,p和q是否能整个的分割n,利用p和q的函数关系判断(见代码),再计算有几个p几个q,再进行输出即可voidsolve(){cin>>n>>p>>q;cin>>s;if(p>......
  • 手把手教你Spring Cloud Alibaba教程:使用Nacos作为配置中心
    我们在上面:手把手教你SpringCloudAlibaba教程:nacos安装手把手教你SpringCloudAlibaba教程:使用nacos实现服务注册与发现了解了nacos和springCloudAlibaba的部署和使用,现在我们来了解下nacos作为配置中心应该如何使用。Nacos除了实现了服务的注册发现之外,还将配置中心功能整合......
  • springBoot+下载
    在springBoot我们上次文件和其他相比,就简单不少,现在我们在SpringBoot的基本框架基础上添加上传图片。一:没有新的jar包,但是在原有的jar包中必须需要有如下jar包。<parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId......
  • Spring Boot架构中添加Swagger
    基于SpringBoot+Springmvc+mybatis+mybatis-generator代码自动生成架。在上面的文章中我们实行了基本springBoot架构,接下来我们给这个架构添加swagger接口调试:一:添加相应jar包,在pom.xml中添加如下代码:<!--swagger2配置pom开始--><dependency><groupId>io.springfox</groupId>......
  • SpringBoot中定时任务多线程任务
    SpringBoot使用Spring自带的Schedule来实现定时任务变得非常简单和方便。在这里个大家分享下。开启缓存注解@SpringBootApplication@EnableScheduling//开启定时任务publicclassApplication{publicstaticvoidmain(String[]args){SpringApplicat......
  • spring事务失效的场景
    spring事务失效的场景1.访问权限在AbstractFallbackTransactionAttributeSource类的computeTransactionAttribute方法中有个判断,如果目标方法不是public,则TransactionAttribute返回null,即不支持事务。也就是说,如果我们自定义的事务方法(即目标方法),它的访问权限不是public,而......
  • Spring的AOP复习
     连接点:所有业务方法切入点:被挖掉共性功能的业务方法 通知:共性功能构成的方法通知类型:前面还是后面  切面:描述切入点和通知的关系 目标对象 织入:将共性功能放回去 代理引入......
  • spring StateMachine简易使用
    SpringStateMachine是一个状态机框架,在Spring框架项目中,开发者可以通过简单的配置就能获得一个业务状态机,而不需要自己去管理状态机的定义、初始化等过程。今天这篇文章,我们通过一个案例学习下SpringStateMachine框架的用法。 pom依赖中添加<parent><groupId>org.......
  • SpringBoot项目中实现读写分离
    背景介绍面对日益增加的系统访问量,数据库的吞吐量面临着巨大瓶颈。对于同一时刻有大量并发读操作和较少写操作类型的应用系统来说,将数据库拆分为主库和从库,主库负责处理事务性的增删改操作,从库负责处理查询操作,能够有效的避免由数据更新导致的行锁,使得整个系统的查询性能得到极......
  • 前后端分离的架构,前端使用Vue2.6.10,后端使用SpringBoot2.0.0的ERP实现
    技术架构技术框架:SpringBoot2.0.0+Mybatis1.3.2+SLF4J1.7+Vue2.6.10+Ant-Design-Vue1.5.2+Mysql5.7+Redis运行环境:jdk8+IntelliJIDEA+maven+宝塔面板本地部署:1.小皮面板创建一个数据库,导入jsh_erp.sql文件至数据库中,该文件在后端程序的docs文件夹下。2.使用......