你好,欢迎阅读,本文是系列文章中的第4篇。
Part1 - Nacos 是什么?
Part2 - Nacos 环境搭建
Part3 - Nacos 服务发现实践
Part4 - Nacos 分布式配置实践
本文目的是使用 Nacos 管理服务的配置。
步骤:
(1)创建一个 SpringBoot 服务,使用本地配置方式。
(2)Nacos 中创建配置。
(3)SpringBoot 服务整合 Nacos,改为使用 Nacos 中的配置。
(4)实现配置动态刷新。
1. 创建服务
pom.xml
代码语言:javascript复制...
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.5.RELEASE</version>
<relativePath/>
</parent>
<groupId>com.example</groupId>
<artifactId>configdemo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>configdemo</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>11</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 加依赖 nacos-config -->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<!-- spring cloud 依赖管理 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>Hoxton.SR3</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<!-- spring cloud alibaba 依赖管理 -->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-alibaba-dependencies</artifactId>
<version>2.2.1.RELEASE</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
...
添加配置(application.yaml):
代码语言:javascript复制test:
name: local-config
添加一个测试接口,用于输出配置值:
代码语言:javascript复制...
@RestController
public class TestController{
@Value("${test.name}")
private String test_name;
@GetMapping("/test")
public String testpriority(){
return test_name;
}
}
启动后访问:
http://localhost:8080/test
效果:
![image-20201101185433206](/Users/a/Library/Application Support/typora-user-images/image-20201101185433206.png)
成功输出了本地配置。
2. Nacos 中新建配置
进入 Nacos 控制的配置列表页面:
点击新建配置的按钮,在新建配置页面添加:
Data ID 项填写服务名 configdemo.yaml,配置格式选择 YAML,配置内容中填写:
代码语言:javascript复制test:
name: nacos-config
这里把配置的值改为了 “nacos-config”,用于与之前的 "local-config" 作为区分,然后点击页面底部的发布按钮。
回到配置列表页面,即可看到刚刚新建的配置:
3. 服务整合 Nacos 配置
Nacos 配置的依赖在第一步已经添加好了,下面主要是修改配置。
首先,把之前的 application.yaml 文件名改为 bootstrap.yaml,这是因为 bootstrap.yaml 的优先级是最高的。
然后,在 bootstrap.yaml 中添加配置:
代码语言:javascript复制spring:
application:
name: configdemo
cloud:
nacos:
config:
server-addr: localhost:8848
file-extension: yaml
注意,现在服务本地配置文件中已经没有 "test.name" 这个配置项了。
重新启动服务,在启动日志中会看到如下提示:
再次刷新页面:
此次输出的值为 Nacos 中配置的 "nacos-config",说明已经成功读取了 Nacos 中的配置信息。
现在需要说明一下服务为什么可以自动找到 Nacos 中的配置文件。
服务启动时,会读取 bootstrap.yaml 中指定的 nacos config 服务器地址,然后根据 spring.application.name
配置项的值与 spring.cloud.nacos.config.file-extension
的值构造出 Data ID,由此就可以读取到 Nacos 中的配置文件了。
4. 动态刷新
如果希望在 Nacos 修改配置之后,实例可以动态获取最新值,则需要添加一个注解 @RefreshScope
。
代码如下:
代码语言:javascript复制@RefreshScope
@RestController
public class TestController{
@Value("${test.name}")
private String test_name;
@GetMapping("/test")
public String testpriority(){
return test_name;
}
}
重新启动服务。
下面在 Nacos 控制台修改配置:
在现有值的后面添加了字符串 “-new”,以作为区分:
然后点击页面底部的发布按钮,点击后,会弹出新旧配置对比窗口:
确认无误后,点击确认发布按钮。
这样配置就修改完成了,下面刷新页面:
可以看到,已经变成了刚刚修改后的值。
注意,修改配置后可没有重启服务,说明已经成功实现了配置的动态刷新。