
配置多環(huán)境是日常開發(fā)經(jīng)常需要用到的操作,實(shí)現(xiàn)多環(huán)境配置后可以規(guī)避生產(chǎn)測(cè)試環(huán)境混合帶來(lái)的麻煩和風(fēng)險(xiǎn),減少項(xiàng)目風(fēng)險(xiǎn),并且也可以通過(guò)多環(huán)境來(lái)保證生產(chǎn)環(huán)境上密鑰的安全。
我之前在做iOS開發(fā)時(shí),iOS的解決方法是通過(guò)多個(gè)配置不同的環(huán)境變量,并且配合宏來(lái)實(shí)現(xiàn)不同的環(huán)境啟動(dòng)時(shí),讀取不同的配置,在.NET Core中當(dāng)然也會(huì)有類似的這種方式,并且它比iOS中更簡(jiǎn)單,只需要注入不同的環(huán)境變量即可,而iOS還需要建立多個(gè)Target才能實(shí)現(xiàn)注入不同的環(huán)境變量,.NET Core則可以直接在啟動(dòng)時(shí)注入不同的環(huán)境變量,根本無(wú)需再做其它操作。
方式一:預(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即可以滿足這種需求,而且這種操作方式非常簡(jiǎn)單,只需要準(zhǔn)備兩個(gè)不同的配置文件來(lái)給兩個(gè)不同環(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)兩個(gè)以上的環(huán)境的話,那么就只能使用第二種方式了。
方式二:注入不同環(huán)境變量
首先準(zhǔn)備好你不同環(huán)境的配置文件,例如:

然后選擇啟動(dòng)項(xiàng)目Properties下的launchSettings.json文件,添加如下配置:
{
"profiles": {
"240": {
"commandName": "IISExpress",
"launchBrowser": true,
"launchUrl": "",
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Dev240"
}
},
"241": {
"commandName": "IISExpress",
"launchBrowser": true,
"launchUrl": "",
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Dev241"
}
},"243": {
"commandName": "IISExpress",
"launchBrowser": true,
"launchUrl": "",
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Dev243"
}
},"Staging": {
"commandName": "IISExpress",
"launchBrowser": true,
"launchUrl": "",
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Staging"
}
}
}
}
此時(shí),啟動(dòng)選擇已然變成這樣:

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

當(dāng)然環(huán)境變量配置好了之后,我們就需要來(lái)使用環(huán)境變量,新建一個(gè)配置的工具類文件:
/// <summary>
/// 全局配置管理類(適配多環(huán)境)
/// </summary>
public static class MyConfigurationHelper
{
public static IConfiguration Config { get; set; }
static MyConfigurationHelper()
{
var env = MyServiceProvider.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; }
}
這個(gè)文件中提供了一個(gè)讀取配置IConfiguration的MyConfigurationHelper類和一個(gè)提供IServiceProvider容器的MyServiceProvider類IServiceProvider是.NET Core中的服務(wù)容器,他能夠訪問(wèn)到程序注入的環(huán)境變量,然后進(jìn)入Startup.cs中引用這個(gè)文件,并且在Configure方法中,將IApplicationBuilder的ApplicationServices傳遞進(jìn)去。
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
//配置多環(huán)境
MyServiceProvider.ServiceProvider = app.ApplicationServices;
}
這時(shí),我們回過(guò)去看MyConfigurationHelper類,它將會(huì)在下一次被使用時(shí),從IServiceProvider中讀取我們選擇的啟動(dòng)環(huán)境對(duì)應(yīng)的環(huán)境變量字符串Dev240、Dev241、Dev243、Staging;從而實(shí)現(xiàn)讀取不同的配置文件與IConfiguration``Config中,我們后繼使用讀取配置文件的操作時(shí),都將使用MyConfigurationHelper.Config來(lái)進(jìn)行讀取。
發(fā)布時(shí)區(qū)分多環(huán)境
在Liunx上面,我們使用supervisor來(lái)守護(hù)我們的.NET Core應(yīng)用程序,所以我們想要運(yùn)行哪個(gè)環(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ā)布時(shí)只需要編譯Release就能自動(dòng)讀取對(duì)應(yīng)環(huán)境的配置文件,無(wú)需上面的操作。
如果有問(wèn)題或者很喜歡,歡迎在下面留言評(píng)論。