Nacos学习文档

1、Nacos是什么

Nacos是一个动态的服务发现、配置管理、服务管理的平台。
其中服务发现包括服务自动注册和发现。
配置管理包括配置的增删改查、在线编辑、历史版本查询以及恢复等
服务管理包括服务元数据管理、优雅上下线。

2、Nacos名词介绍

• 命名空间（namespace）：用于进行租户粒度的配置隔离。

• 配置分组（group）：Nacos 中的一组配置集，是组织配置的维度之一。
  

• 配置集 ID（data id）：Data ID 通常用于组织划分系统的配置集。
  

• 综上所述：Nacos 数据模型 Key 由三元组唯一确定, Namespace默认是空串，公共命名空间（public），分组默认是 DEFAULT_GROUP。

3、Nacos中的data id是如何组装的？

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

4、Nacos 融合 Spring Cloud，成为注册配置中心

4.1、Maven依赖作用

• 集成 spring-cloud-starter-alibaba-nacos-config 依赖实现配置的动态变更。
• 集成 spring-cloud-starter-alibaba-nacos-discovery 实现服务的注册与发现。

4.2、启动配置管理

4.2.1、添加依赖

<dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId><version>${latest.version}</version>
</dependency>

注意： 版本 2.1.x.RELEASE 对应的是 Spring Boot 2.1.x 版本。版本 2.0.x.RELEASE 对应的是 Spring Boot 2.0.x 版本，版本 1.5.x.RELEASE 对应的是 Spring Boot 1.5.x 版本。

更多版本对应关系参考：版本说明 Wiki

4.2.2、在 bootstrap.yml（也支持properties格式） 中添加 配置中心地址、命名空间、组名、应用名称、环境配置、文件格式

4.2.2.1、名词解释

• 配置中心地址：必须填写
• 命名空间（namespace）：默认是public，可以省略；如果不是该值，必须填写
• 组名（group）：默认是DEFAULT_GROUP，可以省略；如果不是该值，必须填写
• 配置集ID（data id）
  • 应用名称：必须填写
  • 环境配置：非必须填写
  • 文件格式：必须填写，支持 properties 和 yaml 类型，也包括yml类型

4.2.2.2、bootstrap.yml 示例

# Spring
spring: application:# 应用名称name: ruoyi-systemprofiles:# 环境配置active: devcloud:nacos:config:# 配置中心地址server-addr: 127.0.0.1:8848# 命名空间namespace: test_namespace# 组名group: test_group# 配置文件格式file-extension: yaml

4.2.2.3、Nacos配置说明

直接看Nacos中的配置信息：

将bootstrap.yml（左侧）和Nacos（右侧）中的配置信息进行对照：

4.3、启动服务发现

4.3.1、添加依赖

<dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId><version>${latest.version}</version>
</dependency>

注意： 版本 2.1.x.RELEASE 对应的是 Spring Boot 2.1.x 版本。版本 2.0.x.RELEASE 对应的是 Spring Boot 2.0.x 版本，版本 1.5.x.RELEASE 对应的是 Spring Boot 1.5.x 版本。

更多版本对应关系参考：版本说明 Wiki

4.3.2、在 bootstrap.yml（也支持properties格式） 中添加 注册中心地址、命名空间、组名、应用名称、应用端口

4.3.2.1、名词解释

• 注册中心地址：必须填写
• 命名空间（namespace）：默认是public，可以省略；如果不是该值，必须填写
• 组名（group）：默认是DEFAULT_GROUP，可以省略；如果不是该值，必须填写
• 应用名称：必须填写
• 应用端口：必须填写

4.3.2.2、bootstrap.yml 示例

# 端口
server:port: 9201# Spring
spring: application:# 应用名称name: ruoyi-systemcloud:nacos:discovery:# 注册中心地址server-addr: 127.0.0.1:8848# 命名空间namespace: test_namespace# 组名group: test_group

4.3.2.3、Nacos注册结果说明

其中配置管理和服务管理没啥关系

4.3.3、通过 Spring Cloud 原生注解 @EnableDiscoveryClient 开启服务注册发现功能

@SpringBootApplication
@EnableDiscoveryClient
public class NacosProviderApplication {public static void main(String[] args) {SpringApplication.run(NacosProviderApplication.class, args);}@RestControllerclass EchoController {@RequestMapping(value = "/echo/{string}", method = RequestMethod.GET)public String echo(@PathVariable String string) {return "Hello Nacos Discovery " + string;}}
}

4.4、配置用户名和密码

对于配置中心和注册中心，支持统一设置，也支持分别设置

下面是统一设置的效果，然后分别设置时将用户名和密码放在discovery和config下面一级即可

spring: cloud:nacos:# 用户名username: nacos# 密码password: nacos# 服务注册discovery:……# 服务配置config:……

4.5、共享配置

4.5.1、作用

将公共配置从单个服务中抽取出来，然后共享这些配置，做到一处修改，处处生效。从而降低配置错误的风险

4.5.2、在 bootstrap.yml（也支持properties格式） 中添加 组名、配置集ID、自动刷新策略

4.5.2.1、名词解释

• 组名（group）：默认是DEFAULT_GROUP，可以省略；如果不是该值，必须填写
• 配置集ID（data id）：必须填写，即 全名称
• 自动刷新策略：默认是false，该策略开启后和 @RefreshScope 注解配合后，修改配置内容后立即生效

4.5.2.2、bootstrap.yml 示例

spring: cloud:nacos:# 服务配置config:# 配置中心地址server-addr: 127.0.0.1:8848# 命名空间namespace: test_namespace# 组名group: test_group# 配置文件格式file-extension: yaml# 共享配置shared-configs:# 组名- group: test_group# 配置集IDdata-id: application-dev.yaml# 自动刷新策略refresh: true

4.5.2.3、Nacos配置说明

4.6、扩展配置

4.6.1、作用

使用extension-configs，作用和共享配置类似，但是优先级比共享配置高

4.6.2、示例

4.7、配置自动更新

通过 Spring Cloud 原生注解 @RefreshScope 实现配置自动更新

（1）配置@Value注解使用

@RestController
@RequestMapping("/config")
@RefreshScope
public class ConfigController {@Value("${useLocalCache:false}")private boolean useLocalCache;@RequestMapping("/get")public boolean get() {return useLocalCache;}
}

（2）配置@ConfigurationProperties注解使用

/*** 放行白名单配置* 来自RuoYi-Cloud项目* * @author ruoyi*/
@Configuration
@RefreshScope
@ConfigurationProperties(prefix = "security.ignore")
public class IgnoreWhiteProperties
{/*** 放行白名单配置，网关不校验此处的白名单*/private List<String> whites = new ArrayList<>();public List<String> getWhites(){return whites;}public void setWhites(List<String> whites){this.whites = whites;}
}

4.8、配置优先级

1. Nacos中具体的服务配置
2. 扩展配置（多个扩展配置，越靠后优先级越高）
3. 共享配置（多个共享配置，越靠后优先级越高）
4. jar包启动的本地配置

4.9、汇总配置文件 bootstrap.yml 示例

# 应用端口
server:port: 9201# Spring
spring: application:# 应用名称name: ruoyi-systemprofiles:# 环境配置active: devcloud:nacos:# 用户名username: nacos# 密码password: nacos# 服务注册discovery:# 注册中心地址server-addr: 127.0.0.1:8848# 命名空间namespace: test_namespace# 组名group: test_group# 服务配置config:# 配置中心地址server-addr: 127.0.0.1:8848# 命名空间namespace: test_namespace# 组名group: test_group# 配置文件格式file-extension: yaml# 共享配置shared-configs:# 组名- group: test_group# 配置集IDdata-id: application-shared.yaml# 自动刷新策略refresh: true# 扩展配置extension-configs:# 组名- group: test_group# 配置集IDdata-id: application-extension.yaml# 自动刷新策略refresh: true