Spring Cloud Alibaba - 学习笔记 - Nacos配置

布满荆棘的人生 2022-11-03 05:29 8阅读 0赞

### Spring Cloud Alibaba - 学习笔记 - 配置文件 ###

*  各类型配置文件常规用法
 *  基本概念
 *   *   *  推荐用法
 *  Nacos 配置加载规则
 *   *  指定加载
     *   *  1. dataID 默认
         *  2. group 默认
         *  3. namespace 默认
     *  加载多个
     *   *  扩展配置
         *  共享配置
         *  配置例子
 *  配置 - 优先级
 *   *  1. spring.profiles.active
     *  2. 按位置 - 优先级
     *  3. 按类型 - 优先级
     *  4. 按方式 - 优先级
 *  动态刷新
 *   *  方案一、通过 \`ConfigurableApplicationContext\` 上下文
     *  方案二、\`@RefreshScope\` 注解
     *  方案三、\`扩展配置、共享配置\`
 *  参考资料
 *  源码

# 各类型配置文件常规用法 #

`bootstrap.yml` ： 指定服务名称、nacos地址等，连接nacos 和读取配置必须的参数。  
`application.yml` ： 本地配置信息。一些常规的配置。  
`${spring.application.name}`\-`${profile}`.`${file-extension:properties}` ： nacos上配置，覆盖本地配置。放一些有动态调整需求的配置比如：数据源配置、redis地址等。

# 基本概念 #

<table> 
 <thead> 
  <tr> 
   <th>关键词</th> 
   <th>中文名字</th> 
   <th>默认值</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>namespace</td> 
   <td>命名空间</td> 
   <td>public</td> 
   <td>习惯上用于区分开发环境</td> 
  </tr> 
  <tr> 
   <td>group</td> 
   <td>组</td> 
   <td>DEFAULT_GROUP</td> 
   <td>习惯上用于区分项目，同一个项目放在一组</td> 
  </tr> 
  <tr> 
   <td>Data Id</td> 
   <td>配置文件唯一标识</td> 
   <td>应用名称+扩展名</td> 
   <td>对应配置文件名称。<code>注意扩展名保持一致否则读不到。</code></td> 
  </tr> 
 </tbody> 
</table>

### 推荐用法 ###

1.  官方推荐用 `Namespace` 区分环境，用 `Group` 分组管理业务。
2.  在启动参数中传入`-Dspring.profiles.active=dev|test|prod` 指定环境。

# Nacos 配置加载规则 #

## 指定加载 ##

`bootstrap.yml` 比较常见的写法。

spring:
      application:
        name: spring-cloud-alibaba-nacos-config # 应用名称
      cloud:
        nacos:
          config:
            server-addr: 127.0.0.1:8848 # nacos 地址。端口不能省略。
            file-extension: yml #配置文件扩展名

### 1. dataID 默认 ###

默认拼接：`${spring.cloud.nacos.config.prefix}`\-`${spring.profile.active}`.`${spring.cloud.nacos.config.file-extension}`

*  配置前缀 `spring.cloud.nacos.config.prefix` 默认值 `spring.application.name`（服务名）。
 *  当前环境 默认值 `spring.profiles.active` 。为空时链接符号`-`会自动去掉。
 *  配置格式 `spring.cloud.nacos.config.file-extension` 默认 `properties`。

简化后，有`profile`：`${spring.application.name}-${spring.profile.active}.properties`  
简化后，无`profile`：`${spring.application.name}.properties`

### 2. group 默认 ###

*  `group` 默认为 `DEFAULT_GROUP`，可通过 `spring.cloud.nacos.config.group` 配置。

### 3. namespace 默认 ###

*  `namespace` 默认 `Public`, 可通过 `spring.cloud.nacos.config.namespace` 配置。

## 加载多个 ##

### 扩展配置 ###

让应用加载多个配置

*  **`Deprecated`**  
    `spring.cloud.nacos.config.ext-config`：以数组方式指定配置
 *  `spring.cloud.nacos.config.extension-configs`：以数组方式指定配置

### 共享配置 ###

让多个应用共享配置（比如一些相同的公共配置）

*  **`Deprecated`**  
    只认 `DEFAULT_GROUP`  
    `spring.cloud.nacos.config.shared-dataids`：设置要`加载`的配置，多个用逗号分隔  
    `spring.cloud.nacos.config.refreshable-dataids`：设置要`自动刷新`的配置，多个用逗号分隔。不设默认不自动刷新。
 *  `spring.cloud.nacos.config.shared-configs`：以数组方式指定配置

### 配置例子 ###

官方参考：[spring-cloud-alibaba - nacos-config-example - bootstrap.properties][]

spring:
      application:
        name: spring-cloud-alibaba-nacos-config # 应用名称
      cloud:
        nacos:
          config:
            server-addr: 127.0.0.1:8848 # nacos 地址
            namespace: 993d636c-2d9c-4485-9bd3-d2de4ba14f63 # 这里指定test。不填默认空就是 public
    # group: DEFAULT_GROUP # 默认 DEFAULT_GROUP 可以省
            prefix: log # 配置前缀
            file-extension: properties #配置文件扩展名
    # file-extension: yml #配置文件扩展名
    # file-extension: yaml #配置文件扩展名
    
           # 设置多个配置
            extension-configs[0]:
              dataid: config-4.yml
              group: TEST_GROUP
              refresh: true # 自动刷新
            extension-configs[1]:
              dataid: config-5.yml
              group: TEST_GROUP
              refresh: true
            extension-configs[2]:
              dataid: config-6.yml
              group: TEST_GROUP
              refresh: true
    
            # 共享配置
            shared-configs:
              - dataid: config-1.yml
                refresh: true # 自动刷新
              - dataid: config-2.yml
                refresh: true
              - dataid: config-3.yml
                refresh: true

# 配置 - 优先级 #

## 1. spring.profiles.active ##

注意： `bootstrap` 正好与 `application` **相反**  
**文件名.profile**：带 `profile` > 不带 `profile` 的优先级：`bootstrap-dev.yaml` > `application.yaml`

## 2. 按位置 - 优先级 ##

`线上nacos` > `线下jar外` > `线下jar内`

线下`jar包内外`的优先级详见： [SpringBoot 学习笔记：配置文件基础知识 - 配置优先级][SpringBoot _ -]

## 3. 按类型 - 优先级 ##

先加载 `bootstrap` 后加载 `application`

<table> 
 <thead> 
  <tr> 
   <th>优先级</th> 
   <th>配置</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Top 1</td> 
   <td>nacos上：<code>${spring.application.name}</code>-<code>${profile}</code>.<code>${file-extension:properties}</code></td> 
  </tr> 
  <tr> 
   <td>Top 2</td> 
   <td>application.properties</td> 
  </tr> 
  <tr> 
   <td>Top 3</td> 
   <td>application.yml</td> 
  </tr> 
  <tr> 
   <td>Top 4</td> 
   <td>application.yaml</td> 
  </tr> 
  <tr> 
   <td>Top 5</td> 
   <td>bootstrap.properties</td> 
  </tr> 
  <tr> 
   <td>Top 6</td> 
   <td>bootstrap.yml</td> 
  </tr> 
  <tr> 
   <td>Top 7</td> 
   <td>bootstrap.yaml</td> 
  </tr> 
 </tbody> 
</table>

虽然这里列出来的很花哨，但正常来说项目中我们不可能这样混着写。

## 4. 按方式 - 优先级 ##

从高到底：

1.  `${spring.application.name}-${profile}.${file-extension}` 内置规则（此级别中类型优先级如上）
2.  扩展配置 `spring.cloud.nacos.config.extension-configs` 数组索引`大`的优先`高`
3.  共享配置 `spring.cloud.nacos.config.shared-configs` 数组索引`大`的优先`高`

[Spring Cloud Alibaba Nacos Config 目前提供了三种配置能力从 Nacos 拉取相关的配置][Spring Cloud Alibaba Nacos Config _ Nacos]

# 动态刷新 #

## 方案一、通过 `ConfigurableApplicationContext` 上下文 ##

@Autowired
    private ConfigurableApplicationContext context; // 就是启动类中 SpringApplication.run() 返回的对象。
    ...
    System.out.println("动态更新配置 > "+ context.getEnvironment().getProperty("配置文件中的key") );

## 方案二、`@RefreshScope` 注解 ##

在类上添加 `@RefreshScope` 开启内置配置自动刷新

## 方案三、`扩展配置、共享配置` ##

通过配置项`refresh = true` 开启。

# 参考资料 #

[官方文档：Nacos 系统参数介绍（启动nacos用的）][Nacos _nacos]  
[官方文档：Spring Cloud Alibaba Nacos Config][Spring Cloud Alibaba Nacos Config]  
[官方文档：Open API 指南（支持通过API接口方式操作 nacos）][Open API _API_ nacos]

[官方Demo：使用 Nacos Config Starter 完成 Spring Cloud 应用的配置管理][Demo_ Nacos Config Starter _ Spring Cloud]

[Spring Cloud Alibaba - 学习笔记 - 准备工作][Spring Cloud Alibaba - _ -]  
[Nacos 学习笔记：配置管理][Nacos]  
[SpringBoot 学习笔记：配置文件基础知识][SpringBoot]

# 源码 #

[本文Demo源码：代码在模块 spring-cloud-alibaba-nacos-config ][Demo_ spring-cloud-alibaba-nacos-config]

[spring-cloud-alibaba - nacos-config-example - bootstrap.properties]: https://github.com/alibaba/spring-cloud-alibaba/blob/29b955fffb1edbef552ed8a44b1b72dde7318a45/spring-cloud-alibaba-examples/nacos-example/nacos-config-example/src/main/resources/bootstrap.properties
[SpringBoot _ -]: https://blog.csdn.net/jx520/article/details/101567819
[Spring Cloud Alibaba Nacos Config _ Nacos]: https://github.com/alibaba/spring-cloud-alibaba/wiki/Nacos-config#%E9%85%8D%E7%BD%AE%E7%9A%84%E4%BC%98%E5%85%88%E7%BA%A7
[Nacos _nacos]: https://nacos.io/zh-cn/docs/system-configurations.html
[Spring Cloud Alibaba Nacos Config]: https://github.com/alibaba/spring-cloud-alibaba/wiki/Nacos-config
[Open API _API_ nacos]: https://nacos.io/zh-cn/docs/open-api.html
[Demo_ Nacos Config Starter _ Spring Cloud]: https://github.com/alibaba/spring-cloud-alibaba/blob/29b955fffb1edbef552ed8a44b1b72dde7318a45/spring-cloud-alibaba-examples/nacos-example/nacos-config-example/readme-zh.md
[Spring Cloud Alibaba - _ -]: https://jerryjin.blog.csdn.net/article/details/114136225
[Nacos]: https://jerryjin.blog.csdn.net/article/details/111715507
[SpringBoot]: https://jerryjin.blog.csdn.net/article/details/101567819
[Demo_ spring-cloud-alibaba-nacos-config]: https://gitee.com/jerryjin0630/spring-cloud-alibaba-demo