springboot整合nacos配置实现实时更新

本文我将带领大家在springboot2.x的开发框架中整合alibaba-nacos，实现配置获取及刷新等功能。

引用官方介绍：

Nacos 致力于帮助您发现、配置和管理微服务。Nacos 提供了一组简单易用的特性集，帮助您实现动态服务发现、服务配置管理、服务及流量管理。
Nacos 帮助您更敏捷和容易地构建、交付和管理微服务平台。
Nacos 是构建以“服务”为中心的现代应用架构(例如微服务范式、云原生范式)的服务基础设施。

可以看到，Nacos主要面向分布式配置级服务发现等领域，由于之前使用过阿里云的ACM配置服务体验良好，而Nacos便是ACM的开源版本，因此我们选择了Nacos作为
业务框架的分布式配置中心。

接下来开始进行Nacos的整合。

开始之前，要保证已经搭建好Nacos平台。

如何安装Nacos的Server请移步 安装Nacos

引入nacos-config-spring-boot-starter

在pom.xml中添加如下依赖

<!--nacos-discovery-spring-boot-starter-->
<dependency>
    <groupId>com.alibaba.boot</groupId>
    <artifactId>nacos-config-spring-boot-starter</artifactId>
    <version>0.2.1</version>
</dependency>

由于我们的项目的基础是springboot2.x，使用版本0.2.1即可。对于springboot1.x版本需要引入下面的依赖

<!--nacos-discovery-spring-boot-starter-->
<dependency>
    <groupId>com.alibaba.boot</groupId>
    <artifactId>nacos-config-spring-boot-starter</artifactId>
    <version>0.1.1</version>
</dependency>  

application.properties中引入Nacos的config-server地址

在application.properties中添加如下配置

##########################################################################
#
#     Nacos配置
#
##########################################################################
nacos.config.server-addr=172.30.xx.xx:8848,172.30.xx.xx:8848,172.30.xx.xx:8848

我这里使用的nacos服务端是集群模式，地址做了脱敏处理。

编写配置读取类NacosConfigAnnoatationService

Nacos的springboot客户端，提供了简洁易用的API，支持注解方式对配置进行读取即刷新。

@Service
@NacosPropertySource(dataId = "com.gaoyang.marketing.rocketmq.order", groupId="DEFAULT_GROUP", autoRefreshed = true)
public class NacosConfigAnnoatationService implements CommandLineRunner {
     private static final Logger LOGGER = LoggerFactory.getLogger(NacosConfigAnnoatationService.class);

     /**
     * ${name:hello}:key=name,默认值=hello
     */
    @NacosValue(value = "${name:hello}", autoRefreshed = true)
    String name;

     @NacosValue(value = "${interest:world}", autoRefreshed = true)
    String interest;

     @Override
    public void run(String... args) throws Exception {
        while (true) {
            Thread.sleep(4000);
            LOGGER.info("[NacosConfigAnnoatationService]注解方式获取到的配置项目,name={},interest={}", name, interest);
        }
    }
}

接下来对代码进行详细的解释。

我们编写了一个测试类，标记为spring的一个Service, 同时标注

@NacosPropertySource(dataId = "com.gaoyang.marketing.rocketmq.order", groupId="DEFAULT_GROUP", autoRefreshed = true)

使用 @NacosPropertySource 加载 dataId 为 com.gaoyang.marketing.rocketmq.order ，groupId如果不配置，则默认为
DEFAULT_GROUP 的配置源，并开启自动更新。

通过spring的 @Value 注入配置，这里的两个配置是我在后台建立好的，如何建立配置在下一章节进行详细的展开。

以name配置项为例，添加注解

@NacosValue(value = "${name:hello}", autoRefreshed = true)

我们通过@NacosValue 注解设置属性值，name:hello 表示key为name的配置项的默认值为
hello，autoRefreshed=true表示开启自动刷新。

我们通过死循环来测试自动刷新是否生效。

控制台配置配置项

首先进入Nacos配置页面，输入账号密码，进行登录，如图

登录Naocs控制台 登录Naocs控制台

登录成功后在左侧菜单一次展开

配置管理    |-配置列表

配置列表 配置列表

点击 “+” 增加配置项。必填项为：dataId，groupId，配置内容。如图所示

新增配置 新增配置

填写完成后提交即可。

测试配置更新

我们首先运行样例，将项目启动。springboot中，对于标注了 @CommandLineRunner 的类，会在项目启动完后自动加载运行run()方法。

控制台打印如下内容，四秒打印一次，我截取一部分如下

2019-02-22 11:54:51.209 [main] INFO  c.g.m.d.p.config.NacosConfigAnnoatationService [37] - [NacosConfigAnnoatationService]注解方式获取到的配置项目,name=snowalker,interest=coding
2019-02-22 11:54:55.209 [main] INFO  c.g.m.d.p.config.NacosConfigAnnoatationService [37] - [NacosConfigAnnoatationService]注解方式获取到的配置项目,name=snowalker,interest=coding
2019-02-22 11:54:59.210 [main] INFO  c.g.m.d.p.config.NacosConfigAnnoatationService [37] - [NacosConfigAnnoatationService]注解方式获取到的配置项目,name=snowalker,interest=coding

保持项目运行，我们进入管理控制台，在配置列表我们的那一项，点击 编辑

修改name对应的配置为 snowalker23333 点击发布如图

修改配置 修改配置

Nacos后台很贴心的为我们让我们对修改前后的配置项进行二次确认，点击确认发布后，查看控制台日志

2019-02-22 11:55:23.214 [main] INFO  c.g.m.d.p.config.NacosConfigAnnoatationService [37] -[NacosConfigAnnoatationService]注解方式获取到的配置项目,name=snowalker,interest=coding
2019-02-22 11:55:27.215 [main] INFO  c.g.m.d.p.config.NacosConfigAnnoatationService [37] - [NacosConfigAnnoatationService]注解方式获取到的配置项目,name=snowalker2333333,interest=code
2019-02-22 11:55:31.215 [main] INFO  c.g.m.d.p.config.NacosConfigAnnoatationService [37] - [NacosConfigAnnoatationService]注解方式获取到的配置项目,name=snowalker2333333,interest=code

可以看到，在项目运行的过程中，配置项热更新了。

它内部是通过一个Listener监听器在后台监听服务端的推送消息，达到对配置项的热更新的，和配置文件比起来相当方便了。

监听配置更新事件 @NacosConfigListener(dataId = “example”)

type为配置类型，可以为properties yaml json等等
一旦配置变更，该方法将收到消息，做自定义处理

  @Component
  @NacosPropertySource(dataId = "example", autoRefreshed = true, type = ConfigType.JSON)
  public class NacosListener {

      @NacosConfigListener(dataId = "example")
      public void onMessage(String msg){
          System.out.println(msg);
      }
  }

一旦配置被更改，监听的接口将立即收到消息。在示范里我们打印了传来的消息，是更新后的配置

在这里插入图片描述

小结

本文主要从实战的角度，带领读者在springboot2.x中整合了Nacos实现了配置的读取及刷新的功能，从应用的角度出发，应当足够日常开发使用了，更多的
使用技巧和实现细节，我们有机会再讲。

转载于:https://www.cnblogs.com/fswhq/p/11273157.html

https://blog.csdn.net/humorchen99/article/details/110948499