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控制台

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

配置管理    |-配置列表

配置列表

点击 “+” 增加配置项。必填项为: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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,902评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,037评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,978评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,867评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,763评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,104评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,565评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,236评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,379评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,313评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,363评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,034评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,637评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,719评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,952评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,371评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,948评论 2 341

推荐阅读更多精彩内容