Spring Cloud Alibaba 快速学习之 Nacos

1. 引言

Spring Cloud Alibaba 是一套微服务解决方案，它为基于 Spring Cloud 的应用提供了与 Alibaba 生态系统无缝集成的能力。

Nacos 提供了服务发现和服务健康检查功能，允许服务实例在集群中自动注册与发现。同时，它也是强大的配置管理工具，支持配置的统一管理与动态刷新，适用于分布式环境。

2. 安装Nacos

• 下载Nacos，打开官方下载地址，下载稳定版。
  
• 解压到任意位置
  
• 启动Nacos，打开CMD命令行，cd切换到您解压的nacos\bin目录下，然后输入startup.cmd -m standalone 启动。（standalone代表着单机模式运行）
  
• 进入Nacos控制台页面，在浏览器中输入上图中Console后面的地址即可，至此Nacos启动成功。

3. 创建项目

创建一个名为spring-cloud-alibaba-demo的项目作为父级项目，使用Maven+JDK17。不会的请看IntelliJ IDEA快速创建Spring Boot项目。再创建一个子项目（Module）名为server-a，nacos的功能将在该子项目进行开发。最终项目结构，如下图。

4. 编写代码

根据最终项目结构，从下往上依次列出各个文件的代码。

4.1 spring-cloud-alibaba-demo的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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>spring-cloud-alibaba-demo</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>
    <modules>
        <module>server-a</module>
    </modules>

    <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <!--  为Spring Boot项目提供一系列默认的配置和依赖管理-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.3.2</version>
        <relativePath/>
    </parent>

    <dependencies>
        <!--  Spring Boot核心依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <!-- Spring Boot单元测试和集成测试的依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!-- Spring Boot构建Web应用程序的依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

    </dependencies>

</project>

4.2 server-a的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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.example</groupId>
        <artifactId>spring-cloud-alibaba-demo</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>server-a</artifactId>

    <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <!-- Nacos 现配置管理依赖-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
            <version>2023.0.1.2</version>
        </dependency>
        <!-- Nacos 服务发现依赖-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            <version>2023.0.1.2</version>
        </dependency>

    </dependencies>

</project>

4.3 server-a的application.properties

#spring应用名称
spring.application.name=server-a
#spring启用环境
spring.profiles.active=dev
#nacos服务地址
spring.cloud.nacos.config.server-addr=127.0.0.1:8848
#nacos默认值为public
spring.cloud.nacos.config.namespace=public
#nacos默认值为DEFAULT_GROUP
spring.cloud.nacos.config.group=DEFAULT_GROUP
#nacos配置文件获取设置，用spring应用名称和启用环境拼接而来
spring.config.import=optional:nacos:${spring.application.name}-${spring.profiles.active}.properties

4.3 server-a的org/example/MainServerA.java

package org.example;


import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@SpringBootApplication
@EnableDiscoveryClient //spring cloud开启服务发现功能
public class MainServerA {

    public static void main(String[] args) {
        SpringApplication.run(MainServerA.class, args);
    }

}

4.3 server-a的org/example/controller/ConfigController.java

用于测试配置文件动态更新

// Refer to document:  https://github.com/nacos-group/nacos-examples/tree/master/nacos-spring-cloud-example/nacos-spring-cloud-config-example
package org.example.controller;

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.RestController;

/*
* @RefreshScope用来实现Bean中属性的动态刷新
* */
@RestController
@RequestMapping("/config")
@RefreshScope
public class ConfigController {

    @Value("${project.id}")
    private String projectId;

    @Value("${project.name}")
    private String projectName;

    @RequestMapping("/get")
    public String get() {
        return "project.id=" + projectId + ",project.name=" + projectName;
    }
}

5. 运行代码

5.1 创建配置文件

在Nacos控制台页面创建配置，Data Id为server-a-dev.properties，与application.properties配置文件内容相对应，配置内容为project.id=185,project.name=This is server a。

5.2 注册服务

在MainServerA.java上右键Run启动项目，可以看到控制台打印出了Nacos的相关信息，再看Nacos控制台的服务列表，我们启动的服务出现在列表中。证明服务已成功注册。

5.3 动态获取配置

在浏览器访问http://localhost:8080/config/get，可以看到刚才创建的配置内容，成功返回。
修改配置内容将project.id改为186，然后发布。此时再访问http://localhost:8080/config/get，可以看到返回的project.id变为186，说明动态获取配置成功。