使用Nacos作为配置中心（四）

2022-04-13 16:55:15 浏览数 (1)

通过之前文章的学习我们已经学会了使用Nacos完成服务的注册与发现。同时也介绍了Spring Cloud中不同风格的服务消费方式。接下来，我们再来学习下Nacos的另一个重要功能：配置管理

简介

Nacos除了可以实现服务的注册与发现之外，还将配置中心的功能整合在一起。通过Nacos的配置管理功能，我们可以将整个架构体系能的所有配置都集中到Nacos中存储。这样做的好处主要有以下几点：

  • 分离的多环境配置，可以灵活的管理权限，安全性更高
  • 应用程序的打包更为纯粹，已实现一次打包，多处运行的特点

Nacos的配置管理模型与淘宝开源的配置中心Diamond类似，基础层面通过DataId和 Group来定位配置内容，除此之外还增加了很多其他的管理功能。

快速入门

下面我们通过一个简单的例子来介绍如何使用Nacos来创建配置内容以及如何在Spring Cloud应用中加载Nacos的配置信息。

创建配置

第一步： 进入Nacos的控制页面，在配置列表功能页面中，单击右上角的 按钮，进入新建配置页面，如图填写配置信息：

其中：

  • Data ID： 填入 alibaba-nacos-config-client.properties
  • Group： 使用默认值 DEFAULT_GROUP
  • 描述：可不填
  • 配置格式： 选择 Properties
  • 配置内容： 应用要加载的配置内容，这里仅作为实例，做简单的配置，比如： username=wolf

创建应用

第一步：创建一个Spring Boot应用,命名为：alibaba-nacos-config-client

第二步：编辑pom.xml, 加入必要的依赖配置：

代码语言：javascript复制
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.0.5.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>Finchley.SR1</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-alibaba-dependencies</artifactId>
            <version>0.2.2.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.2</version>
        <optional>true</optional>
    </dependency>
</dependencies>

上述内容主要三部分：

  • parent：定义spring boot的版本
  • dependencyManagement：spring cloud的版本以及spring cloud alibaba的版本
  • dependencies：当前应用要使用的依赖内容。这里主要加入Nacos的配置客户端依赖包：spring-cloud-stater-alibaba-nacos-config。由于 dependencyManagement已经指定过版本号，这里不需要指定具体版本号。

注意：这个例子中并没有引入nacos的服务注册与发现依赖，因为这两个功能内容是完全可以独立使用的。

第三步： 创建应用主类和测试Controller接口

代码语言：javascript复制
@SpringBootApplication
public class NacosConfigClientApplication {

    public static void main(String[] args) {
        SpringApplication.run(NacosConfigClientApplication.class, args);
    }
}
代码语言：javascript复制
@Slf4j
@RestController
@RefreshScope
public class TestController {

    @Value("${username}")
    private String username;

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

内容非常简单，唯一可能默认的注解 ：@RefreshScope这个注解是spring cloud提供的一种特殊的scope实现，用来实现配置、实例热加载。

在类上添加该注解，用来让这个类的配置内容支持动态刷新，也就是当我们启动应用之后，修改Nacos的配置文件内容，这里就会马上生效。

第四步： 创建配置文件bootstrap.properties，并配置服务名称和Nacos地址

代码语言：javascript复制
server.port=9004
spring.application.name=alibaba-nacos-config-client
spring.cloud.nacos.config.server-addr=127.0.0.1:8848

注意：

  • 这里必须使用bootstrap.properties,不能用bootstrap.yml不然启动会报错。
  • 同时，spring.application.name值必须和Nacos配置中 Data ID（除了.yml或者.properties）

为什么必须写在bootstrap.properties中？ SpringCloudConfig和 NacosConfig这种统一配置服务在springboot项目中初始化时，都是加载bootstrap.properties配置文件去初始化上下文。 这是由spring boot的加载属性文件的优先级决定的，想要在加载属性之前去config server上取配置文件，那NacosConfig或SpringCloudConfig相关配置就是需要最先加载的，而bootstrap.properties的加载是先于application.properties的，所以config client要配置config的相关配置就只能写到bootstrap.properties里了

第五步： 启动应用

代码语言：javascript复制
2019-07-10 15:57:19.003  INFO 5240 --- [           main] o.s.c.a.n.c.NacosPropertySourceBuilder   : Loading nacos data, dataId: 'alibaba-nacos-config-client.properties', group: 'DEFAULT_GROUP'
2019-07-10 15:57:19.004  INFO 5240 --- [           main] b.c.PropertySourceBootstrapConfiguration : Located property source: CompositePropertySource {name='NACOS', propertySources=[NacosPropertySource {name='alibaba-nacos-config-client.properties'}]}

在启动的时候，可以看到类似上面的日志信息，这里输出应用程序要从Nacos中获取配置的 dataid 和 group。如果启动之后，发现配置信息没有获取到的时候，可以检测下这块配置是否正确。

第六步：验证配置获取和动态刷新 使用postman工具，访问接口：http://localhost:9004/test, 将返回Nacos配置中的 username 值。然后，再通过Nacos页面,修改 username=admin，单击发布，再访问这个接口看结果是否实时更新。

修改前：

修改中：

发布完毕后，不要启动应用，重新访问接口，会发现结果实时更新。

同时会发现我们在修改Nacos配置信息，发布后，客户端控制台会发现如下日志：

代码语言：javascript复制
2019-07-10 16:11:09.369  INFO 5240 --- [-127.0.0.1_8848] s.c.a.AnnotationConfigApplicationContext : Refreshing org.springframework.context.annotation.AnnotationConfigApplicationContext@7f1bcf03: startup date [Wed Jul 10 16:11:09 CST 2019]; root of context hierarchy
2019-07-10 16:11:09.406  INFO 5240 --- [-127.0.0.1_8848] trationDelegate$BeanPostProcessorChecker : Bean 'configurationPropertiesRebinderAutoConfiguration' of type [org.springframework.cloud.autoconfigure.ConfigurationPropertiesRebinderAutoConfiguration$$EnhancerBySpringCGLIB$$1bdb25d3] is not eligible for getting processed by all BeanPostProcessors (for example: not eligible for auto-proxying)
2019-07-10 16:11:09.506  INFO 5240 --- [-127.0.0.1_8848] o.s.c.a.n.c.NacosPropertySourceBuilder   : Loading nacos data, dataId: 'alibaba-nacos-config-client.properties', group: 'DEFAULT_GROUP'
2019-07-10 16:11:09.506  INFO 5240 --- [-127.0.0.1_8848] b.c.PropertySourceBootstrapConfiguration : Located property source: CompositePropertySource {name='NACOS', propertySources=[NacosPropertySource {name='alibaba-nacos-config-client.properties'}]}
2019-07-10 16:11:09.507  INFO 5240 --- [-127.0.0.1_8848] o.s.boot.SpringApplication               : No active profile set, falling back to default profiles: default
2019-07-10 16:11:09.508  INFO 5240 --- [-127.0.0.1_8848] s.c.a.AnnotationConfigApplicationContext : Refreshing org.springframework.context.annotation.AnnotationConfigApplicationContext@5d68f73a: startup date [Wed Jul 10 16:11:09 CST 2019]; parent: org.springframework.context.annotation.AnnotationConfigApplicationContext@7f1bcf03
2019-07-10 16:11:09.525  INFO 5240 --- [-127.0.0.1_8848] o.s.boot.SpringApplication               : Started application in 0.234 seconds (JVM running for 831.73)
2019-07-10 16:11:09.525  INFO 5240 --- [-127.0.0.1_8848] s.c.a.AnnotationConfigApplicationContext : Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@5d68f73a: startup date [Wed Jul 10 16:11:09 CST 2019]; parent: org.springframework.context.annotation.AnnotationConfigApplicationContext@7f1bcf03
2019-07-10 16:11:09.525  INFO 5240 --- [-127.0.0.1_8848] s.c.a.AnnotationConfigApplicationContext : Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@7f1bcf03: startup date [Wed Jul 10 16:11:09 CST 2019]; root of context hierarchy
2019-07-10 16:11:09.528  INFO 5240 --- [-127.0.0.1_8848] o.s.c.e.event.RefreshEventListener       : Refresh keys changed: [username]

上面，我们已经学会了如何在Nacos中创建配置，以及如何使用Spring Cloud Alibaba的Nacos客户端模块来加载配置。我们的例子完成采用了默认配置完成。接下来我们详细了解下Nacos配置的加载规则。

加载规则

在Nacos Spring Cloud 中， dataID的完成格式如下：

代码语言：javascript复制
${prefix}-${spring.profile.active}.${file-extension}
  • prefix：默认为 spring.application.name的值，也可以通过配置项 spring.cloud.nacos.config.prefix来配置。
  • spring.profile.active：即当前环境对应的profile，详情开业参考 Spring Boot文档。

注意：当 spring.profile.active 为空时，对应的连接符 - 也将不存在，dataId的拼接格式变成：{prefix}.{file-extension}

  • file-extension： 为配置文件的数据格式，可以通过设置项spring.cloud.nacos.config.file-extension来配置，默认值：properties。目前只支持 properties 和 yaml 类型。
  • Group的值默认 DEFAULT_GROUP: 可以通过设置项 spring.cloud.nacos.config.group来配置，默认值： DEFAULT_GROUP

思考

上面，我们具体介绍了在Nacos中添加各种配置与SpringCloud应用中客户端配置的对应关系。对于spring.cloud.nacos.config.prefix和spring.cloud.nacos.config.file-extension来说，基本没有太多的花样，大部分都是采用默认配置。

但是对于 spring.cloud.nacos.config.group 的配置来说，还是可以派生出一些作用，比如：用来区分不同的产品组下的各个应用的配置内容（解决多个应用名称冲突问题）或者用来区分不同用途的配置内容，再或者用来区分不同环境（dev、test、prod）的配置。 后面我们也会专门针对如何使用Group完成多环境配置进行专门讲解。

对象存储 spring springboot springcloud

0 人点赞