前提条件
先下载nacos并启动nacos服务。操作步骤详见Nacos 快速入门。
整合步骤
1. 添加依赖
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
<version>2.2.7.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<version>2.2.12.RELEASE</version>
</dependency>
版本nacos2.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 版本。版本不匹配的话,会出现很多莫名其妙的问题。nacos依赖版本要和nacos服务端版本要一致。
2. 新建 nacos 配置
在nacos控制台添加配置列表:
设置dataId为nacos-config,文件后缀为Properties,设置内容user.name=jack
3. bootstrap.properties 配置
在application.yml同目录下创建bootstrap.yml文件,并配置Nacos服务地址以及namespace(没有就不需要配置):
spring:
cloud:
nacos:
discovery:
server-addr: nacos:8848 #根据需要改动
namespace: default
register-enabled: true
config:
server-addr: ${spring.cloud.nacos.discovery.server-addr}
namespace: ${spring.cloud.nacos.discovery.namespace}
file-extension: yml
timeout: 20000
enabled: true
max-retry: 10
- 配置dataId
dataId对应步骤2里面的dataId,有两种配置方式,一种是官方自动构建dataId ,另一种是指定dataId。
4.1 自动配置 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.profiles.active
为空时,对应的连接符 - 也将不存在,dataId 的拼接格式变成${prefix}.${file-extension}
- file-exetension 为配置内容的数据格式,可以通过配置项
spring.cloud.nacos.config.file-extension 来配置。目前只支持 properties 和 yaml类型。
比如项目名称为nacos-config-client,当前环境为test,格式文件为properties,那就需要新建一个dataId为nacos-config-client-test.properties配置。
4.2 手动设置 dataId
在NacosConfigProperties类里面name字段就是配置dataId:
public class NacosConfigProperties {
/**
* nacos config dataId name.
*/
private String name;
//省略其他配置
}
在bootstrap.yml添加spring.cloud.nacos.config.name就可以设置dataId。
5.获取数据
通过@Value就能获取配置文件的数据:
@Component
@RefreshScope
public class TestConfig {
@Value(value = "${user.name:null}")
private String test;
public String getTest(){
return test;
}
}
要实现配置的自动更新,需要添加Spring Cloud原生注解
@RefreshScope。controller直接调用即可:
@RestController
public class TestController {
@Autowired
private TestConfig testConfig;
@GetMapping("/config")
public String testConfig(){
String config = testConfig.getTest();
return config;
}
}
如果想通过@NacosValues注解获取数据,需要引入nacos-config-spring-boot-starter依赖:
<dependency>
<groupId>com.alibaba.boot</groupId>
<artifactId>nacos-config-spring-boot-starter</artifactId>
<version>0.2.7</version>
</dependency>
总结
- nacos-config配置首先添加spring-cloud-starter-alibaba-nacos-config依赖。
- 在配置列表添加配置:
bootstrap.properties添加nacos server地址和namespace - 配置dataId有两种方式
手动配置,配置spring.cloud.nacos.config.name
自动配置,根据${prefix}-${spring.profiles.active}.${file-extension}
规则配置,其中prefix为项目名称,spring.profiles.active为项目运行环境,file-extension配置内容的数据格式。 - 通过@Value(value =“${user.name:null}”)设置在字段上就能获取到属性,要实现自动更新配置需要添加@RefreshScope注解。
补充:
- nacos和本地yml文件配置的优先级
nacos 配置下,如无特殊配置,本地配置不会生效。若要本地配置生效,需要在 star-dev.yml 中作如下配置,这三个配置是矛盾的,根据需要选择。
默认本地配置不覆盖nacos配置,需要开启如下配置:
spring:
cloud:
config:
#如果本地配置优先级高,那么设置为true,默认false。
override-none: true
#如果想要远程配置优先级高,那么设置为false,默认false;
#如果想要本地配置优先级高那么设置为true。
allow-override: true
#只有系统环境变量或者系统属性才能覆盖远程配置文件的配置,本地配置文件中配置优先级低于远程配置;
#注意本地配置文件不是系统属性
#本地配置false表示覆盖远程
override-system-properties: false
---
#本地配置优先
spring:
cloud:
config:
override-none: true
allow-override: true
override-system-properties: false
---
#远程配置优先(默认配置)
spring:
cloud:
config:
override-none: false
allow-override: false
override-system-properties: true
注意:一定要配置到远程配置(nacos)上,否则不生效。
本地配置优先级:
1.命令行参数
2.来自java:comp/env的JNDI属性
3.Java系统属性(System.getProperties())
4.操作系统环境变量
5.RandomValuePropertySource配置的random.*属性值
6.jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件
7.jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件
8.–spring.config.location=C:/application.properties(它在这里)
9.jar包外部的application.properties或application.yml(不带spring.profile)配置文件
10.jar包内部的application.properties或application.yml(不带spring.profile)配置文件
11.@Configuration注解类上的@PropertySource
12.通过SpringApplication.setDefaultProperties指定的默认属性
bootstrap 优先级高于配置文件,但是项目内部配置文件高于 bootstrap,导入文件优先级
高于默认配置。
常见配置说明:
#服务名设置
spring.application.name=nacos-test
#nacos服务中心的地址
spring.cloud.nacos.server-addr=http://localhost:8848/
#nacos服务发现地址,默认取值{spring.cloud.nacos.server-addr}
#此处默认取值为${spring.application.name},自动取服务名作为nacos中的服务名
spring.cloud.nacos.discovery.service=nacos-test
#是否开启nacos服务发现功能,默认开启
spring.cloud.nacos.discovery.enabled=true
#分组设置,默认即DEFAULT_GROUP
spring.cloud.nacos.discovery.group=DEFAULT_GROUP
#命名空间设置,默认public
spring.cloud.nacos.discovery.namespace=public
#该服务向nacos服务端发送心跳的间隔,单位为毫秒,默认30秒(用以监听服务是否还存活)
spring.cloud.nacos.discovery.heart-beat-interval=1000
#该服务在停止向nacos发送心跳后,服务状态从健康到不健康的时间
spring.cloud.nacos.discovery.heart-beat-timeout=3000
#关闭注册
spring.cloud.nacos.discovery.register-enabled=false