使用Nacos实现配置管理

前置条件

nacos需要先成功启动，前文已经说明方法，这里不再介绍，Nacos官网 (opens new window)

配置管理的优势

在分布式系统中，配置管理显得尤为重要。实现配置管理可以使系统更加便于监控，因为所有的配置信息都可以通过接口获取，可以很方便的查看配置信息是否改变，从而及时调整系统运行状态。

使用Nacos实现配置管理的优势主要有以下几点：

• 减少配置：将配置集中管理，避免了在各个服务中维护配置的问题。这样可以减少配置的错误和冗余，提高系统的稳定性。
• 动态更新：Nacos支持动态更新配置，可以快速地将配置的变化传递给各个服务。
• 高可用性和可扩展性：Nacos具有高可用性和可扩展性，可以支持大量的服务和配置。这样可以提高系统的可用性和性能。
• 灵活性：Nacos支持多种类型的配置，可以满足不同的业务需求。例如，Nacos支持配置文件、数据库、Redis等多种存储方式。

实现配置管理

在Nacos中进行配置

进入Nacos控制页面，在配置列表页面——进行新建配置,用于后续的调用

• Data ID：填入alibaba-nacos-config-demo.properties
• Group：不修改，使用默认值DEFAULT_GROUP
• 配置格式：选择Properties
• 配置内容：应用要加载的配置内容（开发中的配置信息就写到此处）。这里我随意写一点demo.title=demo-config-learning

其中Data ID的写法，nacos官网有个标准--应为如下格式：

${prefix}-${spring.profiles.active}.${file-extension}

• prefix 默认为 spring.application.name 的值，也可以通过配置项 spring.cloud.nacos.config.prefix来配置。
• spring.profiles.active 即为当前环境对应的 profile，详情可以参考 Spring Boot文档 (opens new window)。 注意：当 spring.profiles.active 为空时，对应的连接符 - 也将不存在，dataId 的拼接格式变成 ${prefix}.${file-extension}
• file-exetension 为配置内容的数据格式，可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。目前只支持 properties 和 yaml 类型。

引入依赖

其中spring-cloud-starter-alibaba-nacos-config是实现配置管理的包

<properties>
        <java.version>1.8</java.version>
        <spring.cloud.version>2021.0.1</spring.cloud.version>
        <spring-cloud-alibaba.version>2021.0.1.0</spring-cloud-alibaba.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring.cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${spring-cloud-alibaba.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
				<!-- nacos 启用配置管理-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-bootstrap</artifactId>
        </dependency>


        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
      </dependencies>

配置bootstrap.properties

在 bootstrap.properties 中配置 Nacos server 的地址和应用名

spring.cloud.nacos.config.server-addr=127.0.0.1:8848

spring.application.name=alibaba-nacos-config-demo

其中spring.application.name值必须与之前Nacos中配置的Data Id匹配。

bootstrap.properties和application.properties是Spring Boot中的两种不同的配置文件，它们在使用场景和加载顺序上有一些区别

• application.properties是应用程序的主要配置文件，用于配置应用程序的各种属性和行为，包含了应用程序特定的配置信息，如数据库连接、日志级别、Web服务器端口等；
• bootstrap.properties是用于配置Spring Boot的基础设施和全局属性的配置文件，主要用于加载外部配置和配置基础设施，如服务发现、分布式配置中心、安全认证等。

bootstrap.properties在Spring Boot应用程序启动时优先于最先application.properties加载，但若两者中出现同样的配置，则application.properties的配置会优先覆盖bootstrap.properties的配置

Spring Boot 2.4版本开始，对配置文件加载方式进行了重构，只会识别application.* 配置文件，并不会自动识别bootstrap.yml；

如果直接写入bootstrap.yml(或bootstrap.properties)则不生效，需要引入新依赖

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-bootstrap</artifactId>
</dependency>

项目实现

定义Controller，其中通过@Value注解，注入了来自配置中心——key为demo.title的配置。

@RestController
@RefreshScope
public class TestController {

    @Value("${demo.title}")
    private String title;

    @GetMapping("/test")
    public String hello() {
        return title;
    }
}

加上注解@RefreshScope，可以使该类下的配置内容支持动态刷新，也就是当我们的应用启动之后，修改了Nacos中的配置内容之后，这里也会马上生效。

最后，启动项目，如果在输出日志中看到如下内容，即为读取配置成功

2023-10-11 20:22:46.414  INFO 24305 --- [           main] c.a.c.n.refresh.NacosContextRefresher    : listening config: dataId=alibaba-nacos-config-client, group=DEFAULT_GROUP
2023-10-11 20:22:46.414  INFO 24305 --- [           main] c.a.c.n.refresh.NacosContextRefresher    : listening config: dataId=alibaba-nacos-config-client.properties, group=DEFAULT_GROUP

访问: http://127.0.0.1:8080/test，即可看到返回内容为之前定义的：spring-cloud-alibaba-learning--practice makes perfect

注意

@RefreshScope

@RefreshScope的优势在于它实现了配置文件的动态加载，也就是说，当在配置服务器上更新了配置信息后，RefreshScope会自动将最新的配置信息注入到应用中，从而不需要重启应用就能加载新的配置信息。

但在一些情况下，它会失效：

• 如当它修饰在@Scheduled、listener、Timmer等类中时
• 当配置刷新导致的对象被清除而又没法重新使用对象时，RefreshScope可能无法生效

此外，@RefreshScope只适用于SpringCloud环境，对于其他环境则需要使用其他方式实现动态加载配置。

参数Data ID等说明

上述的例子中，我们在Nacos中进行的配置使用的是默认配置，根据官网的说明——我们可以自定义：

• Data ID

之前的Data ID：对应的是spring.application.name=${name}

# 如果我们定义了以下属性 则 Data ID应为demo
spring.cloud.nacos.config.prefix=demo

• Group 它的默认值为：DEFAULT_GROUP

# 我们可以用它来区分不同用途的配置内容
spring.cloud.nacos.config.group=DEV_GROUP

• 配置内容的格式 进行如下配置后，Nacos中配置内容的数据格式则为 yaml

spring.cloud.nacos.config.file-extension=yaml

• 不同环境的使用

spring.profiles.active=test

若指定了环境，则Group ID则变为:${prefix}-test.${file-extension}

以上4个属性可以配合使用实现不同环境的配置，此外还可以使用Namespace实现不同环境的配置这一功能。

在命名空间新建一个namespace，再在其中创建对应的Group跟Data ID即可。

使用Namespace后，不同的命名空间下，可以存在相同的Group或Data ID的配置。

Nacos官网 (opens new window)