在開發Spring Cloud應用時,您可以使用Nacos在本地實現應用的配置管理。由于Nacos是應用配置管理ACM的開源版本,在將應用部署到EDAS后,即可通過EDAS集成的ACM對應用進行配置的管理和推送。
您可以按照文檔從零開發該應用示例,并使用Spring Cloud Alibaba Nacos Config實現配置管理。也可以直接下載該應用示例的Demo:nacos-config-example。
Spring Cloud Alibaba Nacos Config完成了Nacos與Spring Cloud框架的整合,支持Spring Cloud的配置注入規范。
EDAS提供的配置管理與開源產品(Nacos)的配置管理功能不沖突。
準備工作
在開始開發前,請確保您已經完成以下工作:
下載Maven并設置環境變量。
下載最新版本的Nacos Server。
啟動Nacos Server。
解壓下載的Nacos Server壓縮包。
進入nacos/bin目錄,啟動Nacos Server。
Linux/Unix/Mac系統:執行命令
sh startup.sh -m standalone
。Windows系統:雙擊執行startup.cmd文件。
說明standalone
表示單機模式運行,非集群模式。startup.cmd文件默認以集群模式啟動,因此您在使用Windows系統時,如果直接雙擊執行startup.cmd文件會導致啟動失敗,此時需要在startup.cmd文件內設置MODE="standalone"
。 更多信息,請參見Nacos快速開始。
在本地Nacos Server控制臺新建配置。
登錄本地Nacos Server控制臺(用戶名和密碼默認同為nacos)。
在左側導航欄中單擊配置列表,在配置列表頁面右上角單擊新建配置圖標。
在新建配置頁面填入以下信息,單擊發布。
Data ID:nacos-config-example.properties
Group:DEFAULT_GROUP
配置格式:Properties
配置內容:test.name=nacos-config-test
使用Nacos Config實現配置管理
創建一個Maven工程,命名為nacos-config-example。
在pom.xml文件中添加依賴。
以Spring Boot 2.1.4.RELEASE和Spring Cloud Greenwich.SR1為例。
<parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.4.RELEASE</version> <relativePath/> </parent> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId> <version>2.1.1.RELEASE</version> </dependency> </dependencies> <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>Greenwich.SR1</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build>
示例中使用的版本為Spring Cloud Greenwich ,對應Spring Cloud Alibaba版本為2.1.1.RELEASE。
如果使用Spring Cloud Finchley版本,對應Spring Cloud Alibaba版本為2.0.1.RELEASE。
如果使用Spring Cloud Edgware版本,對應Spring Cloud Alibaba版本為1.5.1.RELEASE。
說明Spring Cloud Edgware版本的生命周期已結束,不推薦使用這個版本開發應用。
在src\main\java下,創建Package
com.aliware.edas
。在Package
com.aliware.edas
中創建nacos-config-example
的啟動類NacosConfigExampleApplication
。import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class NacosConfigExampleApplication { public static void main(String[] args) { SpringApplication.run(NacosConfigExampleApplication.class, args); } }
在Package
com.aliware.edas
中創建一個簡單的ControllerEchoController
,自動注入一個屬性userName
,且通過@Value
注解指定從配置中取Key為test.name的值。import org.springframework.beans.factory.annotation.Value; import org.springframework.cloud.context.config.annotation.RefreshScope; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController @RefreshScope public class EchoController { @Value("${test.name}") private String userName; @RequestMapping(value = "/") public String echo() { return userName; } }
在
src\main\resources
路徑下創建配置文件bootstrap.properties
,在bootstrap.properties
中添加如下配置,指定Nacos Server的地址。其中
127.0.0.1:8848
為Nacos Server的地址,18081
為服務端口。如果您的Nacos Server部署在另外一臺機器,則需要修改成對應的IP和端口。如果有其它需求,可以在bootstrap.properties文件中增加配置。具體操作,請參考配置項參考
spring.application.name=nacos-config-example server.port=18081 spring.cloud.nacos.config.server-addr=127.0.0.1:8848
執行
NacosConfigExampleApplication
中的main函數,啟動應用。
本地結果驗證
在瀏覽器上訪問http://127.0.0.1:18081 ,可以看到返回值為nacos-config-test
,該值即為在本地Nacos Server中新建配置中的配置內容,即test.name的值。
將應用部署到EDAS
將應用部署到EDAS前,需要先在EDAS的配置管理中創建和本地Nacos Server一致的配置,以便應用部署后可以同步配置,然后再將應用部署到EDAS。
在EDAS中創建和本地Nacos Server相同的配置。
登錄EDAS控制臺。
在左側導航欄,選擇 。
在配置列表頁面頂部菜單欄選擇地域,在頁面上方選擇微服務空間,然后單擊創建配置。
在創建配置面板,設置和本地Nacos Server相同的參數配置,然后單擊創建。
Data ID:nacos-config-example.properties
Group:DEFAULT_GROUP
配置格式:Properties
配置內容:test.name=nacos-config-test
說明所屬地域和微服務空間在配置列表中選擇,該面板中不可設置。
后續操作
您的應用在部署到EDAS后,還需要持續迭代、升級。如果每次都要在本地啟動Nacos Server、升級應用、本地驗證再部署到EDAS進行線上驗證,會影響開發效率。所以,EDAS提供了端云互聯功能,開啟端云互聯的應用在本地啟動后,和部署到EDAS的效果一致,可以直接讀取EDAS配置管理中的配置并和云端的其他應用相互調用。關于端云互聯的更多信息,請參見端云互聯簡介。
配置項參考
如果有其他需求,可以參照下表在bootstrap.properties文件中增加配置。
配置項 | key | 默認值 | 說明 |
服務端地址 | spring.cloud.nacos.config.server-addr | 無 | 無。 |
DataId前綴 | spring.cloud.nacos.config.prefix | ${spring.application.name} | Data ID的前綴。 |
Group | spring.cloud.nacos.config.group | DEFAULT_GROUP | 分組。 |
Data ID后綴及內容文件格式 | spring.cloud.nacos.config.file-extension | properties | Data ID的后綴,同時也是配置內容的文件格式,默認是properties,也支持YAML和YML格式。 |
配置內容的編碼方式 | spring.cloud.nacos.config.encode | UTF-8 | 配置的編碼。 |
獲取配置的超時時間 | spring.cloud.nacos.config.timeout | 3000 | 單位為ms。 |
配置的命名空間 | spring.cloud.nacos.config.namespace | 常用場景之一是不同環境的配置的區分隔離,例如開發測試環境和生產環境的資源隔離等。 | |
相對路徑 | spring.cloud.nacos.config.context-path | 服務端API的相對路徑。 | |
接入點 | spring.cloud.nacos.config.endpoint | UTF-8 | 地域的某個服務的入口域名,通過此域名可以動態地獲取服務端地址。 |
是否開啟監聽和自動刷新 | spring.cloud.nacos.config.refresh.enabled | true | 默認為true,不需要修改。 |
更多配置項,請參考開源版本的Spring Cloud Alibaba Nacos Config文檔。