在微服务项目中,最让人无语的是到处是配置文件,有时候为了修改配置文件还得重启项目,极大的增加了运维的难度,springCloud-consul动态配置的出现,解决了这一难题。
导包(pom.xml):
<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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>springCloud-consul</groupId>
<artifactId>springCloud-consul</artifactId>
<version>0.0.1-SNAPSHOT</version>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.3.0.RELEASE</version>
<relativePath /> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<spring-cloud.version>Hoxton.SR6</spring-cloud.version>
</properties>
<dependencies>
<!-- 健康监控 -->
<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-discovery</artifactId>
</dependency>
<!-- 动态配置 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-consul-config</artifactId>
</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>
<repositories>
<repository>
<id>spring-milestones</id>
<name>Spring Milestones</name>
<url>https://repo.spring.io/milestone</url>
</repository>
</repositories>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<fork>true</fork>
</configuration>
</plugin>
</plugins>
</build>
</project>
bootstrap.yml
spring:
cloud:
consul:
host: localhost
port: 8500
#token: 2f486e6c-8df3-3638-b935-32f318ebc1d3
#enabled将此值设置为“false”禁用Consul配置
config:
enabled: true #默认是true --
format: YAML # 表示consul上面文件的格式 有四种 YAML PROPERTIES KEY-VALUE FILES
data-key: data #表示consul上面的KEY值(或者说文件的名字) 默认是data
prefix: config
# 设置配置的分隔符
profile-separator: ':'
# watch选项为配置监视功能,主要监视配置的改变
watch:
enabled: true # 启用监视
delay: 1000 # 监视间隔时间
wait-time: 30
application.yml
server:
port: 8504
spring:
application:
name: spring-cloud-consul-producer1
profiles:
active: dev
cloud:
consul:
#host: localhost
#port: 8500
#token: 245d0a09-7139-bbea-aadc-ff170a0562b1
discovery:
serviceName: service-producer1
# 启用服务注册
register: true
# 启用服务发现
enabled: false
# 执行监控检查的频率
health-check-interval: 5s
# 健康检查失败多长时间后,取消注册
health-check-critical-timeout: 5s
# 服务停止时取消注册
deregister: true
# 表示注册时使用IP而不是hostname
prefer-ip-address: true
在使用动态配置时,必须配置bootstrap.yml,bootstrap优先于application加载,关于动态配置的配置需要编写到bootstrap.yml中
启动类
@EnableDiscoveryClient
@EnableFeignClients
//定时拉取
@EnableScheduling
public class AssetApplication {
public static void main(String[] args) {
SpringApplication.run(AssetApplication.class, args);
}
}
controller
@RestController
@RefreshScope //强制更新
public class ControllerTest {
@Value("${student.name}")
private String name;
@RequestMapping("/hello2")
public String hello(){
return name;
}
}
controller中的student.name中的内容便是利用consul中的key/value配置的
点击create进行创建配置文件,如图
1.config代表的是前缀,spring-cloud-consul-producer1是容器名称,dev是配置是开发配置还是线上配置,data是文件名称,这一段就相当于是一个路径,根据路径找到配置文件的内容,至于为什么这个路径这样配置,需参考bootstrap.yml中的配置
2.配置中各个属性的值,如果3选择的是yaml就按照yml编写就好了。
3.代表的是配置文件的格式,在bootstrap.yml 中通过format: YAML配置,
4.保存
启动项目,调用hello2接口,可以看到返回结果,之后重新编写key/value配置文件中的内容,间隔几秒之后再次请求接口便发现动态配置已经生效
如有疑问与错误请在下方评论!