上一篇文章講解了Spring Cloud
整合 nacos
實現服務註冊與發現,nacos
除了有服務註冊與發現的功能,還有提供動態設定服務的功能。本文主要講解Spring Cloud
整合nacos
實現動態設定服務。主要參考官方部署手冊點我。
先下載nacos
並啟動nacos
服務。操作步驟詳見Nacos 快速入門。
<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>
版本
nacos
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 版本。版本不匹配的話,會出現很多莫名其妙的問題。nacos
依賴版本要和nacos
伺服器端版本要一致。
在nacos
控制檯新增設定列表:
設定dataId
為nacos-config
,檔案字尾為Properties
,設定內容user.name=jack
:
在application.yml
同目錄下建立bootstrap.yml
檔案,並設定Nacos
服務地址以及namespace
(沒有就不需要設定):
spring:
application:
name: nacos-config-client
cloud:
nacos:
config:
server-addr: 127.0.0.1:8848
namespace: 68468122-8955-45ee-a5b7-3d87972325b1
dataId
對應步驟2
裡面的dataId
,有兩種設定方式,一種是官方自動構建dataId
,另一種是指定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.properties
設定。
在NacosConfigProperties
類裡面name
欄位就是設定dataId
:
public class NacosConfigProperties {
/**
* nacos config dataId name.
*/
private String name;
//省略其他設定
}
在bootstrap.yml
新增spring.cloud.nacos.config.name
就可以設定dataId
。
通過@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
註解。