深入浅出Spring Cloud 整合nacos

什么是 Nacos

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

下载步骤

1 点击下方链接

github-alibaba-nacos-releases

2 下载压缩包，以最新版2.0.3为例

3 解压内容如图所示

bin 目录 - nacos 启动和停止相关

conf 目录 - nacos 集群、端口配置以及Sql文件相关

log 目录 - nacos 运行产生的日志文件

target 目录 - nacos 存放 nacos jar包

单机启动服务

Linux Unix Mac

sh startup.sh -m standalone

Windows

startup.cmd -m standalone

以windows为例

nacos控制台

以8848端口为例访问下面链接即可

http://127.0.0.1:8848/nacos/#/login

默认账号密码 nacos / nacos

登录后界面如图所示

主要功能如下图

Nacos Config配置管理

Nacos 提供用于存储配置和其他元数据的 key/value 存储，为分布式系统中的外部化配置提供服务器端和客户端支持。使用 Spring Cloud Alibaba Nacos Config，您可以在 Nacos Server 集中管理你 Spring Cloud 应用的外部属性配置。

Spring Cloud Alibaba Nacos Config 是 Config Server 和 Client 的替代方案，客户端和服务器上的概念与 Spring Environment 和 PropertySource 有着一致的抽象，在特殊的 bootstrap 阶段，配置被加载到 Spring 环境中。当应用程序通过部署管道从开发到测试再到生产时，您可以管理这些环境之间的配置，并确保应用程序具有迁移时需要运行的所有内容。

参考文档地址如下

Spring Cloud Alibaba Nacos Config

支持profile粒度的配置

spring.profiles.active=develop

spring.profiles.active当通过配置文件来指定时必须放在 bootstrap.properties/yml 文件中。

配置的优先级

Spring Cloud Alibaba Nacos Config 目前提供了三种配置能力从 Nacos 拉取相关的配置。

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

完全关闭配置

通过设置 spring.cloud.nacos.config.enabled = false 来完全关闭 Spring Cloud Nacos Config

Spring Cloud模块使用nacos config

1 模块添加依赖

<dependency>
	<groupId>com.alibaba.cloudgroupId>
	<artifactId>spring-cloud-starter-alibaba-nacos-configartifactId>
dependency>

2 配置文件新建bootstrap.yml或bootstrap.properties

spring:
  profiles:
    active: prod
  application:
    name: order
  cloud:
    nacos:
      config:
        group: DEFAULT_GROUP
        server-addr: 127.0.0.1:8848
        file-extension: yaml

file-extension默认为properties

private String fileExtension = "properties";

3 直接启动测试

  WARN 6496 --- [           main] c.a.c.n.c.NacosPropertySourceBuilder     : Ignore the empty nacos configuration and get it based on dataId[order] & group[DEFAULT_GROUP]
  WARN 6496 --- [           main] c.a.c.n.c.NacosPropertySourceBuilder     : Ignore the empty nacos configuration and get it based on dataId[order.yaml] & group[DEFAULT_GROUP]
  WARN 6496 --- [           main] c.a.c.n.c.NacosPropertySourceBuilder     : Ignore the empty nacos configuration and get it based on dataId[order-prod.yaml] & group[DEFAULT_GROUP]

系统启动失败并发出三个警告 order、order.yaml、order-prod.yaml三个配置文件为空，配置失败，
说明系统已经从nacos服务上寻找配置文件了

4 新建配置文件

Data ID ：默认规范 spring.application.name + spring.profiles.active + file-extension:properties 三部分组成 ，由第二步，应用名 order，应用配置文件prod，后缀为 yaml，组合得 order-prod.yaml，但其实默认配置三个warn中匹配任意一个即可。

Group: DEFAULT_GROUP

配置格式：选择常用的yaml或者properties即可。

按照上面步骤配置完成后效果如图所示。

点击编辑按钮可以对配置文件内容进行修改。

5 测试

在controller层编写获取配置文件的值，这里以redis host为例。

不给默认值可以在编译阶段发现配置文件有无读取成功，如没读取到配置文件，模块会报错，启动失败。

@RestController
@RefreshScope
public class HelloController {

    @Value(value = "${spring.redis.host}")
    private String key;

    @GetMapping("/value")
    public String get() {
        return key;
    }
 }

测试请求返回 127.0.0.1 成功读取配置内容

点击编辑按钮，修改host的值为127.0.0.2，点击发布

再次访问上面接口发现更新配置成功读取

当完成配置修改发布的时候，控制台会输出相应信息

 [.16.25.57_28848] c.a.n.client.config.impl.ClientWorker    : [fixed-172.16.25.57_28848] [polling-resp] config changed. dataId=order, group=DEFAULT_GROUP
 [.16.25.57_28848] c.a.n.client.config.impl.ClientWorker    : get changedGroupKeys:[order+DEFAULT_GROUP]

配置管理 历史版本

历史版本会保留30天，可输入Data ID和Group匹配相应的历史文件以回滚或查看详情。

服务管理

Spring Cloud Alibaba Nacos Discovery文档

模块使用

1 添加依赖

       <dependency>
            <groupId>com.alibaba.cloudgroupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discoveryartifactId>
        dependency>

2 nacos config或 application.yml配置

spring:
  application:
    name: order
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848

3 主启动类添加注解 @EnableDiscoveryClient

4 nacos 控制台查看

Nacos切换Mysql数据库来做持久化

nacos默认内置derby数据库

<dependency>
	<groupId>org.apache.derbygroupId>
	<artifactId>derbyartifactId>
	<version>${derby.version}version>
dependency>

1 创建数据库nacos-config执行nacos2.0.3\conf\nacos-mysql.sql脚本

执行成功后效果如图所示

2 修改配置文件nacos2.0.3\conf\application.properties

3 打开nacos控制台新建配置。

4 打开nacos-config 的config_info表查看结果，可以看到修改数据库已经成功。

Windows下集群部署

1 复制Nacos

2 修改application.properties中server.port为对应端口号

server.port=8848 / 8850 / 8852

3 将默认的cluster.conf.example修改为cluster.conf

conf文件添加节点信息

4 配置cluster.conf注意事项

Nacos2.x部署时需要考虑端口偏移，如8848会额外占用 9848和9849端口。

5 双击 startup.cmd 默认以集群的形式启动

提示 nacos is starting with cluster ，

如果版本过低可能会默认以单机版启动，具体查看startup.cmd中的启动模式。

6 打开Nacos 控制台查看集群运行情况

问题记录

nacos config - Spring Cloud 2020版本bootstrap问题

原文内容

翻译：

要使用传统的引导程序连接到配置服务器，引导程序必须通过属性或 spring-cloud-starter-bootstrap 启动器启用。属性是 spring.cloud.bootstrap.enabled=true。它必须设置为系统属性或环境变量。启动引导程序后，任何在类路径上使用 Spring Cloud Config Client 的应用程序都将连接到 Config Server，如下所示：当配置客户端启动时，它绑定到 Config Server（通过 spring.cloud.config.uri 引导程序配置属性）和使用远程属性源初始化 Spring Environment。

这种行为的最终结果是，所有想要使用配置服务器的客户端应用程序都需要一个 bootstrap.yml（或一个环境变量），其服务器地址设置在 spring.cloud.config.uri（默认为“http:/ /localhost:8888")。

官方链接

参考博客

解决方案一

主启动类添加属性

public class MicOrderApplication {
    public static void main(String[] args) {
        System.setProperty("spring.cloud.bootstrap.enabled", "true");
        SpringApplication.run(MicOrderApplication.class, args);
    }

}

解决方案二

添加依赖

<dependency>
	<groupId>org.springframework.cloudgroupId>
	<artifactId>spring-cloud-starter-bootstrapartifactId>
dependency>