Spring Cloud alibaba 使用Nacos配置中心

没事儿写两篇

已于 2022-12-29 11:16:54 修改

阅读量1k

点赞数 1

分类专栏：人在江湖之Spring Cloud aibaba 文章标签： java spring boot Spring Cloud Nacos 配置中心

于 2022-12-28 17:33:23 首次发布

本文链接：https://blog.csdn.net/forlinkext/article/details/128444729

版权

人在江湖之Spring Cloud aibaba 专栏收录该内容

24 篇文章 3 订阅

订阅专栏

依赖管理

Spring Cloud Alibaba BOM 包含了它所使用的所有依赖的版本
请将下面的 BOM 添加到 pom.xml 中的部分。这将允许我们省略任何Maven依赖项的版本，而是将版本控制委派给BOM。

<dependencyManagement>
    <dependencies>
        <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>

引用时，请注意版本对应关系。比如我们的示例版本为：2021.0.4.0。其与Spring Boot以及Spring Cloud的版本对应关系如下(为避免不必要的依赖冲突，请按照如下版本对应关系验证本文示例)

Spring Cloud Alibaba Version	Spring Cloud Version	Spring Boot Version
2021.0.4.0*	Spring Cloud 2021.0.4	2.6.11

目前最新版本是2022.x，支持Spring Boot 3.0，我们知道Spring Boot 3.0.x需要使用java 17，针对国内大多数应用来说，目前还是java8，所以本文还是选用java8支持的版本。

更多的版本对应关系请参考官网：Spring Cloud Alibaba maven依赖版本对应关系

完整pom依赖配置

一个完整的Spring Cloud Alibaba的pom.xml依赖如下

dependencies标签中的依赖根据自己实际情况引入即可。此处只是Nacos的使用示例

<?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>CloudDemo</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <build.name>CloudDemo</build.name>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>

        <spring.cloud.version>2021.0.4</spring.cloud.version>
        <spring.cloud.alibaba.version>2021.0.4.0</spring.cloud.alibaba.version>
    </properties>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.11</version>
    </parent>

    <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>${spring.cloud.alibaba.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <dependencies>

        <!-- 使用Nacos服务注册与发现 -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

        <!-- 使用Nacos配置管理 -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>

        <!-- 支持读取bootstrap配置 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-bootstrap</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <scope>test</scope>
        </dependency>
        <!-- 添加web依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

    </dependencies>
</project>

添加bootstrap.properties配置

# 引用pom文件中配置的profile（注意名称的对应）
spring.profiles.active=@profileActive@
# 应用名称
spring.application.name=myCloud
# Nacos配置
spring.cloud.nacos.config.server-addr=127.0.0.1:8848
# 配置的group（默认DEFAULT_GROUP）
spring.cloud.nacos.config.group=DEFAULT_GROUP
# 配置后缀默认是properties（只支持properties和ymal）
spring.cloud.nacos.config.file-extension=properties
# 是否开启自动刷新配置（默认true）
spring.cloud.nacos.config.refresh-enabled=true

注意当你使用域名的方式来访问 Nacos 时，spring.cloud.nacos.config.server-addr 配置的方式为域名:port。例如 Nacos 的域名为abc.com.nacos，监听的端口为 80，则 spring.cloud.nacos.config.server-addr=abc.com.nacos:80。注意 80 端口不能省略。

在 Nacos Spring Cloud 中，dataId 的完整格式如${prefix}-${spring.profiles.active}.${file-extension}

prefix 默认为 spring.application.name 的值，也可以通过配置项 spring.cloud.nacos.config.prefix来配置。
spring.profiles.active 即为当前环境对应的 profile，详情可以参考 Spring Boot文档。注意：当 spring.profiles.active 为空时，对应的连接符 - 也将不存在，dataId 的拼接格式变成 ${prefix}.${file-extension}
file-exetension 为配置内容的数据格式，可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。目前只支持 properties 和 yaml 类型。

注：Nacos Config相关的配置必须放在 bootstrap.properties 配置文件中，放在application.properties中自动刷新配置不会生效。

一般情况下，我们的应用，应该需要配置profile，而且要应用Spring Boot和Maven的profile组合配置。所以，我们的pom文件丰富一下

<?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>CloudDemo</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <build.name>CloudDemo</build.name>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>

        <spring.cloud.version>2021.0.4</spring.cloud.version>
        <spring.cloud.alibaba.version>2021.0.4.0</spring.cloud.alibaba.version>
    </properties>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.11</version>
    </parent>

    <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>${spring.cloud.alibaba.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <dependencies>

        <!-- 使用Nacos服务注册与发现 -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

        <!-- 使用Nacos配置管理 -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>

        <!-- 支持读取bootstrap配置 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-bootstrap</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <scope>test</scope>
        </dependency>
        <!-- 添加web依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

    </dependencies>


    <profiles>
        <profile>
            <id>dev</id>
            <properties>
                <profileActive>dev</profileActive>
            </properties>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
        </profile>
        <profile>
            <id>test</id>
            <properties>
                <profileActive>test</profileActive>
            </properties>
        </profile>
        <profile>
            <id>pre</id>
            <properties>
                <profileActive>pre</profileActive>
            </properties>
        </profile>
        <profile>
            <id>prod</id>
            <properties>
                <profileActive>prod</profileActive>
            </properties>
        </profile>
    </profiles>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>

        <finalName>${build.name}</finalName>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <filtering>true</filtering>
                <includes>
                    <include>mapper/**/*.xml</include>
                    <include>application.properties</include>
                    <include>application-${profileActive}.properties</include>
                    <include>bootstrap.properties</include>
                    <include>logback-spring.xml</include>
                </includes>
            </resource>
        </resources>
    </build>

</project>

application.properties配置

# 当前应用的访问端口
server.port=8701
# 当前应用的访问上下文
server.servlet.context-path=/myCloud

编写启动类

package com.yyoo.cloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication(scanBasePackages = {"com.yyoo"})
public class Application {

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

}

本示例的启动类和普通的Spring Boot项目启动类没什么两样.

编写测试Controller

package com.yyoo.cloud.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;

@RestController
@RequestMapping("conf")
@RefreshScope
public class TestConfController {

    @Value("${name:默认值}")
    private String name;

    @RequestMapping("getName")
    public String getName(){
        System.out.println(this.name);
        return this.name;
    }

}

@RefreshScope是Spring Cloud 的原生注解，用于实现配置自动更新。

在Nacos界面上添加对应的配置

在这里插入图片描述

启动应用并访问

启动后访问 http://localhost:8701/myCloud/conf/getName
界面显示结果：没事儿写两篇

在界面修改配置 name=没事儿写两篇2 ，再次访问链接
界面显示结果：没事儿写两篇2

自定义扩展的 Data Id 配置

我们上面的示例，配置的dataId是通过特定的规则来自动匹配的，这样很方便，但是也限制的很死。我们的同样的应用部署在不同的服务器，可能只是些许配置不一样，怎样能共用一样的配置呢？上面的方式显然是不行的。

Spring Cloud Alibaba Nacos Config 从 0.2.1 版本后，可支持自定义 Data Id 的配置。

使用spring.cloud.nacos.config.extension-configs配置

# 自定义扩展dataId ，extension-configs是个列表，意味着可以配置多个
# 必须带文件扩展名，文件扩展名既可支持 properties，又可以支持 yaml/yml。
# 此时 spring.cloud.nacos.config.file-extension 的配置对自定义扩展配置的 Data Id 文件扩展名没有影响。
spring.cloud.nacos.config.extension-configs[0].data-id=myCloud-common1.yml
# 配置的group，默认DEFAULT_GROUP
spring.cloud.nacos.config.extension-configs[0].group=COMMON_GROUP
# 是否自动刷新（注意：这里默认是false，如果需要自动刷新，必须配置为true）
spring.cloud.nacos.config.extension-configs[0].refresh=true

注意以上配置也是在bootstrap.properties中配置

在Nacos中新增配置

在这里插入图片描述

使用ConfigurationProperties来接收

package com.yyoo.cloud.conf;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

@Data
@Configuration
@ConfigurationProperties("my.mycloud")
public class CommonConf {

    private String name;

    private int age;

    private String desc;

}

我们这里没有添加@RefreshScope注解，因为我们使用spring.cloud.nacos.config.extension-configs[0].refresh=true配置了，所以配置是会自动刷新的。

TestController读取配置

    @Resource
    private CommonConf conf;
    
    @RequestMapping("getCommonConf")
    public String getCommonConf() throws JsonProcessingException {
        System.out.println(conf);
        return this.conf.toString();
    }

访问链接后输出结果：CommonConf(name=没事儿写两篇, age=12, desc=Spring Cloud 学习)

注意：TestController中的CommonConf 是被代理之后的对象，包含很多内容，建议不要用json进行转换打印。

spring.cloud.nacos.config.shared-configs配置

spring.cloud.nacos.config.shared-configs[0].data-id=myCloud-common1.yml
spring.cloud.nacos.config.shared-configs[0].group=COMMON_GROUP
spring.cloud.nacos.config.shared-configs[0].refresh=true

其用法和extension-configs一样。其主要作用是为了更加清晰的在多个应用间配置共享的 Data Id。

各种配置方式的优先级

A: 通过 spring.cloud.nacos.config.shared-configs[n].data-id 支持多个共享 Data Id 的配置
B: 通过 spring.cloud.nacos.config.extension-configs[n].data-id 的方式支持多个扩展 Data Id 的配置
C: 通过内部相关规则(应用名、应用名+ Profile )自动生成相关的 Data Id 配置

当三种方式共同使用时，他们的一个优先级关系是:A < B < C

总结

我们实际项目当中可能涉及到要在Nacos中添加很多配置，这些配置如何区分，如何定位？
Nacos的概念中，dataId、group、namespace是主要的区分和定位作用。本文示例中没有使用namespace，其实如果我们命名规则定义的好，只通过dataId和group也能精准定位。根据自身的需要制定合理的规则即可。