Spring Boot 使用 Nacos 的配置中心

Spring Boot 是 Spring 官方推出的快速开发框架，内嵌服务器、自动配置，无需 XML，几行代码即可构建生产级应用。它简化依赖管理，支持微服务与云原生，让 Java 开发更高效、更轻量。
spring Boot 版本 3.3.7
nacos 版本 3.1.1
Spring Cloud 版本 2023.0.3
Spring Cloud Alibaba 版本 2023.0.3.4

1. 添加依赖（Maven）

`pom.xml`

      1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
<?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>3.3.7</version>
        <relativePath/>
    </parent>
 
    <groupId>com.tsphp</groupId>
    <artifactId>study</artifactId>
    <version>0.0.1-SNAPSHOT</version>
 
    <name>study</name>
    <description>study</description>
    <properties>
        <java.version>17</java.version>
        <spring-cloud.version>2023.0.3</spring-cloud.version>
        <spring-cloud-alibaba.version>2023.0.3.4</spring-cloud-alibaba.version>
    </properties>
    <dependencyManagement>
        <dependencies>
            <!-- Spring Cloud -->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!-- Spring Cloud Alibaba -->
            <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>
        <!-- Spring Boot Web 依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <!-- Nacos Config (配置中心) -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>
    </dependencies>
 
    <repositories>
        <repository>
            <id>nexus-aliyun</id>
            <name>nexus-aliyun</name>
            <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
            <releases>
                <enabled>true</enabled>
            </releases>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
    </repositories>
    <pluginRepositories>
        <pluginRepository>
            <id>aliyun-plugin</id>
            <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
            <releases>
                <enabled>true</enabled>
            </releases>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </pluginRepository>
    </pluginRepositories>
 
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

2. 配置文件

`application.yml`

      1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
spring:
  application:
    name: study-server  # 服务名
  cloud:
    nacos:
      config:
        server-addr: 127.0.0.1:8848 # nacos地址
        file-extension: yaml        # 数据格式
        namespace: public           # 命名空间
        group: DEFAULT_GROUP        # 组
        timeout: 5000               # 超时时间
        import-check:               # 导入检查
          enabled: false
  config:
    import:
      - optional:nacos:${spring.application.name}.yaml  # 显示导入
server:
  port: 9801

3. Nacos 配置文件

a) 安装&启动 Nacos Server 3.1.1，若未安装可参考上一篇文章 https://mp.weixin.qq.com/s/9ss7bws0J9JNHz4cy4tcug
b) 进入Nacos > 配置管理 > 配置列表 > 创建配置
c) Data ID：${spring.application.name}.yaml 替换成真实参数
d) Group：默认DEFAULT_GROUP即可
e) 配置格式：YAML
f) 配置如下图

4. 项目中使用 Nacos 配置

      1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
package com.tsphp.study.api;
 
import com.tsphp.study.units.Result;
import com.tsphp.study.units.ResultUnit;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
import java.util.HashMap;
import java.util.Map;
 
@RestController
@RequestMapping("/test")
@RefreshScope // 动态刷新，若缺少此配置修改Nacos参数后，项目中参数依旧是老的
public class test {
 
    @Value("${department.name:}")
    private String departmentName; // 读取Nacos中的部门名称
 
    @Value("${department.people:0}")
    private String departmentPeople; // 读取Nacos中的部门人数
 
    @GetMapping("/test")
    public Result hello() {
        Map<String,Object> map = new HashMap<>();
        map.put("appName", departmentName);
        map.put("people", departmentPeople);
        return ResultUnit.wrapSuccess(map);
    }
}

访问测试：

• 启动后访问：http://localhost:9801/test/test
• 返回 "{"errcode":0,"errmsg":"","data":{"appName":"开发一部","people":"15"}}"
• 在 Nacos 中将 department.name 改为 "开发二部"
• 等待 1~2 秒
• 再次访问
• 返回 "{"errcode":0,"errmsg":"","data":{"appName":"开发二部","people":"15"}}"

【小结】

今天成功把配置塞进了 Nacos，终于不用再为改个参数重启服务而怀疑人生了！
现在改配置，比改朋友圈签名还快！✨
明天准备召唤 Nacos 的第二技能：服务注册与发现！
是时候让我的微服务们学会自己找对象（服务）了 ❤️
如果这段折腾让你嘴角上扬、心头一暖，甚至少薅了几根头发——
下期见！
愿你的服务稳如老狗，配置秒级生效，
Bug 自动修复，日志一片绿，
头发浓密如初，代码一次跑通 —— 连 Lint 都忍不住夸你优雅！ 🚀

Spring Boot

Nacos

配置中心

微服务

欢迎关注我的公众号，获取更多文章