前言

我們專案中有很多需要配置的地方，最常見的就是各種服務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,交流微服務。

傳送門

參考資料

java部分

.net部分