1. spring cloud config server
1.1 引入pom
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
</dependency>
1.2 在启动类上添加注解 @EnableConfigServer
1.3 基于文件系统配置
1.3.1 在application.yml中添加配置
使用文件系统时,最好使用{user.dir}来定义本地配置文件路径,因为ide的user.dir可根据不同的操作系统获取不同的绝对路径,这样可以防止不同操作系统带来的文件系统路径差异。我在resources文件夹下创建了configs文件夹来放远程配置
spring:
application:
name: spring-cloud-config-server
cloud:
config:
server:
git:
uri: ${user.dir}/src/main/resources/configs
1.3.2 创建配置文件,假设我的客户端应用名为tanfp,那么创建3个文件到configs文件夹下
tanfp-prod.properties
tanfp-test.properties
tanfp.properties
1.3.3 将这3个文件使用git初始化并提交到本地,这里不需要提交到云端
1.3.4 测试
/{application}/{profile}[/{label}]
/{application}-{profile}.yml
/{label}/{application}-{profile}.yml
/{application}-{profile}.properties
/{label}/{application}-{profile}.properties
比如:http://localhost:8080/tanfp/prod
tanfp表示配置文件的名称(不包括环境的部分)也即为应用名,prod表示环境
1.4 基于git远程仓库
spring:
application:
name: spring-cloud-config-server
cloud:
config:
server:
git:
# uri: ${user.dir}/src/main/resources/configs
#git 远程仓库地址
uri: http://xxxx
force-pull: true
然后测试即可
2. spring cloud config client
2.1 创建 Spring Cloud Config Client 应用,引入pom
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
2.2 ClassPath 下面创建 bootstrap.propertiesj,并配置(这里为什么不写在application.yml文件中呢?因为该客户端的配置需要通过config server获取,所以需要在该项目的application.yml加载之前加载成功)
## 配置客户端应用关联的应用
## spring.cloud.config.name 是可选的
## 如果没有配置,采用 ${spring.application.name}
spring.cloud.config.name = tanfp
## 关联 profile
spring.cloud.config.profile = prod
## 关联 label
spring.cloud.config.label = master
## 配置配置服务器URI
spring.cloud.config.uri = http://127.0.0.1:9090/
#当连接不上config server时能快速返回错误,而不是先加载其他的功能,这样能减少前置的加载内容
spring.cloud.config.fail-fast = true
2.3 配置application.properties
## 配置客户端应用名称
spring.application.name = spring-cloud-config-client
## 配置客户端应用服务端口
server.port = 8080
2.4 请求http://localhost:8080/env,判断配置是否加载成功
3.动态获取并加载配置
当项目启动后,如果在云端修改了配置,那么客户端并不能自动更新自己已经加载的配置
如:获取配置装载user对象
@ConfigurationProperties(prefix = "sf.user")
@Data
public class User {
private Long id;
private String name;
}
@RestController
@EnableConfigurationProperties(User.class)
public class UserController {
//通过构造器注入
private final User user;
@Autowired
public UserController(User user) {
this.user = user;
}
@GetMapping("/user")
public User user() {
return user;
}
}
如果此时我修改了远程仓库中user的属性id,那么访问http://localhost:8080/user 发现user对象并不会改变。
想要动态的改变user属性值,有多种办法,比如使用spring cloud的消息总线,我这里使用的是context的refresh方法进行定时刷新:
@SpringBootApplication
@EnableScheduling
public class ConfigClientDemoApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigClientDemoApplication.class, args);
}
private final ContextRefresher contextRefresher;
@Autowired
public ConfigClientDemoApplication(ContextRefresher contextRefresher) {
this.contextRefresher = contextRefresher;
}
/**
* 用于重新拉取config-server的配置,并且热加载配置项
*/
@Scheduled(fixedRate = 5000)
public void update() {
Set<String> keys = contextRefresher.refresh();
if (!keys.isEmpty()) {
System.out.println("本次更新的配置项: " + keys);
}
}
}
4. config server的集群配置
想要使用config server的集群,有两种:
1.直接启动多个config server服务,让这些服务都使用同一个远程仓库即可
2.使用eureka server的集群进行统一管理,比较推荐这种,可以统一管理应用服务
这里我们使用第二种方式进行集群实现
大致的架构思路即是将config server当作eureka的client注册到eureka的serverr端
4.1 加入依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
4.2 在application.yml中添加配置以指定服务注册中心的位置
#配置服务注册中心地址
eureka:
client:
serviceUrl:
defaultZone: http://localhost:8081/eureka/
4.3 在主类上添加@EnableDiscoveryClient注解
4.4 启动eureka server 和config server ,访问http://localhost:8081和http://localhost:9090/user查看结果
5 config client 添加到eureka server中以实现config client能从eureka server中查找到配置服务器
和config client类似
5.1 添加依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
5.2 添加启动类的注解
@SpringBootApplication
@EnableScheduling
@EnableDiscoveryClient
public class ConfigClientEurekaServerDemoApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigClientEurekaServerDemoApplication.class, args);
}
private final ContextRefresher contextRefresher;
@Autowired
public ConfigClientEurekaServerDemoApplication(ContextRefresher contextRefresher) {
this.contextRefresher = contextRefresher;
}
/**
* 用于重新拉取config-server的配置,并且热加载配置项
*/
@Scheduled(fixedRate = 5000)
public void update() {
Set<String> keys = contextRefresher.refresh();
if (!keys.isEmpty()) {
System.out.println("本次更新的配置项: " + keys);
}
}
}
5.3 配置bootstrap.yml文件
#应用名
spring:
application:
name: config-client-eureka-server
cloud:
config:
discovery:
#开启服务访问config server的功能
enabled: true
#指定config server注册的服务名
service-id: spring-cloud-config-server
#指定环境
profile: prod
#指定config server配置中的应用名(远程仓库的配置文件名称)
name: tanfp
#指定远程仓库的分支
label: master
#当连接不上config server时能快速返回错误,而不是先加载其他的功能,这样能减少前置的加载内容
fail-fast: true
server:
port: 9092
#配置服务注册中心地址
eureka:
client:
serviceUrl:
defaultZone: http://localhost:8081/eureka/
5.4 关闭actuator的安全
management:
endpoints:
web:
exposure:
include: "*"
5.5 controller和model包不变
然后启动项目访问http://localhost:9092/user,如果出现值则表示没有问题了