Nacos 多環境配置
本文探討Nacos作為配置中心,如何實現不同環境(開發、測試、灰度、正式)的配置管理問題
就像Maven用groupId、artifactId、version三者來定位jar包在倉庫中的位置一樣,Nacos也提供了 Namespace (命名空間) 、Data ID (配置集ID)、 Group (組) 來確定一個配置文件(或者叫配置集)
由此,實現多環境配置的方案也有三種:
1、用命名空間(namespace)來區分不同的環境,一個命名空間對應一個環境;
2、用配置組(group)來區分不同的環境,命名空間用默認的public即可,一個組對應一種環境;
3、用配置集ID(Data ID)名稱來區分不同的環境,命名空間和組用默認的即可,通過文件命名來區分;
接下來,逐個來看
//{host}:{port}/nacos
//{host}:{port}/nacos/index.html
默認用戶名密碼都是nacos
為了方便演示,這裡建了一個名為example的Spring Boot項目
pom.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <project xmlns="//maven.apache.org/POM/4.0.0" xmlns:xsi="//www.w3.org/2001/XMLSchema-instance"
3 xsi:schemaLocation="//maven.apache.org/POM/4.0.0 //maven.apache.org/xsd/maven-4.0.0.xsd">
4 <modelVersion>4.0.0</modelVersion>
5 <parent>
6 <groupId>org.springframework.boot</groupId>
7 <artifactId>spring-boot-starter-parent</artifactId>
8 <version>2.3.6.RELEASE</version>
9 <relativePath/> <!-- lookup parent from repository -->
10 </parent>
11 <groupId>com.example</groupId>
12 <artifactId>example</artifactId>
13 <version>0.0.1-SNAPSHOT</version>
14 <name>example</name>
15
16 <properties>
17 <java.version>1.8</java.version>
18 <spring-cloud-alibaba.version>2.2.3.RELEASE</spring-cloud-alibaba.version>
19 </properties>
20
21 <dependencies>
22 <dependency>
23 <groupId>org.springframework.boot</groupId>
24 <artifactId>spring-boot-starter-web</artifactId>
25 </dependency>
26 <dependency>
27 <groupId>com.alibaba.cloud</groupId>
28 <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
29 </dependency>
30 </dependencies>
31
32 <dependencyManagement>
33 <dependencies>
34 <dependency>
35 <groupId>com.alibaba.cloud</groupId>
36 <artifactId>spring-cloud-alibaba-dependencies</artifactId>
37 <version>${spring-cloud-alibaba.version}</version>
38 <type>pom</type>
39 <scope>import</scope>
40 </dependency>
41 </dependencies>
42 </dependencyManagement>
43
44 <build>
45 <plugins>
46 <plugin>
47 <groupId>org.springframework.boot</groupId>
48 <artifactId>spring-boot-maven-plugin</artifactId>
49 </plugin>
50 </plugins>
51 </build>
52
53 </project>
bootstrap.yml
spring:
application:
name: example
cloud:
nacos:
config:
server-addr: 192.168.100.10:8848
file-extension: yaml
HelloController.java
package com.example.controller;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* @author ChengJianSheng
* @data 2020/11/19
*/
@RestController
@RequestMapping("/hello")
@RefreshScope
public class HelloController {
@Value("${greet.hello}")
private String greet;
@GetMapping("/sayHi")
public String sayHi() {
return greet;
}
}
1. 利用 Data ID 命名 來區分環境
利用Data ID命名來區分環境,命名空間和組默認即可
在 Nacos Spring Cloud 中,dataId 的完整格式如下:
${prefix}-${spring.profiles.active}.${file-extension}
- prefix 默認為 spring.application.name 的值,也可以通過配置項 spring.cloud.nacos.config.prefix來配置
- spring.profiles.active 即為當前環境對應的 profile,詳情可以參考 Spring Boot文檔。 注意:當 spring.profiles.active 為空時,對應的連接符 – 也將不存在,dataId 的拼接格式變成 ${prefix}.${file-extension}
- file-exetension 為配置內容的數據格式,可以通過配置項 spring.cloud.nacos.config.file-extension 來配置。目前只支持 properties 和 yaml 類型。
用命令行啟動也是一樣的
例如:
java -Dspring.profiles.active=test -jar example-0.0.1-SNAPSHOT.jar
2. 利用 Group 來區分環境
項目不變,我們把spring.application.name改成example2
命名空間用默認的publish
java -Dspring.cloud.nacos.config.group=DEV_GROUP -jar example-0.0.1-SNAPSHOT.jar
java -Dspring.cloud.nacos.config.group=TEST_GROUP -jar example-0.0.1-SNAPSHOT.jar
java -Dspring.profiles.active=test -Dspring.cloud.nacos.config.group=DEV_GROUP -jar example-0.0.1-SNAPSHOT.jar
如果是這樣的話,這個時候,Data ID 命名就應該是 example2-test.yaml
3. 利用 Namespace 區分環境
創建命名空間的時候,如果不指定ID,則自動生成的id就是這樣的uuid字符串,我們還是自己指定一個有意義的ID吧
java -Dspring.cloud.nacos.config.namespace=ns_dev -jar example-0.0.1-SNAPSHOT.jar
java -Dspring.profiles.active=dev -Dspring.cloud.nacos.config.namespace=ns_dev -jar example-0.0.1-SNAPSHOT.jar
java -Dspring.cloud.nacos.config.namespace=ns_test -jar example-0.0.1-SNAPSHOT.jar
java -Dspring.profiles.active=test \
-Dspring.cloud.nacos.config.namespace=ns_test \
-Dspring.cloud.nacos.config.group=TEST_GROUP \
-jar example-0.0.1-SNAPSHOT.jar
4. 小結
第一種,用 Data ID 區分環境,雖然簡單,但是每個項目要創建4個配置文件,隨着項目的增多,都在一個命名空間下回顯得很混亂,查找起來也不是很方便,而且不利於做權限控制
第二種,用Group區分,問題也是一樣的
綜上,最好的是用Namespace區分環境,清晰明了,而且有利於做權限控制
//nacos.io/zh-cn/docs/concepts.html