前言
我們項目中有很多需要配置的地方,最常見的就是各種服務URL地址,這些地址針對不同的運行環境還不一樣,不管和打包還是部署都麻煩,需要非常的小心。一般配置都是存儲到配置文件里面,不管多小的配置變動,都需要對應用程序進行重啟,對於分布式系統來說,這是非常不可取的。所以配置中心就在這種場景孕育出來,能夠適配不同的環境,正在運行的程序不用重啟直接生效。
介紹
現在開始介紹我們今天的主角spring cloud config,我覺得它最大的優點就是可以和git做集成,使用起來非常方便。spring cloud config包含服務端和客戶端,服務端提供配置的讀取和配置倉庫,客戶端來獲取配置。
也可以使用svn或者文件來存儲配置文件,我們這里只講Git的方式
業務場景
我們模擬一個業務場景,有一個遠程配置文件我們通過應用程序獲取它。
代碼實現
我們需要創建2個應用程序:配置服務服務端(Java),配置服務客戶端(.Net Core)和一個Github倉庫。
使用IntelliJ IDEA創建一個spring boot項目,創建配置中心服務端,端口設置為5100
pom.xml
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
</dependency>
ConfigServerApplication.java
@SpringBootApplication
@EnableConfigServer
public class ConfigServerApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigServerApplication.class, args);
}
}
application.properties
server.port=5100
spring.application.name=config-server
#git倉庫地址
spring.cloud.config.server.git.uri=https://github.com/longxianghui/configs.git
#git用戶名和密碼
#spring.cloud.config.server.git.username=xxx
#spring.cloud.config.server.git.password=xxx
#git目錄下的文件夾,多個用逗號分割
#spring.cloud.config.server.git.search-paths=xxx,xxx,xxx
使用Github創建一個倉庫,並提交3個文件,文件內容如下(注意yml格式)
demo-dev.yml
name: mickey
age: 3
env: test
demo-test.yml
name: fiona
age: 28
env: test
demo-prod.yml
name: leo
age: 30
env: prod
配置文件命名規則{application}-{profile}.yml
支持yml和properties格式
運行配置中心服務端
在瀏覽器輸入http://localhost:5001/demo/dev
再訪問http://localhost:5001/demo/test
再訪問http://localhost:5001/demo/prod
通過上面3個URL我們發現配置中心通過REST的方式將配置信息返回。
配置服務REST規則如下:
/{application}/{profile}[/{label}]
/{application}-{profile}.yml
/{label}/{application}-{profile}.yml
/{application}-{profile}.properties
/{label}/{application}-{profile}.properties
下面我們再看看.NET程序如何讀取配置信息呢?
創建一個 .net core web api程序,端口5101
nuget引用
<PackageReference Include="Steeltoe.Extensions.Configuration.ConfigServer" Version="1.1.0" />
appsettings.json
{
"spring": {
"application": {
"name": "demo"//與配置文件的名稱對應
},
"cloud": {
"config": {
"uri": "http://localhost:5100",
"env": "dev" //與環境名稱對應
}
}
},
"Logging": {
"IncludeScopes": false,
"LogLevel": {
"Default": "Warning"
}
}
}
Startup.cs
public Startup(IHostingEnvironment env)
{
var builder = new ConfigurationBuilder()
.SetBasePath(env.ContentRootPath)
.AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
.AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)
.AddEnvironmentVariables()
.AddConfigServer(env);
Configuration = builder.Build();
}
public void ConfigureServices(IServiceCollection services)
{
services.AddConfigServer(Configuration);
// Add framework services.
services.AddMvc();
services.Configure<Demo>(Configuration);
}
Demo.cs
public class Demo
{
public string Name { get; set; }
public int Age { get; set; }
public string Env { get; set; }
}
ValuesController.cs
[Route("/")]
public class ValuesController : Controller
{
private readonly IConfigurationRoot _config;
private readonly IOptionsSnapshot<Demo> _configDemo;
public ValuesController(IConfigurationRoot config, IOptionsSnapshot<Demo> configDemo)
{
_config = config;
_configDemo = configDemo;
}
[HttpGet]
public Demo Get()
{
//兩種方式獲取配置文件的數據
//var demo = new Demo
//{
// Name = _config["name"],
// Age = int.Parse(_config["age"]),
// Env = _config["env"]
//};
var demo = _configDemo.Value;
return demo;
}
}
運行程序 瀏覽器訪問http://localhost:5101/,
更改配置文件appsettings.json,"env": "test"
,重新啟動程序,刷新頁面
再更改配置文件appsettings.json,"env": "prod"
,程序啟動程序,刷新頁面
這樣通過修改本地的配置文件,就能獲取遠程上的各種配置了。
我們再試試修改遠程的配置文件,修改demo-prod.yml的配置name: leo1,提交到github。
再訪問http://localhost:5011/,發現配置並沒有變化,這是因為配置服務並不知道git有更新,我們重啟配置服務,再次訪問,問題依舊,那么再重啟客戶端,發現我們得到了剛才更新的配置name= leo1,配置生效了。
后記
通過上面的例子,我們能夠通過應用程序獲取到配置信息,但是這有明顯的問題,總不能一有配置更新就去重啟配置服務和客戶端吧?如何做到自動通知到客戶端呢?留下這些問題,敬請期待下一章。
示例代碼
所有代碼均上傳github。代碼按照章節的順序上傳,例如第一章demo1,第二章demo2以此類推。
求推薦,你們的支持是我寫作最大的動力,我的QQ群:328438252,交流微服務。
傳送門
- spring cloud+dotnet core搭建微服務架構:服務注冊(一)
- spring cloud+dotnet core搭建微服務架構:服務發現(二)
- spring cloud+dotnet core搭建微服務架構: Api網關(三)
- spring cloud+dotnet core搭建微服務架構:配置中心(四)
參考資料
java部分
.net部分