Spring Cloud Alibaba系列之Nacos分布式配置中心

Spring Cloud Alibaba系列之Nacos分布式配置中心

1、前言介绍

Spring Cloud Alibaba Nacos Config提供用于存储配置和其他元数据的 key/value 存储，为分布式系统中的外部化配置提供服务器端和客户端支持，nacos config是Spring Cloud config Server和config Client的替代方案

2、环境准备

• 环境准备：
  • 64bit JDK 1.8
  • SpringBoot2.3.7.RELEASE
  • SpringCloud(Hoxton.SR9)
  • SpringCloudAlibaba2.2.2.RELEASE
  • Maven 3.2+
• 开发工具
  • IntelliJ IDEA
  • smartGit

3、新建项目

使用阿里提供的初始化服务链接创建Spring Initializer项目，链接：https://start.aliyun.com

选择jdk版本，packaging方式为jar

选择阿里Nacos的Nacos Configuration配置

服务订阅服务的加上nacos服务订阅 ， Nacos Service Discovery

测试需要，可以增加 “Spring Web” 和 “Spring Boot Actuator” 组件，没有安装IDEA开发软件，可以在阿里的平台生成代码：https://start.aliyun.com/bootstrap.html

也可以用代码方式添加，添加阿里的nacos-config

1<dependency>
2   <groupId>com.alibaba.cloud</groupId>
3     <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
4 </dependency>

生成的配置参考：

1<?xml version="1.0" encoding="UTF-8"?>
2<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
4    <modelVersion>4.0.0</modelVersion>
5    <groupId>com.example.springcloudalibaba</groupId>
6    <artifactId>springcloud-alibaba-nacos-config</artifactId>
7    <version>0.0.1-SNAPSHOT</version>
8    <name>springcloud-alibaba-nacos-config</name>
9    <description>Demo project for Spring Boot</description>
10
11    <properties>
12        <java.version>1.8</java.version>
13        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
14        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
15        <spring-boot.version>2.3.7.RELEASE</spring-boot.version>
16        <spring-cloud-alibaba.version>2.2.2.RELEASE</spring-cloud-alibaba.version>
17    </properties>
18
19    <dependencies>
20        <dependency>
21            <groupId>org.springframework.boot</groupId>
22            <artifactId>spring-boot-starter-web</artifactId>
23        </dependency>
24        <dependency>
25            <groupId>com.alibaba.cloud</groupId>
26            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
27        </dependency>
28        <dependency>
29            <groupId>com.alibaba.cloud</groupId>
30            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
31        </dependency>
32
33        <dependency>
34            <groupId>org.projectlombok</groupId>
35            <artifactId>lombok</artifactId>
36            <optional>true</optional>
37        </dependency>
38        <dependency>
39            <groupId>org.springframework.boot</groupId>
40            <artifactId>spring-boot-starter-test</artifactId>
41            <scope>test</scope>
42            <exclusions>
43                <exclusion>
44                    <groupId>org.junit.vintage</groupId>
45                    <artifactId>junit-vintage-engine</artifactId>
46                </exclusion>
47            </exclusions>
48        </dependency>
49    </dependencies>
50
51    <dependencyManagement>
52        <dependencies>
53            <dependency>
54                <groupId>org.springframework.boot</groupId>
55                <artifactId>spring-boot-dependencies</artifactId>
56                <version>${spring-boot.version}</version>
57                <type>pom</type>
58                <scope>import</scope>
59            </dependency>
60            <dependency>
61                <groupId>com.alibaba.cloud</groupId>
62                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
63                <version>${spring-cloud-alibaba.version}</version>
64                <type>pom</type>
65                <scope>import</scope>
66            </dependency>
67        </dependencies>
68    </dependencyManagement>
69
70    <build>
71        <plugins>
72            <plugin>
73                <groupId>org.apache.maven.plugins</groupId>
74                <artifactId>maven-compiler-plugin</artifactId>
75                <version>3.8.1</version>
76                <configuration>
77                    <source>1.8</source>
78                    <target>1.8</target>
79                    <encoding>UTF-8</encoding>
80                </configuration>
81            </plugin>
82            <plugin>
83                <groupId>org.springframework.boot</groupId>
84                <artifactId>spring-boot-maven-plugin</artifactId>
85                <version>2.3.7.RELEASE</version>
86                <configuration>
87                    <mainClass>com.example.springcloudalibaba.nacosconfig.SpringcloudAlibabaNacosConfigApplication
88                    </mainClass>
89                </configuration>
90                <executions>
91                    <execution>
92                        <id>repackage</id>
93                        <goals>
94                            <goal>repackage</goal>
95                        </goals>
96                    </execution>
97                </executions>
98            </plugin>
99        </plugins>
100    </build>
101
102</project>
103

4、启动Nacos服务

详情可以参考官网：https://nacos.io/zh-cn/docs/quick-start.html，需要先下载nacos服务端源码，下载源码后编译启动项目：

window+R启动cmd窗口，cd到nacos server的bin目录，linux系统直接使用cd ${nacos_server_home}/bin

./startup.sh -m standalone

window系统使用命令startup.cmd -m standalone

启动成功，访问：http://127.0.0.1:8848/nacos，账号密码都是nacos

登录成功，来到主页：

5、添加Nacos配置

Data ID 由应用名（springcloud-alibaba-nacos-config）+ 文件后缀名(.properties) 组成，应用名写在配置文件spring.application.name=springcloud-alibaba-nacos-config

user.name=admin123

6、Nacos配置文件

Nacos config配置，写在bootstrap.properties，bootstrap.properties配置文件的优先级比application.properties的优先级高

1# Nacos帮助文档: https://nacos.io/zh-cn/docs/concepts.html
2# Nacos认证信息
3spring.cloud.nacos.config.username=nacos
4spring.cloud.nacos.config.password=nacos
5spring.cloud.nacos.config.contextPath=/nacos
6# 设置配置中心服务端地址
7spring.cloud.nacos.config.server-addr=127.0.0.1:8848
8# Nacos 配置中心的namespace。需要注意，如果使用 public 的 namcespace ，请不要填写这个值，直接留空即可
9# spring.cloud.nacos.config.namespace=
10
11

修改一下nacos服务地址：

注意：Nacos Server 地址必须配置在 bootstrap.properties 文件。

1package com.example.springcloudalibaba.nacosconfig.nacosconfig;
2
3import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
4import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
5import org.springframework.context.annotation.Configuration;
6
7@EnableAutoConfiguration
8@Configuration
9public class NacosConfigConfiguration {
10   
11   
12   
13}
14

7、@Value属性刷新

使用 Nacos Config 实现 Bean @Value属性刷新

1package com.example.springcloudalibaba.nacosconfig;
2
3import com.example.springcloudalibaba.nacosconfig.bean.User;
4import org.springframework.beans.factory.annotation.Autowired;
5import org.springframework.beans.factory.annotation.Value;
6import org.springframework.boot.SpringApplication;
7import org.springframework.boot.autoconfigure.SpringBootApplication;
8import org.springframework.cloud.context.config.annotation.RefreshScope;
9import org.springframework.web.bind.annotation.GetMapping;
10import org.springframework.web.bind.annotation.RestController;
11
12import javax.annotation.PostConstruct;
13import java.io.IOException;
14import java.io.StringReader;
15import java.util.Properties;
16
17@SpringBootApplication
18//@RefreshScope
19@RestController
20public class SpringcloudAlibabaNacosConfigApplication {
21   
22   
23   
24
25    @Value("${user.name}")
26    private String userName;
27
28    @PostConstruct
29    public void init() {
30   
31   
32   
33       System.out.println(String.format("从Nacos配置中心获取数据,username:%s",userName));
34    }
35
36    @GetMapping("/username")
37    public String username() {
38   
39   
40   
41        return String.format("get user name : %s", userName);
42    }
43
44    public static void main(String[] args) {
45   
46   
47   
48        SpringApplication.run(SpringcloudAlibabaNacosConfigApplication.class, args);
49    }
50
51}
52

get user name : admin123

获取用户信息：User{name=‘admin’}

8、@ConfigurationProperties 属性刷新

使用 Nacos Config 实现 @ConfigurationPropertiesBean 属性刷新

1package com.example.springcloudalibaba.nacosconfig.bean;
2
3import org.springframework.boot.context.properties.ConfigurationProperties;
4import org.springframework.cloud.context.config.annotation.RefreshScope;
5
6@RefreshScope
7@ConfigurationProperties(prefix = "user")
8public class User {
9   
10   
11   
12
13    private String name;
14
15    public String getName() {
16   
17   
18   
19        return name;
20    }
21
22    public void setName(String name) {
23   
24   
25   
26        this.name = name;
27    }
28
29    @Override
30    public String toString() {
31   
32   
33   
34        return "User{" +
35                "name='" + name + '\'' +
36                '}';
37    }
38}

9、动态刷新属性数据

Nacos Confg 支持标准 Spring Cloud @RefreshScope特性，@RefreshScope主键加在Application类就可以，除此之外，Nacos Confg 也引入了 Nacos Client 底层数据变化监听接口，即com.alibaba.nacos.api.config.listener.Listener

1package com.example.springcloudalibaba.nacosconfig;
2
3import com.example.springcloudalibaba.nacosconfig.bean.User;
4import org.springframework.beans.factory.annotation.Autowired;
5import org.springframework.boot.SpringApplication;
6import org.springframework.boot.autoconfigure.SpringBootApplication;
7import org.springframework.boot.context.properties.EnableConfigurationProperties;
8import org.springframework.cloud.context.config.annotation.RefreshScope;
9import org.springframework.web.bind.annotation.GetMapping;
10import org.springframework.web.bind.annotation.RestController;
11
12
13
14@SpringBootApplication
15@RefreshScope
16@EnableConfigurationProperties(User.class)
17@RestController
18public class SpringcloudAlibabaNacosConfigApplication {
19   
20   
21   
22
23    @Autowired
24    private User user;
25
26    @GetMapping("/user")
27    public String user() {
28   
29   
30   
31        return String.format("获取用户信息：%s" , user);
32    }
33
34    public static void main(String[] args) {
35   
36   
37   
38        SpringApplication.run(SpringcloudAlibabaNacosConfigApplication.class, args);
39    }
40
41}
42

ApplicationRunner 进行监听，主要属性变动了，就会自动刷日志

1package com.example.springcloudalibaba.nacosconfig;
2
3import com.alibaba.cloud.nacos.NacosConfigManager;
4import com.alibaba.nacos.api.config.listener.AbstractListener;
5import com.example.springcloudalibaba.nacosconfig.bean.User;
6import org.springframework.beans.factory.annotation.Autowired;
7import org.springframework.beans.factory.annotation.Value;
8import org.springframework.boot.ApplicationRunner;
9import org.springframework.boot.SpringApplication;
10import org.springframework.boot.autoconfigure.SpringBootApplication;
11import org.springframework.boot.context.properties.EnableConfigurationProperties;
12import org.springframework.cloud.context.config.annotation.RefreshScope;
13import org.springframework.context.annotation.Bean;
14import org.springframework.web.bind.annotation.GetMapping;
15import org.springframework.web.bind.annotation.RestController;
16
17import javax.annotation.PostConstruct;
18import java.io.IOException;
19import java.io.StringReader;
20import java.util.Properties;
21
22@SpringBootApplication
23@RefreshScope
24@EnableConfigurationProperties(User.class)
25@RestController
26public class SpringcloudAlibabaNacosConfigApplication {
27   
28   
29   
30
31    @Value("${user.name}")
32    private String userName;
33
34    @Autowired
35    private NacosConfigManager nacosConfigManager;
36
37    @PostConstruct
38    public void init() {
39   
40   
41   
42       System.out.println(String.format("从Nacos配置中心获取数据,username:%s",userName));
43    }
44
45    @GetMapping("/username")
46    public String username() {
47   
48   
49   
50        return String.format("get user name : %s", userName);
51    }
52
53    @Bean
54    public ApplicationRunner runner() {
55   
56   
57   
58        return args -> {
59   
60   
61   
62            String dataId = "springcloud-alibaba-nacos-config.properties";
63            String group = "DEFAULT_GROUP";
64            nacosConfigManager.getConfigService().addListener(dataId, group, new AbstractListener() {
65   
66   
67   
68                @Override
69                public void receiveConfigInfo(String configInfo) {
70   
71   
72   
73                    System.out.println(String.format("[Listener] :%s" , configInfo));
74                    System.out.println("[Before User] " + user);
75                    Properties properties = new Properties();
76                    try {
77   
78   
79   
80                        properties.load(new StringReader(configInfo));
81                        String name = properties.getProperty("user.name");
82                        user.setName(name);
83                    } catch (IOException e) {
84   
85   
86   
87                        e.printStackTrace();
88                    }
89                    System.out.println("[After User] " + user);
90                }
91            });
92        };
93    }
94
95
96    public static void main(String[] args) {
97   
98   
99   
100        SpringApplication.run(SpringcloudAlibabaNacosConfigApplication.class, args);
101    }
102
103}
104

10、Nacos Config其它配置

• 全局关闭配置
  关闭nacos配置，可以通过如下代码配置：

  spring.cloud.nacos.config.enabled = false

• 更多的配置

配置项

key

默认值

说明

服务端地址

spring.cloud.nacos.config.server-addr

Nacos 启动监听的ip地址和端口

配置对应的 DataId

spring.cloud.nacos.config.name

先取 prefix，再取 name，最后取 spring.application.name

配置对应的 DataId

spring.cloud.nacos.config.prefix

先取 prefix，再取 name，最后取 spring.application.name

配置对应的 DataId

spring.cloud.nacos.config.prefix

先取 prefix，再取 name，最后取 spring.application.name

配置内容编码

spring.cloud.nacos.config.encode

设置编码既可

Nacos Group配置

spring.cloud.nacos.config.group

DEFAULT_GROUP

配置对应的Group

配置文件拓展名

spring.cloud.nacos.config.fileExtension

properties

配置项对应的文件扩展名，目前支持 properties 和 yaml(yml)

获取配置超时时间

spring.cloud.nacos.config.timeout

3000

客户端获取配置的超时时间，单位毫秒

配置接入点

spring.cloud.nacos.config.endpoint

地域的某个服务的入口域名，通过此域名可以动态地拿到服务端地址

配置命名空间

spring.cloud.nacos.config.namespace

命名空间用于区分不同环境的配置，例如开发测试环境和生产环境的资源

AccessKey

spring.cloud.nacos.config.accessKey

阿里云上面的一个云账号名

SecretKey

spring.cloud.nacos.config.secretKey

阿里云上面的一个云账号密码

配置Nacos Server context path

spring.cloud.nacos.config.contextPath

Nacos Server对外提供的context path

配置Nacos集群

spring.cloud.nacos.config.clusterName

配置成Nacos集群名称

共享配置

spring.cloud.nacos.config.sharedDataids

共享配置的 DataId, “,” 分割

共享配置动态刷新

spring.cloud.nacos.config.refreshableDataids

共享配置中需要动态刷新的 DataId, “,” 分割

共享配置动态刷新

spring.cloud.nacos.config.extConfig

属性是个集合，内部由 ConfigPOJO 组成。Config有 3 个属性，分别是 dataId, group以及 refresh

11、Nacos Actuator监控

Nacos Config Actuator Endpoint，引入maven配置：

1 <dependency>
2     <groupId>org.springframework.boot</groupId>
3     <artifactId>spring-boot-starter-actuator</artifactId>
4 </dependency>

配置文件：

1management.endpoints.jmx.exposure.include=*
2management.endpoints.web.exposure.include=*
3management.endpoint.health.show-details=always
4
5# Actuator Web 访问端口
6management.server.port=8081
7

curl http://127.0.0.1:8081/actuator/nacos-config

1{
2   
3   
4   
5    "NacosConfigProperties":{
6   
7   
8   
9        "serverAddr":"127.0.0.1:8848",
10        "username":"nacos",
11        "password":"nacos",
12        "encode":null,
13        "group":"DEFAULT_GROUP",
14        "prefix":null,
15        "fileExtension":"properties",
16        "timeout":3000,
17        "maxRetry":null,
18        "configLongPollTimeout":null,
19        "configRetryTime":null,
20        "enableRemoteSyncConfig":false,
21        "endpoint":null,
22        "namespace":null,
23        "accessKey":null,
24        "secretKey":null,
25        "contextPath":"/nacos",
26        "clusterName":null,
27        "name":null,
28        "sharedConfigs":null,
29        "extensionConfigs":null,
30        "refreshEnabled":true,
31        "sharedDataids":null,
32        "extConfig":null,
33        "refreshableDataids":null,
34        "configServiceProperties":{
35   
36   
37   
38            "secretKey":"",
39            "contextPath":"/nacos",
40            "namespace":"",
41            "username":"nacos",
42            "enableRemoteSyncConfig":"false",
43            "configLongPollTimeout":"",
44            "configRetryTime":"",
45            "encode":"",
46            "serverAddr":"127.0.0.1:8848",
47            "maxRetry":"",
48            "clusterName":"",
49            "password":"nacos",
50            "accessKey":"",
51            "endpoint":""
52        }
53    },
54    "RefreshHistory":[
55
56    ],
57    "Sources":[
58        {
59   
60   
61   
62            "lastSynced":"2021-01-15 15:15:56",
63            "dataId":"springcloud-alibaba-nacos-config.properties"
64        },
65        {
66   
67   
68   
69            "lastSynced":"2021-01-15 15:15:56",
70            "dataId":"springcloud-alibaba-nacos-config"
71        }
72    ]
73}

本博客的例子代码可以在github找到下载链接：代码下载

12、附录：参考资料

• Nacos中文手册：https://nacos.io/zh-cn/docs/what-is-nacos.html
• Nacos Github WIKI：https://github.com/alibaba/nacos/wiki
• Nacos官网博客：https://nacos.io/zh-cn/blog/index.html

本文同步分享在 博客“smileNicky”（CSDN）。
如有侵权，请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”，欢迎正在阅读的你也加入，一起分享。