提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档
前言
当项目运行需要多个微服务集群时,就需要大量的重复配置,config优化了这一点,将微服务集群中的重复配置放到gitee之类的版本管理工具上,微服务通过config server获取gitee上的重复配置,以及消息总线bus实现的配置自动更新。
文中只实现了简单的案例来学习功能实现
- 建议使用spring initializr创建服务
- 文中springboot版本为2.4.6
一、依赖
config server依赖
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--spring cloud config依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</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>
<!--spring cloud bus依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-bus-amqp</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
config client 端,实际环境中不存在特定的client端,所有需要配置管理的的都是client
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-bootstrap</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>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.0</version>
</dependency>
<!-- spring cloud bus依赖 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-bus-amqp</artifactId>
</dependency>
<!-- 语法糖,偷懒用依赖 -->
<!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-api -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.25</version>
</dependency>
<!-- 语法糖,偷懒用依赖 -->
<!-- https://mvnrepository.com/artifact/ch.qos.logback/logback-classic -->
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.2.3</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
二、config
1.server端
启动类加入@EnableConfigServer注解
yml配置
server:
port: 8800
spring:
application:
name: congfigServer
cloud:
consul:
host: localhost
port: 8500
config:
server:
git:
uri: https://gitee.com/lkf3250/config.git #git克隆地址
default-label: master #所在分支
此时,如果git上有配置文件,就已经可以再网页上看到配置项了
访问地址 http://localhost:端口号/文件名-环境.yml,无环境时默认xxxx
2.client端
yml文件
client端启动时,会按yml配置启动,由于配置缺失,启动会报错
解决:cloud为了功能执行提供了相应的解决方法,把application.yml更名为bootstrap.yml即可
详细见https://blog.csdn.net/youanyyou/article/details/81178311
spring:
application:
name: congfigclient
cloud:
consul:
host: localhost
port: 8500
config:
discovery:
service-id: congfigServer #服务名
#开启根据服务名获取
enabled: true
label: master #分支
name: defaultConfig #文件名
profile: dev #环境
management:
endpoints:
web:
exposure:
include: "*"
由于在实际环境中server端也可能是集群部署,可以通过服务名找到server,再通过server获取配置
git上创建两个配置文件
测试配置
默认配置
client端会获取 defaultConfig.yml和defaultConfig-dev.yml的合并配置
写一个方法获取并返回配置中的name值
@Slf4j
@RestController
@RefreshScope //再不重启服务器的情况下获取最新的配置信息
//@EnableAutoConfiguration
public class textcontroller {
@Value("${name}")
private String name;
@Value("${name1}")
private String name1;
@RequestMapping(value = "/t" )
public String textc(){
log.info("client linked");
return "client linked"+name+"/"+name1;
}
}
访问http://localhost:8801/t 获取到name和name1的值
都这里client已经通过server获取到git上的配置,git上有配置更新时,可以手动通过post请求http://127.0.0.1:8801/actuator/refresh更新配置,但是实际情况中client不只有一个端口,这里就需要一个组件去通知复数个client去请求配置更新。
三、cloud bus实现配置自动更新
bus组件需要消息中间件来实现,bus依赖中自带rabbitmq依赖,所以文中选用rabbitmq
加入依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-bus-amqp</artifactId>
</dependency>
由于有bus做广播,我们向server端发送post请求通过bus广播给复数个client,向通过server请求配置。
bus需要rabbitmq做异步处理所以cerver和client端需要做rabbitmq的连接配置,多个client端的mq配置相同所以可以放在git的公共配置里
更新配置文件
server端yml
server:
port: 8800
spring:
application:
name: congfigServer
cloud:
consul:
host: localhost
port: 8500
config:
server:
git:
uri: https://gitee.com/lkf3250/config.git
default-label: master
rabbitmq:
host: localhost
port: 5672
username:
password:
management:
endpoints:
web:
exposure:
include: "*"
client端yml
server:
port: 8801 #由于要建集群,把端口号放回本地配置
spring:
application:
name: congfigclient
cloud:
consul:
host: localhost
port: 8500
config:
fail-fast: true
discovery:
service-id: congfigServer #服务名
#开启根据服务名获取
enabled: true
label: master #分支
name: defaultConfig #文件名
profile: dev #环境
#rabbit配置放在git的公共配置里
# rabbitmq:
# host: 172.0.0.1
# port: 5672
# username: guest
# password: hhgz3250
management:
endpoints:
web:
exposure:
include: "*"
此时就可以实现自动配置了,更新配置后,从server端口请求 http://127.0.0.1:8800/actuator/busrefresh
若要对指定集群更新配置,可以请求http://127.0.0.1:8800/actuator/busrefresh/服务名
结束!