.NET Core配置多環(huán)境的方法步驟

更新時間：2019年03月27日 09:59:55 作者：MethodName Blog

配置多環(huán)境是日常開發(fā)經(jīng)常需要用到的操作，實(shí)現(xiàn)多環(huán)境配置后可以規(guī)避生產(chǎn)測試環(huán)境混合帶來的麻煩和風(fēng)險，這篇文章主要介紹了.NET Core配置多環(huán)境的方法步驟，感興趣的小伙伴們可以參考一下

配置多環(huán)境是日常開發(fā)經(jīng)常需要用到的操作，實(shí)現(xiàn)多環(huán)境配置后可以規(guī)避生產(chǎn)測試環(huán)境混合帶來的麻煩和風(fēng)險，減少項(xiàng)目風(fēng)險，并且也可以通過多環(huán)境來保證生產(chǎn)環(huán)境上密鑰的安全。

我之前在做iOS開發(fā)時，iOS的解決方法是通過多個Target配置不同的環(huán)境變量，并且配合宏來實(shí)現(xiàn)不同的環(huán)境啟動時，讀取不同的配置，在.NET Core中當(dāng)然也會有類似的這種方式，并且它比iOS中更簡單，只需要注入不同的環(huán)境變量即可，而iOS還需要建立多個Target才能實(shí)現(xiàn)注入不同的環(huán)境變量，.NET Core則可以直接在啟動時注入不同的環(huán)境變量，根本無需再做其它操作。

方式一：預(yù)編譯指令DEBUG

#if DEBUG
      //讀取環(huán)境1配置文件
#else
      //讀取環(huán)境2配置文件
#endif

如果你只有兩套環(huán)境，這種方式也勉強(qiáng)夠用，在日常開發(fā)中，我們基本上都是DeBug模式運(yùn)行的，在生產(chǎn)環(huán)境發(fā)布的代碼，也基本上都是編譯的Release代碼，所以使用預(yù)編譯指令 #if DEBUG 即可以滿足這種需求，而且這種操作方式非常簡單，只需要準(zhǔn)備兩個不同的配置文件來給兩個不同環(huán)境讀取即可。

/// <summary>
  /// 全局配置管理類（按照DEBUG/RELEASE區(qū)分環(huán)境）
  /// </summary>
  public static class MyConfiguration
  {
    public static IConfiguration Configuration { get; set; }
    static MyConfiguration()
    {
    #if DEBUG
      var envPath = "appsettings.Development.json";
    #else
      var envPath = "appsettings.json";
    #endif
      Configuration = new ConfigurationBuilder()
        .Add(new JsonConfigurationSource
        {
          Path = envPath,
          ReloadOnChange = true
        }).Build();
    }
  }

但是如果你想調(diào)試生產(chǎn)環(huán)境或者想實(shí)現(xiàn)兩個以上的環(huán)境的話，那么就只能使用第二種方式了。

方式二：注入不同環(huán)境變量

首先準(zhǔn)備好你不同環(huán)境的配置文件，例如：

然后選擇啟動項(xiàng)目Properties下的launchSettings.json文件，添加如下配置：

{
 "profiles": {
  "240": {
   "commandName": "240",
   "launchBrowser": true,
   "launchUrl": "",
   "environmentVariables": {
    "ASPNETCORE_ENVIRONMENT": "Dev240"
   }
  },
  "241": {
   "commandName": "241",
   "launchBrowser": true,
   "launchUrl": "",
   "environmentVariables": {
    "ASPNETCORE_ENVIRONMENT": "Dev241"
   }
  },"243": {
   "commandName": "243",
   "launchBrowser": true,
   "launchUrl": "",
   "environmentVariables": {
    "ASPNETCORE_ENVIRONMENT": "Dev243"
   }
  },"Staging": {
   "commandName": "Staging",
   "launchBrowser": true,
   "launchUrl": "",
   "environmentVariables": {
    "ASPNETCORE_ENVIRONMENT": "Staging"
   }
  }
 }
}

此時，啟動選擇已然變成這樣：

當(dāng)然，我們也可以直接在啟動項(xiàng)目的Properties里面改，如下圖：

當(dāng)然環(huán)境變量配置好了之后，我們就需要來使用環(huán)境變量，新建一個配置的工具類文件：

/// <summary>
  /// 全局配置管理類（適配多環(huán)境）
  /// </summary>
  public static class MyConfigurationHelper
  {
    public static IConfiguration Config { get; set; }
    static MyConfigurationHelper()
    {
      var env = BfServiceProvider.ServiceProvider.GetRequiredService<IHostingEnvironment>();
      Config = new ConfigurationBuilder()
        .SetBasePath(env.ContentRootPath)
        .AddJsonFile($"appsettings.{env.EnvironmentName}.json", true, true)
        .Build();
    }
    
  }

  public static class MyServiceProvider
  {
    public static IServiceProvider ServiceProvider { get; set; }
  }

這個文件中提供了一個讀取配置 IConfiguration 的 MyConfigurationHelper 類和一個提供 IServiceProvider 容器的 MyServiceProvider 類 IServiceProvider 是.NET Core中的服務(wù)容器，他能夠訪問到程序注入的環(huán)境變量，然后進(jìn)入 Startup.cs 中引用這個文件，并且在 Configure 方法中，將 IApplicationBuilder 的 ApplicationServices 傳遞進(jìn)去。

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
  {
    //配置多環(huán)境
    MyServiceProvider.ServiceProvider = app.ApplicationServices;
  }

這時，我們回過去看 MyConfigurationHelper 類，它將會在下一次被使用時，從 IServiceProvider 中讀取我們選擇的啟動環(huán)境對應(yīng)的環(huán)境變量字符串Dev240、Dev241、Dev243、Staging；從而實(shí)現(xiàn)讀取不同的配置文件與 IConfiguration Config 中，我們后繼使用讀取配置文件的操作時，都將使用 MyConfigurationHelper.Config 來進(jìn)行讀取。

發(fā)布時區(qū)分多環(huán)境

在Liunx上面，我們使用supervisor來守護(hù)我們的.NET Core應(yīng)用程序，所以我們想要運(yùn)行哪個環(huán)境，就可以在supervisor的項(xiàng)目配置中進(jìn)行配置，修改 /etc/supervisord.d/ 下的配置文件鍵入環(huán)境變量如下：

# /etc/supervisord.d/DotNetCoreTest.ini
[program:DotNetCoreTest]
directory=/xxx/DotNetCoreTest
command=dotnet DotNetCoreTest.dll
autostart=true
autorestart=true
user=root
numprocs=1
redirect_stderr=true
stdout_logfile=/xxx/logs/DotNetCoreTest.log
# 環(huán)境變量
environment=ASPNETCORE_ENVIRONMENT=Dev240

方式一在發(fā)布時只需要編譯Release就能自動讀取對應(yīng)環(huán)境的配置文件，無需上面的操作。

以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: