通過之前文章的學習我們已經學會了使用Nacos完成服務的注冊與發(fā)現(xiàn)。同時也介紹了Spring Cloud中不同風格的服務消費方式。接下來,我們再來學習下Nacos的另一個重要功能:配置管理
簡介
Nacos除了可以實現(xiàn)服務的注冊與發(fā)現(xiàn)之外,還將配置中心的功能整合在一起。通過Nacos的配置管理功能,我們可以將整個架構體系能的所有配置都集中到Nacos中存儲。這樣做的好處主要有以下幾點:
- 分離的多環(huán)境配置,可以靈活的管理權限,安全性更高
- 應用程序的打包更為純粹,已實現(xiàn)一次打包,多處運行的特點
Nacos的配置管理模型與淘寶開源的配置中心Diamond類似,基礎層面通過DataId
和 Group
來定位配置內容,除此之外還增加了很多其他的管理功能。
快速入門
下面我們通過一個簡單的例子來介紹如何使用Nacos來創(chuàng)建配置內容以及如何在Spring Cloud應用中加載Nacos的配置信息。
創(chuàng)建配置
第一步: 進入Nacos的控制頁面,在配置列表功能頁面中,單擊右上角的+按鈕,進入新建配置頁面,如圖填寫配置信息:
其中:
-
Data ID: 填入
alibaba-nacos-config-client.properties
-
Group: 使用默認值
DEFAULT_GROUP
- 描述:可不填
-
配置格式: 選擇
Properties
- 配置內容: 應用要加載的配置內容,這里僅作為實例,做簡單的配置,比如: username=wolf
創(chuàng)建應用
第一步:創(chuàng)建一個Spring Boot應用,命名為:alibaba-nacos-config-client
第二步:編輯pom.xml, 加入必要的依賴配置:
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.5.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>Finchley.SR1</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-alibaba-dependencies</artifactId>
<version>0.2.2.RELEASE</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.2</version>
<optional>true</optional>
</dependency>
</dependencies>
上述內容主要三部分:
- parent:定義spring boot的版本
- dependencyManagement:spring cloud的版本以及spring cloud alibaba的版本
-
dependencies:當前應用要使用的依賴內容。這里主要加入Nacos的配置客戶端依賴包:
spring-cloud-stater-alibaba-nacos-config
。由于dependencyManagement
已經指定過版本號,這里不需要指定具體版本號。
注意:這個例子中并沒有引入nacos的服務注冊與發(fā)現(xiàn)依賴,因為這兩個功能內容是完全可以獨立使用的。
第三步: 創(chuàng)建應用主類和測試Controller接口
@SpringBootApplication
public class NacosConfigClientApplication {
public static void main(String[] args) {
SpringApplication.run(NacosConfigClientApplication.class, args);
}
}
@Slf4j
@RestController
@RefreshScope
public class TestController {
@Value("${username}")
private String username;
@GetMapping("/test")
public String hello() {
return username;
}
}
內容非常簡單,唯一可能默認的注解 :@RefreshScope
這個注解是spring cloud提供的一種特殊的scope實現(xiàn),用來實現(xiàn)配置、實例熱加載。
在類上添加該注解,用來讓這個類的配置內容支持動態(tài)刷新,也就是當我們啟動應用之后,修改Nacos的配置文件內容,這里就會馬上生效。
第四步: 創(chuàng)建配置文件bootstrap.properties
,并配置服務名稱和Nacos地址
server.port=9004
spring.application.name=alibaba-nacos-config-client
spring.cloud.nacos.config.server-addr=127.0.0.1:8848
注意:
- 這里的配置必須使用
bootstrap.properties 或 bootstrap.yml
,不能寫在application.properties / application.yml
不然啟動會報錯。 - 同時,
spring.application.name
值必須和Nacos配置中Data ID
(除了.yml或者.properties)
為什么必須寫在bootstrap.properties 或 bootstrap.yml中?
SpringCloudConfig
和 NacosConfig
這種統(tǒng)一配置服務在springboot項目中初始化時,都是加載bootstrap.properties 或 bootstrap.yml
配置文件去初始化上下文。
這是由spring boot的加載屬性文件的優(yōu)先級決定的,想要在加載屬性之前去config server
上取配置文件,那NacosConfig或SpringCloudConfig相關配置就是需要最先加載的,而bootstrap.properties
的加載是先于application.properties
的,所以config client要配置config的相關配置就只能寫到bootstrap.properties里了
第五步: 啟動應用
2019-07-10 15:57:19.003 INFO 5240 --- [ main] o.s.c.a.n.c.NacosPropertySourceBuilder : Loading nacos data, dataId: 'alibaba-nacos-config-client.properties', group: 'DEFAULT_GROUP'
2019-07-10 15:57:19.004 INFO 5240 --- [ main] b.c.PropertySourceBootstrapConfiguration : Located property source: CompositePropertySource {name='NACOS', propertySources=[NacosPropertySource {name='alibaba-nacos-config-client.properties'}]}
在啟動的時候,可以看到類似上面的日志信息,這里輸出應用程序要從Nacos中獲取配置的 dataid
和 group
。如果啟動之后,發(fā)現(xiàn)配置信息沒有獲取到的時候,可以檢測下這塊配置是否正確。
第六步:驗證配置獲取和動態(tài)刷新
使用postman工具,訪問接口:http://localhost:9004/test, 將返回Nacos配置中的 username 值。然后,再通過Nacos頁面,修改 username=admin
,單擊發(fā)布,再訪問這個接口看結果是否實時更新。
修改前:
修改中:
發(fā)布完畢后,不要啟動應用,重新訪問接口,會發(fā)現(xiàn)結果實時更新。
同時會發(fā)現(xiàn)我們在修改Nacos配置信息,發(fā)布后,客戶端控制臺會發(fā)現(xiàn)如下日志:
2019-07-10 16:11:09.369 INFO 5240 --- [-127.0.0.1_8848] s.c.a.AnnotationConfigApplicationContext : Refreshing org.springframework.context.annotation.AnnotationConfigApplicationContext@7f1bcf03: startup date [Wed Jul 10 16:11:09 CST 2019]; root of context hierarchy
2019-07-10 16:11:09.406 INFO 5240 --- [-127.0.0.1_8848] trationDelegate$BeanPostProcessorChecker : Bean 'configurationPropertiesRebinderAutoConfiguration' of type [org.springframework.cloud.autoconfigure.ConfigurationPropertiesRebinderAutoConfiguration$$EnhancerBySpringCGLIB$$1bdb25d3] is not eligible for getting processed by all BeanPostProcessors (for example: not eligible for auto-proxying)
2019-07-10 16:11:09.506 INFO 5240 --- [-127.0.0.1_8848] o.s.c.a.n.c.NacosPropertySourceBuilder : Loading nacos data, dataId: 'alibaba-nacos-config-client.properties', group: 'DEFAULT_GROUP'
2019-07-10 16:11:09.506 INFO 5240 --- [-127.0.0.1_8848] b.c.PropertySourceBootstrapConfiguration : Located property source: CompositePropertySource {name='NACOS', propertySources=[NacosPropertySource {name='alibaba-nacos-config-client.properties'}]}
2019-07-10 16:11:09.507 INFO 5240 --- [-127.0.0.1_8848] o.s.boot.SpringApplication : No active profile set, falling back to default profiles: default
2019-07-10 16:11:09.508 INFO 5240 --- [-127.0.0.1_8848] s.c.a.AnnotationConfigApplicationContext : Refreshing org.springframework.context.annotation.AnnotationConfigApplicationContext@5d68f73a: startup date [Wed Jul 10 16:11:09 CST 2019]; parent: org.springframework.context.annotation.AnnotationConfigApplicationContext@7f1bcf03
2019-07-10 16:11:09.525 INFO 5240 --- [-127.0.0.1_8848] o.s.boot.SpringApplication : Started application in 0.234 seconds (JVM running for 831.73)
2019-07-10 16:11:09.525 INFO 5240 --- [-127.0.0.1_8848] s.c.a.AnnotationConfigApplicationContext : Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@5d68f73a: startup date [Wed Jul 10 16:11:09 CST 2019]; parent: org.springframework.context.annotation.AnnotationConfigApplicationContext@7f1bcf03
2019-07-10 16:11:09.525 INFO 5240 --- [-127.0.0.1_8848] s.c.a.AnnotationConfigApplicationContext : Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@7f1bcf03: startup date [Wed Jul 10 16:11:09 CST 2019]; root of context hierarchy
2019-07-10 16:11:09.528 INFO 5240 --- [-127.0.0.1_8848] o.s.c.e.event.RefreshEventListener : Refresh keys changed: [username]
上面,我們已經學會了如何在Nacos中創(chuàng)建配置,以及如何使用Spring Cloud Alibaba的Nacos客戶端模塊來加載配置。我們的例子完成采用了默認配置完成。接下來我們詳細了解下Nacos配置的加載規(guī)則。
加載規(guī)則
在Nacos Spring Cloud 中, dataID的完成格式如下:
${prefix}-${spring.profile.active}.${file-extension}
-
prefix:默認為
spring.application.name
的值,也可以通過配置項spring.cloud.nacos.config.prefix
來配置。 - spring.profile.active:即當前環(huán)境對應的profile,詳情開業(yè)參考 Spring Boot文檔。
注意:
當 spring.profile.active 為空時,對應的連接符 - 也將不存在,dataId的拼接格式變成:${prefix}.${file-extension}
file-extension: 為配置文件的數(shù)據格式,可以通過設置項
spring.cloud.nacos.config.file-extension
來配置,默認值:properties。目前只支持 properties 和 yaml 類型。Group的值默認
DEFAULT_GROUP
: 可以通過設置項spring.cloud.nacos.config.group
來配置,默認值: DEFAULT_GROUP
思考
上面,我們具體介紹了在Nacos中添加各種配置與SpringCloud應用中客戶端配置的對應關系。對于spring.cloud.nacos.config.prefix
和spring.cloud.nacos.config.file-extension
來說,基本沒有太多的花樣,大部分都是采用默認配置。
但是對于 spring.cloud.nacos.config.group
的配置來說,還是可以派生出一些作用,比如:用來區(qū)分不同的產品組下的各個應用的配置內容(解決多個應用名稱沖突問題)或者用來區(qū)分不同用途的配置內容,再或者用來區(qū)分不同環(huán)境(dev、test、prod)的配置。
后面我們也會專門針對如何使用Group完成多環(huán)境配置進行專門講解。