Nacos探索和实践

默认以spring cloud项目来描述使用方式

使用的版本

  • spring-boot:2.1.x
  • spring-cloud:Greenwich.RELEASE
  • spring-cloud-alibaba:2.1.x
  • java:1.8+

Nacos服务端

服务端相当于euraka和spring-cloud-config的集合,Nacos的web页面,服务注册,和配置全部在服务端上

注册中心

注册中心和eureka差不多,只是Nacos提供了不同的页面,不过可以在服务详情里通过页面控制服务的上下线,这点还是比较方便,和配置中心一样,也可以通过Group+Namespace来管理服务,Nacos的服务的调用支持Feign和Dubbo

注册中心.png

配置中心

Nacos支持spring、spring-boot、spring-cloud的配置管理。

Nacos的服务配置内容必须写在bootstrap.properties/yml中,Nacos默认会去读取以服务名称开头的配置,这里的配置的唯一id就是dataId,其组成如下:

在 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 来配置。目前只支持 propertiesyaml 类型。

除了服务名称开头的配置文件,Nacos还支持通过spring.cloud.nacos.config.shared-configs[n].data-idspring.cloud.nacos.config.extension-configs[n].data-id的方式添加额外的配置,其加载的顺序如下

配置读取的顺序

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

可以参看:https://github.com/alibaba/spring-cloud-alibaba/wiki/Nacos-config

关于spring-boot的配置加载顺序可以参照Externalized Configuration,关于为什么写在bootstrap.properties/yml中可以参照application-context

配置管理

Nacos使用Group和Namespace来管理配置文件,每个配置文件都有一个Group和一个Namespace属性,包含关系是Group在Namespace下,而配置文件在Group下,可以使用这两个属性来区分不同的环境和场景

命名空间.png

搭建Nacos项目

引入spring-cloud-alibaba版本依赖

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

版本依据spring-boot的版本而定,依赖版本可以查看发布版本,如下图

版本管理.png

也可以参看这个https://github.com/alibaba/spring-cloud-alibaba/wiki/%E7%89%88%E6%9C%AC%E8%AF%B4%E6%98%8E

服务端使用

参看Nacos官方

目前项目是直接下载的Nacos稳定版本的压缩包

并使用(Linux)

sh bin/startup.sh -m standalone

单机启动,如果不加-m standalone的话默认是集群模式

启动配置文件conf/application.properties,可以在里面制定数据库,将配置文件存放到数据库中,使用数据库需要先初始化数据库,数据库脚本conf/nacos-mysql.sql

启动后访问http://ip:8848/nacos可以看到Nacos登录页面,默认登录账户名密码 nacos nacos

登录页面.png

注册中心使用

引入依赖

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

在bootstrap.yml或者bootstrap.properties中加入注册中心设置

# Nacos的地址
spring.cloud.nacos.discovery.server-addr=Nacos-server地址
# 命名空间,可不填,默认public
spring.cloud.nacos.discovery.namespace=NACOS命名空间

如果要使用Feign,和以前euraka的使用方法一致,Dubbo可以参看https://nacos.io/zh-cn/docs/use-nacos-with-dubbo.html

配置中心使用

引入依赖

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>

在bootstrap.yml或者bootstrap.properties中加入配置中心设置

spring.cloud.nacos.config.server-addr=Nacos-server地址
# 这个是必须要的
spring.application.name=example

如果不需要额外配置的话就使用这个就可以了

如果需要添加额外的配置,这里只列举一些项目中用的比较多的配置

读取配置的顺序可以参考

# 文件后缀,这个配置只影响默认的配置(即服务名称+环境+文件后缀的形式)
spring.cloud.nacos.config.file-extension=properties
# 文件分组,这个配置只影响默认的配置(即服务名称+环境+文件后缀的形式)
spring.cloud.nacos.config.group=APPLICATION_GROUP
# 共享的配置(DEFAULT_GROUP)
spring.cloud.nacos.config.shared-configs=application.properties
# NACOS的命名空间
spring.cloud.nacos.config.namespace=NACOS的命名空间
# 额外配置
spring.cloud.nacos.config.extension-configs[0].data-id=xxxxx.properties
# 是否自动更新,默认是false,可以不写
spring.cloud.nacos.config.extension-configs[0].refresh=true
# 分组(默认是DEFAULT_GROUP,可以不写
spring.cloud.nacos.config.extension-configs[0].group=DEFAULT_GROUP
spring.cloud.nacos.config.extension-configs[1].data-id=xxx.properties
spring.cloud.nacos.config.extension-configs[1].refresh=true

动态刷新

在项目(Spring cloud项目)中使用@RefeshScope注解就可以实现动态刷新

@RestController
@RequestMapping("/config")
@RefreshScope
public class ConfigController {

    @Value("${useLocalCache:false}")
    private boolean useLocalCache;

    @RequestMapping("/get")
    public boolean get() {
        return useLocalCache;
    }
}

这里在nacos上修改了useLocalCache为true之后,然后调用接口,可以看到接口返回的值为true

使用该注解可以引入依赖

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-context</artifactId>
</dependency>

批量导入配置

Nacos支持批量导入配置,目前我所知有两种方式

  • 直接将Nacos的数据库导出sql,然后再导入另外的数据库
  • 在页面上使用导入配置功能

这里只介绍第二种方式,选择配置管理->配置列表,要导入的命名空间


导入配置.png
上传文件.png

选择上传文件,Nacos目前好像只支持zip压缩包

配置要放在一个文件夹中,文件夹的名称为导入后的Group名称,所以导入的结构

└─Group名称
└─xxx.properties
└─xxx.yml

弄好之后压缩为zip文件,然后导入即可

项目应用说明

目前在项目中使用Nacos作为配置中心和注册中心,本地只留了一个bootstrap.properties文件,其他配置全部使用nacos管理,使用Nacos的命令空间来管理不同环境的配置,如果目前项目使用check和pro来表示命名空间,使用group来区分公共文件和服务配置文件,如APPLICATION_GROUP和DEFAULT_GROUP,注册中心目前就是简单的注册功能,Nacos目前使用的是单机+mysql

附录

Nacos GitHub

Nacos文档

Spring Cloud Alibaba GitHub

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

推荐阅读更多精彩内容