快速搭建 SpringCloud Alibaba Nacos 配置中心

2023-02-28

功能 org 配置文件

SpringCloudAlibaba是阿里巴巴提供的一站式微服务开发解决方案，目前已被SpringCloud官方收录。而Nacos作为SpringCloudAlibaba的核心组件之一，提供了两个非常重要的功能：服务注册中心（服务注册和发现）功能，和统一配置中心功能。Nacos简介Nacos致力于帮

Spring Cloud Alibaba 是阿里巴巴提供的一站式微服务开发解决方案，目前已被 Spring Cloud 官方收录。而 Nacos 作为 Spring Cloud Alibaba 的核心组件之一，提供了两个非常重要的功能：服务注册中心（服务注册和发现）功能，和统一配置中心功能。

Nacos 简介

Nacos 致力于帮助开发者发现、配置和管理微服务。它提供了一组简单易用的特性集，帮助开发者快速实现动态服务发现、服务配置、服务元数据及流量管理。

Nacos 特性介绍

Nacos 具有以下特性：

服务发现和服务健康监测：支持基于DNS和基于RPC的服务发现，支持对服务的实时的健康检查，阻止向不健康的主机或服务实例发送请求。
动态配置服务：动态配置服务可以让您以中心化、外部化和动态化的方式管理所有环境的应用配置和服务配置。
动态 DNS 服务：动态 DNS 服务支持权重路由，让您更容易地实现中间层负载均衡、更灵活的路由策略、流量控制以及数据中心内网的简单 DNS 解析服务。
服务及其元数据管理：支持从微服务平台建设的视角管理数据中心的所有服务及元数据。

配置中心功能实现

1、添加依赖

创建一个新的 Spring Boot 项目，添加 nacos config 和 web（非必须）框架依赖，如下图所示：

PS：添加 web 依赖主要作用是为了方便后面代码测试。

如果是老项目，那么需要手动添加 nacos config 的依赖，修改 pom.xml 文件，添加以下内容：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>1.
2.
3.
4.
5.
6.
7.
8.

2、配置 Nacos Config 信息

在应用的 /src/main/resources/ 目录下，创建引导配置文件 bootstrap.yml（或 bootstrap.properties），添加以下 Nacos Config 配置信息：

spring:
  application:
    name: nacosconfig # 项目名称和 nacos DataId 相匹配
  cloud:
    nacos:
      config:
        server-addr: 127.0.0.1:8848 # nacos 地址和端口
        file-extension: yaml # 获取配置文件的格式：yaml
        username: nacos # nacos 认证用户名
        password: nacos # nacos 认证密码
server:
  port: 9001 # 项目启动端口1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.

3、编写代码读取配置文件

创建一个控制器，使用 @Value 注解读取配置信息，读取方式和 Spring Boot 读取本地配置代码一致：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class TestController {
    // 从 nacos 中读取配置项 config.info
    @Value("${config.info}")
    private String configInfo;
    @GetMapping("/getconfig")
    public String getConfigInfo(){
        return configInfo;
    }
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.

4、Nacos 控制台添加配置信息

在 Nacos 控制台创建并设置配置文件，执行步骤如下所示。

首先，在配置列表中点击“添加”按钮，如下图所示：

进入配置页面，新建 YAML 或 Properties 配置文件，如下图所示：

以上关键参数的含义和规则说明如下。

（1）Data ID

Data ID 的拼接格式如下：

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

其中

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

（2）Group

Group 分组选项，主要是用来隔离不同的配置项目的，它的默认值为 DEFAULT_GROUP，可以通过
spring.cloud.nacos.config.group 配置。

配置好相应的内容之后，点击底部的“发布”按钮即可，添加成功之后会自动返回配置列表，如下图所示：

启动项目，查看执行结果如下图所示：

动态刷新功能

动态刷新功能是指：在 Nacos 配置中心修改的配置内容，在不重启项目的前提下可以实时的读取到。

Nacos 默认会为所有获取数据成功的 Nacos 的配置项添加了监听功能，在监听到服务端配置发生变化时会实时触发

org.springframework.cloud.context.refresh.ContextRefresher 的 refresh 方法。

但如果需要对 Bean 进行动态刷新，需要参照 Spring 和 Spring Cloud 规范，推荐给类添加 @RefreshScope 或 @ConfigurationProperties 注解。

以上面的案例来说，如果需要添加动态刷新功能，只需要在控制器上添加 @RefreshScope 注解即可，实现代码如下：

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.RestController;
@RestController
@RefreshScope // 开启配置文件的动态刷新
public class TestController {
    // 从 nacos 中读取配置项 config.info
    @Value("${config.info}")
    private String configInfo;

    @GetMapping("/getconfig")
    public String getConfigInfo(){
        return configInfo;
    }
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.