统一配置管理
我们已经搭建了两个微服务,每个微服务里的业务都需要去完成数据库查询。并且我们服务之间还会有一个相互调用,而要完成相互调用,我们的做法是让服务注册到注册中心,然后消费者就可以从注册中心里完成服务的发现,实现这个服务获取和负载均衡,完成远程调用。
随着微服务越来越多,我们在生产环境中可能会达到数十上百甚至上千台服务器的这种情况假设现在的一个配置文件需要去做一些修改,而这个配置文件可能跟我们的数十个微服务都有关系,那这个时候我是不是得逐个微服务的去调整这个配置?
我调整完了配置以后,这些个关联的服务是不是都得重启呀?那么在生产环境下,一个服务重启带来的这个影响还是挺大的。
所以说我们希望这些配置文件能够实现一种统一的管理。比如说我现在有数十个服务的配置需要修改,我不需要逐个去修改,而是在一个地方完成这个改动就行了。并且改动完了以后,希望这个服务不用去做重启这些配置就立马能够生效,这就叫配置的热更新。
配置管理服务会去记录我们微服务中的一些核心的配置放到上面去。微服务启动的时候,就可以去读取它上面的配置再和本地的配置结合作为完整配置去使用了。
将来这些核心配置需要发生一些修改,我们不用逐个服务改动,而是找到这个配置管理的服务,把需要变化的配置改一改就行了。
配置管理服务发现改动会立即去通知微服务,然后微服务完成配置的读取,并且后续还能完成配置的热更新。
在Nacos中添加配置信息:
一开始点击Nacos配置列表,是什么都没有的。我们这时候需要去添加配置,并交给 Nacos 去做管理。
配置获取的步骤如下:
项目启动以后,会优先读取bootstrap.yml, 只要把 Nacos 地址放在这个文件,后续就可以先读取Nacos配置文件,再读取本地文件进行合并。
<!--nacos配置管理依赖-->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
2.在userservice中的resource目录添加一个bootstrap.yml文件,这个文件是引导文件,优先级高于application.yml:
spring:
application:
name: userservice #服务名称
profiles:
active: dev #开发环境
cloud:
nacos:
server-addr: localhost:8848 #nacos地址
config:
file-extension: yaml #文件后缀名
再原先application.yml配置中重复的进行去除
我们在user-service中将pattern.dateformat这个属性注入到UserController中做测试:
package cn.itcast.user.web;
import org.springframework.beans.factory.annotation.Value;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
@Slf4j
@RestController
@RequestMapping("/user")
public class UserController {
@Value("${pattern.dateformat}")
private String dateformat;
@GetMapping("now")
public String now(){
return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));
}
}
启动两个相同userservice服务,访问都可以得到时间,证明配置已经是能够统一管理了。
将配置交给Nacos管理的步骤
①在Nacos中添加配置文件
②在微服务中引入nacos的config依赖
③在微服务中添加bootstrap.yml,配置nacos地址、当前环境、服务名称、文件后缀名。这些决定了程序启动时去nacos读取哪个文件
配置热更新
Nacos中的配置文件变更后,微服务无需重启就可以感知。不过需要通过下面两种配置实现:
方式一:在@Value注入的变量所在类上添加注解@RefreshScope
package cn.itcast.user.web;
@Slf4j
@RestController
@RequestMapping("/user")
@RefreshScope
public class UserController {
@Value("${pattern.dateformat}")
private String dateformat;
}
方式二:使用@ConfigurationProperties注解
package cn.itcast.user.config;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Data
@Component
@ConfigurationProperties(prefix = "pattern")
public class PatternProperties {
private String dateformat;
}
@Slf4j
@RestController
@RequestMapping("/user")
@RefreshScope
public class UserController {
@Autowired
private PatternProperties properties;
@GetMapping("now")
public String now(){
return LocalDateTime.now().format(DateTimeFormatter.ofPattern(properties.getDateformat()));
}
}
访问服务,然后修改配置不重启
日志也会记录配置更改了
注意事项:
- 不是所有的配置都适合放到配置中心,维护起来比较麻烦
- 建议将一些关键参数,需要运行时调整的参数放到nacos配置中心,一般都是自定义配置
配置共享
微服务启动时会从nacos读取多个配置文件:
- [spring.application.name]-[spring.profiles.active].yaml,例如:userservice-dev.yaml
- [spring.application.name].yaml,例如:userservice.yaml
无论profile如何变化,[spring.application.name].yaml这个文件一定会加载,因此多环境共享配置可以写入这个文件
@Data
@Component
@ConfigurationProperties(prefix = "pattern")
public class PatternProperties {
private String envSharedValue;
}
//在controller增加
@GetMapping("prop")
public PatternProperties properties(){
return properties;
}
启动两个userservice服务,然后启动第三个,但这第三个修改环境为测试环境test,点击服务按ctrl + f4
多种配置的优先级:
不同微服务之间可以共享配置文件,通过下面的两种方式来指定:
spring:
cloud:
nacos:
server-addr: localhost:8848 # Nacos地址
config:
file-extension: yaml # 文件后缀名
shared-configs: # 多微服务间共享的配置列表
-dataId: common.yaml # 要共享的配置文件id
spring:
cloud:
nacos:
server-addr: localhost:8848 # Nacos地址
config:
file-extension: yaml # 文件后缀名
extends-configs: # 多微服务间共享的配置列表
- dataId: extend.yaml # 要共享的配置文件id