Spring Cloud 使用 Nacos 作配置中心

╰半橙微兮° 2023-10-10 14:35 50阅读 0赞

Nacos 是 Spring Cloud Alibaba 核心组件之一，可以用作 Spring Cloud 的注册中心和配置中心。

本文讲述如何在 Spring Cloud 中使用 Nacos 作为配置中心。

安装 Nacos  
与 Spring Cloud Config 和 Eureka 的使用方式不同，Nacos Server 需要独立部署。Nacos Server 的部署方式包括单机模式和集群模式，集群模式可以解决 Nacos 高可用的问题。

为简单起见，本文采用单机模式 Nacos Server 作为配置中心。单机模式搭建过程比较简单，可以通过下载源代码编译方式安装和二进制可执行文件安装。

具体安装步骤可以参考官方文档：

https://nacos.io/zh-cn/docs/quick-start.html

安装完成后，使用用户 nacos 和密码 nacos 访问 Nacos 控制台：  
![4715484445e6a49e0cfec60c4dcb0990.png][]

图中可以看到访问端口被改成了 8868，而不是 8848。Nacos Server 启动端口的修改也比较简单，修改其配置文件 `conf/application.propertie` 中端口配置 `server.port` 即可。

### 创建 Spring Cloud 项目 ###

利用 IntelliJ Idea 创建 Spring Cloud 项目，其中的父（`parent` ）项目 `springcloudstudy` 的 `pom.xml` 内容如下：

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.3.7.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>me.leehao</groupId>
        <artifactId>springcloudstudy</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>springcloudstudy</name>
        <description>Demo project for Spring Cloud</description>
        <packaging>pom</packaging>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <spring-cloud.version>Hoxton.SR9</spring-cloud.version>
            <java.version>1.8</java.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>2.2.3.RELEASE</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>
    
        <modules>
            <module>nacosconfig</module>
        </modules>
    </project>

父项目的 pom.xml 定义了 Spring Cloud 和 Spring Cloud Alibaba 依赖版本，这样，各子项目都使用同一版本下的子依赖版本。

接着创建一个名称为 nacosconfig 的 module 。nacosconfig 的 pom.xml 内容如下：

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>me.leehao</groupId>
            <artifactId>springcloudstudy</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </parent>
        <artifactId>nacosconfig</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>nacosconfig</name>
        <description>Demo project for Spring Cloud Nacos Config</description>
        <packaging>jar</packaging>
    
        <dependencies>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <configuration>
                        <finalName>${project.name}</finalName>
                    </configuration>
                </plugin>
            </plugins>
        </build>
    </project>

nacosconfig 的 pom.xml 继承自 springcloudstudy 的 pom.xml。且引入依赖：

spring-cloud-starter-alibaba-nacos-config ：作为 Nacos 客户端读取 Nacos 配置  
spring-boot-starter-web：对外提供 Web 接口

### 使用 Nacos 配置 ###

在 `nacosconfig` 项目 `bootstrap.yml` 配置文件添加应用名称和 Nacos Server 地址：

spring:
      application:
        name: nacosconfig
      cloud:
        nacos:
          config:
            server-addr: 10.88.115.137:8868
            file-extension: yaml

之所以需要配置 `spring.application.name` 的名称，是因为它是构成 Nacos 配置 `Data Id` 的一部分。Nacos `Data Id` 完整格式如下:

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

prefix：默认为 spring.application.name 的值  
spring.profiles.active：即当前环境对应的 profile，如果为空，则 -$\{spring.profiles.active\} 为空  
file-extension：配置内容格式，支持 properties 和 yaml 格式

Nacos Server 有关配置：

server-addr：Nacos Server 地址  
file-extension：Nacos Data Id 配置格式，此处配置为 yaml 格式  
即，采用上述配置，nacosconfig 会从 Nacos Server 读取 Data Id 为 nacosconfig.yaml 的配置。

从 Nacos 读取端口配置  
在 Nacos 控制台添加一个新的配置，其中：

Data Id：nacosconfig  
Group：DEFAULT\_GROUP  
配置格式：YAML  
配置内容：

server:
      port: 9080
    
    user: leolee

启动 `nacosconfig` 项目，可以看到打印日志：

2021-01-14 11:00:28.146 INFO 25112 — \[ main\] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat initialized with port(s): 9080 (http)

即说明 `nacosconfig` 项目监听端口从默认的 8080 改成了 9080。

#### 从 Nacos 读取变量配置 ####

添加一个 REST 接口 `/config`，读取变量 `user` 的值：

package me.leehao.nacosconfig;
    
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.cloud.context.config.annotation.RefreshScope;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
    import org.springframework.web.bind.annotation.RestController;
    
    
    @RefreshScope
    @RestController
    public class ConfigController {
        private static final Logger logger = LoggerFactory.getLogger(ConfigController.class);
    
        @Value("${user:leo}")
        private String user;
    
        @RequestMapping(value = "/config", method = RequestMethod.GET)
        public String index() {
            logger.info("get user config value from nacos: {}", user);
            return user;
        }
    }

为实现配置自动更新，使用了注解 `@RefreshScope`。

访问 `http://localhost:9080/config`，返回：

leolee

在 Nacos 控制台修改 `nacosconfig` 配置，将 `user` 值修改为 `leehao.me`，可以看到 `nacosconfig` 项目打印日志

2021-01-14 15:44:37.651 INFO 25112 — \[88.115.137\_8868\] c.a.n.client.config.impl.ClientWorker : \[fixed-10.88.115.137\_8868\] \[data-received\] dataId=nacosconfig, group=DEFAULT\_GROUP, tenant=null, md5=396057d762f85e3cfa28e2d2f450e722, content=server:  
port: 9080  
user: leehao.me, type=yaml

说明 `nacosconfig` 项目已接收到最新的 Nacos 配置。

访问 `http://localhost:9080/config`，返回：

> leehao.me

配置实现了动态更新。

[4715484445e6a49e0cfec60c4dcb0990.png]: https://img-blog.csdnimg.cn/img_convert/4715484445e6a49e0cfec60c4dcb0990.png