所有代码都在github上:https://github.com/demonruin/cloud2020/tree/master
所有的资料都来源官网,首先先打开Spring的官网https://spring.io,然后进入Projects分类,进入SpringCloud的官网https://spring.io/projects/spring-cloud,再点击Spring Cloud Alibaba,选择learn,选择版本进入Reference Doc. 然后选择Spring Cloud Alibaba Nacos Config.
Nacos部分详情参见官网 文档 https://nacos.io/zh-cn/docs/quick-start-spring-cloud.html
下面开始演示构建基于Nacos配置中心的3377案例
1、首先构建module,cloudalibaba-nacos-config-client3377
2、添加pom文件依赖
<!--nacos-config-->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
<!--nacos-discovery-->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
3、添加bootstrap.yml 和 application.yml文件
Nacos同springcloud-config一样,在项目初始化时,要保证先从配置中心进行配置拉取,拉取配置之后,才能保证项目的正常启动。
springboot中配置文件的加载是存在优先级顺序的,bootstrap优先级高于application
bootstrap.properties:位于jar包外的优先级最高
application.properties:配置中心的文件 > 命令行配置 > 本地active指定文件 > 本地default文件,
高优先级的会覆盖低优先级的 重复的 配置内容。
bootstrap.yml配置
# nacos配置
server:
port: 3377
spring:
application:
name: nacos-config-client
cloud:
nacos:
discovery:
server-addr: localhost:8848 #Nacos服务注册中心地址
config:
server-addr: localhost:8848 #Nacos服务配置中心地址
file-extension: yaml #指定yaml格式的配置,此处注意只有yaml和properties两种格式,需要注意
# ${spring.application.name}-${spring.profile.active}.${spring.cloud.nacos.config.file-extension}
# nacos-config-client-dev.yaml
# nacos-config-client-test.yaml ----> config.info
application.yml配置
spring:
profiles:
active: dev #表示激活开发环境
4、构建主启动类
@SpringBootApplication
@EnableDiscoveryClient
public class NacosConfigClientMain3377 {
public static void main(String[] args) {
SpringApplication.run(NacosConfigClientMain3377.class,args);
}
}
5、构建业务controller,并添加注解@RefreshScope动态刷新功能,通过 Spring Cloud 原生注解 @RefreshScope
实现配置自动更新
@RestController
@Slf4j
@RefreshScope //支持Nacos的动态刷新功能。
public class ConfigController {
@Value("${config.info}")
private String configInfo;
@GetMapping("/config/info")
public String getConfigInfo() {
return configInfo;
}
}
6、启动Nacos服务,在配置管理中的配置列表中添加配置
详情可参见nacos官网https://nacos.io/zh-cn/docs/quick-start-spring-cloud.html
Nacos中的dataid的组成格式与SpringBoot配置文件中的匹配规则:
在 Nacos Spring Cloud 中,dataId
的完整格式如下:
${prefix}-${spring.profile.active}.${file-extension}
prefix
默认为spring.application.name
的值,也可以通过配置项spring.cloud.nacos.config.prefix
来配置。spring.profile.active
即为当前环境对应的 profile,详情可以参考 Spring Boot文档。 注意:当spring.profile.active
为空时,对应的连接符-
也将不存在,dataId 的拼接格式变成${prefix}.${file-extension}
file-exetension
为配置内容的数据格式,可以通过配置项spring.cloud.nacos.config.file-extension
来配置。目前只支持properties
和yaml
类型。
注意:上述官网说spring.profile.active
可以为空,但是不推荐,可能会有很多隐藏坑~
所以springboot配置文件中的spring.application.name+spring.profile.active+yaml/properties就可确定Nacos中的Data ID了: nacos-config-client-dev.yaml。
注意:data Id 中后缀一定要是yaml或者propertites,如果误填写yml,可能会导致如下异常信息:
Caused by: java.lang.IllegalArgumentException: Could not resolve placeholder 'config.info' in value "${config.info}"
此时只需要删除新建好的配置,重新改成yaml即可~
7、启动nacos-config-client3377,测试接口http://localhost:3377/config/info
8、因为自带刷新功能,所以修改下Nacos中的yaml配置文件,再次调用查看配置的接口,就会发现配置已经刷新
至此,基于Nacos的 服务 配置中心 基本配置案例搭建到此结束了~