【微服务】7、Nacos配置管理

统一配置管理

在Nacos中添加配置信息:

在弹出表单中填写配置信息:

配置获取的步骤如下:

引入Nacos的配置管理客户端依赖:

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

在userservice中的resource目录添加一个bootstrap.yml文件,这个文件是引导文件,优先级高于application.yml:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
spring:
  application:
    name: user-service # 服务名称
  profiles:
    active: dev #开发环境,这里是dev 
  cloud:
    nacos:
      server-addr: localhost:8848 # Nacos地址
      config:
        file-extension: yaml # 文件后缀名

我们在user-service中将pattern.dateformat这个属性注入到UserController中做测试:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
@RestController
@RequestMapping("/user")
public class UserController {

    // 注入nacos中的配置属性
    @Value("${pattern.dateformat}")
    private String dateformat;

    // 编写controller,通过日期格式化器来格式化现在时间并返回
    @GetMapping("now")
    public String now(){
        return LocalDate.now().format(
            DateTimeFormatter.ofPattern(dateformat, Locale.CHINA)
        );
    }
    // ... 略
}

结果:

总结将配置交给Nacos管理的步骤

:::info ①在Nacos中添加配置文件

在微服务中引入nacosconfig依赖

在微服务中添加bootstrap.yml,配置nacos地址、当前环境、服务名称、文件后缀名。这些决定了程序启动时去nacos读取哪个文件

:::

配置自动刷新

Nacos中的配置文件变更后,微服务无需重启就可以感知。不过需要通过下面两种配置实现:

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

方式二:使用@ConfigurationProperties注解

然后在要使用配置的地方注入PatternProperties就可以使用了

Nacos配置更改后,微服务可以实现热更新,方式:

:::warning ①通过@Value注解注入,结合@RefreshScope来刷新

通过@ConfigurationProperties注入,自动刷新

:::

注意事项:

不是所有的配置都适合放到配置中心,维护起来比较麻烦

建议将一些关键参数,需要运行时调整的参数放到nacos配置中心,一般都是自定义配置

多环境配置共享

微服务启动时会从nacos读取多个配置文件:

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

无论profile如何变化,[spring.application.name].yaml这个文件一定会加载,因此多环境共享配置可以写入这个文件

优先级:

服务名-profile.yaml >服务名称.yaml > 本地配置

不常用:不同微服务之间可以共享配置文件,通过下面的两种方式来指定:

方式一:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
spring:
  application:
    name: userservice # 服务名称
  profiles:
    active: dev # 环境,
  cloud:
    nacos:
      server-addr: localhost:8848 # Nacos地址
      config:
        file-extension: yaml # 文件后缀名
        shared-configs: # 多微服务间共享的配置列表
          - dataId: common.yaml # 要共享的配置文件id

方式二:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
spring:
  application:
    name: userservice # 服务名称
  profiles:
    active: dev # 环境,
  cloud:
    nacos:
      server-addr: localhost:8848 # Nacos地址
      config:
        file-extension: yaml # 文件后缀名
        extends-configs: # 多微服务间共享的配置列表
          - dataId: extend.yaml # 要共享的配置文件id

多种配置的优先级:

服务名-profile.yaml >服务名称.yaml > extension-config > shared-config > 本地配置

使用 Hugo 构建
主题 StackJimmy 设计