前言:
Nacos 是 alibaba 出品的微服务组件,Nacos 支持几乎所有主流类型的服务的发现、配置和服务管理平台,提供注册中心、配置中心和动态DNS服务三大功能,能够无缝对接 Springcloud、Spring、Dubbo等流行框架,本篇我们分享一下 Nacos 的注册中心和配置中心功能。
Nacos 系列文章传送门:
Nacos 初步认识和 Nacos 部署细节
Nacos 注册中心
注册中心核心依赖
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
使用 Nacos 之前必须要确定 Spring Cloud Alibaba、Spring Cloud、Spring Boot 之间的版本关系,三者关系必须协调,否则无法使用,详细版本关系传送门:版本说明
本篇中使用的版本如下:
Spring Boot:<version>2.4.5</version>
Nacos:<version>2020.0.RC1</version>
Spring Cloud:<version>2.2.2.RELEASE</version>
bootstrap.properties 文件添加配置
#服务名称
spring.application.name=my-study-spring-boot
#服务端口
server.port=8081
#区分不同环境的配置文件
spring.profiles.active=dev
#nacos 账号密码
spring.cloud.nacos.username=nacos
spring.cloud.nacos.password=nacos
#nacos 地址
spring.cloud.nacos.server-addr=127.0.0.1:8848
#名称空间 默认 public
spring.cloud.nacos.discovery.namespace=public
#分组
spring.cloud.nacos.discovery.group=study
启动类上增加 @EnableDiscoveryClient 注解
@Slf4j
@EnableDiscoveryClient
@SpringBootApplication
public class MyStudySpringBootApplication {
public static void main(String[] args) {
SpringApplication.run(MyStudySpringBootApplication.class, args);
}
}
启动服务验证注册结果
由截图可知结果符合预期,服务正常注册到 Nacos 上了,Nacos 作为注册中心功能验证完毕。
Nacos 配置中心
核心配置
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
bootstrap.properties 文件添加配置
#命名空间 ID 用于区分不同环境和应用 默认的 public 空间时候无需配置(或者直接留空即可) 否侧配置中心不生效
spring.cloud.nacos.config.namespace=d5a53ce5-4288-401f-a748-f5c79bbd3ab3
#配置分组 默认即可 也可以自定义分组
spring.cloud.nacos.config.group=DEFAULT_GROUP
#默认为 spring.application.name 的值 也可以通过配置项 spring.cloud.nacos.config.prefix 来配置
spring.cloud.nacos.config.prefix=my-study-spring-boot
#配置名称 首先使用配置的前缀 然后再使用名称 最后使用 spring.application.name
spring.cloud.nacos.config.name=my-study-spring-boot
#配置文件格式后缀 默认为 properties
spring.cloud.nacos.config.file-extension=properties
#用于控制是否启用配置刷新功能 默认为true
spring.cloud.nacos.config.refresh-enabled=true
#配置拉取长轮询超时时间 单位为毫秒 默认为 30000 毫秒
spring.cloud.nacos.config.timeout=3000
特别注意
spring.cloud.nacos.config.namespace 配置项如果用默认的 public,请不要加该项配置,只有当自己新建了名称空间的时候才需要使用该配置项,配置的值是一个类似 UUID 的字符串,如下:
测试验证 Nacos 配置中心
Nacos 增加配置,如下:
server.port=8089
com.study.test.prefix=myStarter
com.study.test.suffix=hello
@RestController
public class MyController {
@Value("${com.study.test.prefix}")
private String prefix;
@Value("${com.study.test.suffix}")
private String suffix;
@GetMapping("/test-nacos")
public String testNacos() {
return prefix + "~" + suffix;
}
}
测试结果符合预期,如下:
Nacos 配置不生效时,需要添加以下依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-bootstrap</artifactId>
</dependency>
配置自动刷新
使用 @RefreshScope 注解
在 Nacos 上修改了配置,只需要在需要被刷新的类上加上 @RefreshScope 注解即可,@RefreshScope 注解是 Spring Cloud 提供的一种属性刷新机制,它可以应用于需要动态刷新的类或方法上,当Nacos上的属性值发生变化时,通过调用 /actuator/refresh 端点来刷新被注解的类或方法。
@RefreshScope
@RestController
public class MyController {
@Value("${com.study.test.prefix}")
private String prefix;
@Value("${com.study.test.suffix}")
private String suffix;
@GetMapping("/test-nacos")
public String testNacos() {
return prefix + "~" + suffix;
}
}
使用 @NacosValue 注解
@NacosValue注解是Nacos提供的一种属性刷新机制。它可以直接应用于类的属性上,当Nacos上的属性值发生变化时,自动刷新注解的属性,代码如下:
@NacosValue(value = "${com.study.test.prefix}", autoRefreshed = true)
private String prefix;
@NacosValue(value = "${com.study.test.suffix}", autoRefreshed = true)
private String suffix;
建议使用 @RefreshScope 注解方式。
扩展配置集
扩展配置集支持数组方式的加载配置文件,配置组根据自己选择配置即可,需要注意的是扩展配置集是默认不自动刷新的,如果需要自动刷新需要添加配置,扩展配置集的使用可以让我们的配置更加模块化、更加清晰,例如可以让数据配置一个配置集、Redis 配置一个配置集、MQ 一个配置集等等。
#扩展配置集 value 写配置集名称即可
spring.cloud.nacos.config.extension-configs[0].data-id=extension-configs.properties
#扩展配置集合配置组 默认 DEFAULT_GROUP
spring.cloud.nacos.config.extension-configs[0].group=DEFAULT_GROUP
#动态刷新 默认是false
spring.cloud.nacos.config.extension-configs[0].refresh=true
#扩展配置集 value 写配置集 DataId 即可
spring.cloud.nacos.config.extension-configs[1].data-id=extension-configs2.properties
#扩展配置集合配置组 默认 DEFAULT_GROUP
spring.cloud.nacos.config.extension-configs[1].group=DEFAULT_GROUP
#动态刷新 默认是false
spring.cloud.nacos.config.extension-configs[1].refresh=true
Nacos 配置如下图
最后附上本篇使用的 pom.xml 文件,如下:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.4.5</version>
<relativePath/>
</parent>
<groupId>com.my.study</groupId>
<artifactId>my-study-spring-boot</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>my-study-spring-boot</name>
<description>my-study-spring-boot</description>
<url/>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
<version>2020.0.RC1</version>
</dependency>
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
<version>2020.0.RC1</version>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-bootstrap</artifactId>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-commons</artifactId>
<version>2.2.2.RELEASE</version>
<scope>compile</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
欢迎提出建议及对错误的地方指出纠正。