Nacos配置管理

123 阅读3分钟

一、统一配置管理

当微服务部署的实例越来越多,达到数十、数百时,逐个修改微服务配置就会让人抓狂,而且很容易出错。我们需要一种统一配置管理方案,可以集中管理所有实例的配置。

image.pngNacos一方面可以将配置集中管理,另一方可以在配置变更时,及时通知微服务,实现配置的热更新。

1.1 在nacos中添加配置文件

如何在nacos中管理配置呢?

image.png 然后在弹出的表单中,填写配置信息:

image.png 注意:项目的核心配置,需要热更新的配置才有放到nacos管理的必要。基本不会变更的一些配置还是保存在微服务本地比较好。

1.2 从微服务拉取配置

微服务要拉取nacos中管理的配置,并且与本地的application.yml配置合并,才能完成项目启动。但如果尚未读取application.yml,又如何得知nacos地址呢?因此spring引入了一种新的配置文件:bootstrap.yaml文件,会在application.yml之前被读取,流程如下:

image.png 1)引入nacos-config依赖

首先,在user-service服务中,引入nacos-config的客户端依赖:

 <!--nacos配置管理依赖-->
 <dependency>
     <groupId>com.alibaba.cloud</groupId>
     <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
 </dependency>

2)添加bootstrap.yaml

然后,在user-service中添加一个bootstrap.yaml文件,内容如下:

spring:
  application:
    name: userservice # 服务名称
  profiles:
    active: dev #开发环境,这里是dev 
  cloud:
    nacos:
      server-addr: localhost:8848 # Nacos地址
      config:
        file-extension: yaml # 文件后缀名

这里会根据spring.cloud.nacos.server-addr获取nacos地址,再根据

${spring.application.name}-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}作为文件id,来读取配置。

3)读取nacos配置

在user-service中的UserController中添加业务逻辑,读取pattern.dateformat配置:

image.png 在页面访问,可以看到效果:

image.png

二、配置热更新

我们最终的目的,是修改nacos中的配置后,微服务中无需重启即可让配置生效,也就是配置热更新。要实现配置热更新,可以使用两种方式:

1)方式一 在@Value注入的变量所在类上添加注解@RefreshScope

image.png 2)方式二

使用@ConfigurationProperties注解代替@Value注解。 在user-service服务中,添加一个类,读取patterrn.dateformat属性:

@Component
@Data
@ConfigurationProperties(prefix = "pattern")
public class PatternProperties {
    private String dateformat;
}

在UserController中使用这个类代替@Value:

image.png

三、配置共享

其实微服务启动时,会去nacos读取多个配置文件,例如:

  • [spring.application.name]-[spring.profiles.active].yaml,例如:userservice-dev.yaml
  • [spring.application.name].yaml,例如:userservice.yaml

[spring.application.name].yaml不包含环境,因此可以被多个环境共享。

1)添加一个环境共享配置

我们在nacos中添加一个userservice.yaml文件:

image.png 2)在user-service中读取共享配置

在user-service服务中,修改PatternProperties类,读取新添加的属性:

image.png在user-service服务中,修改UserController,添加一个方法:

image.png 3)运行两个UserApplication,使用不同的profile

修改UserApplication2这个启动项,改变其profile值:

image.png

image.png 这样,UserApplication(8081)使用的profile是dev,UserApplication2(8082)使用的profile是test。

访问http://localhost:8081/user/prop,结果:

image.png 访问http://localhost:8082/user/prop,结果:

image.png 可以看出来,不管是dev,还是test环境,都读取到了envSharedValue这个属性的值。

4)配置共享的优先级

image.png

spring:
  cloud:
    config:
      # 如果本地配置优先级高,那么 override-none 设置为 true,包括系统环境变量、本地配置文件等配置
      override-none: true
      # 如果想要远程配置优先级高,那么 allow-override 设置为 false,如果想要本地配置优先级高那么 allow-override 设置为 true
      allow-override: true
      # 只有系统环境变量或者系统属性才能覆盖远程配置文件的配置,本地配置文件中配置优先级低于远程配置;注意本地配置文件不是系统属性
      override-system-properties: false