配置多環(huán)境是日常開發(fā)經(jīng)常需要用到的操作旺韭,實現(xiàn)多環(huán)境配置后可以規(guī)避生產(chǎn)測試環(huán)境混合帶來的麻煩和風(fēng)險,減少項目風(fēng)險,并且也可以通過多環(huán)境來保證生產(chǎn)環(huán)境上密鑰的安全。
我之前在做iOS開發(fā)時市栗,iOS的解決方法是通過多個配置不同
的環(huán)境變量
,并且配合宏
來實現(xiàn)不同的環(huán)境啟動時咳短,讀取不同的配置填帽,在.NET Core中當然也會有類似的這種方式,并且它比iOS中更簡單咙好,只需要注入不同的環(huán)境變量
即可篡腌,而iOS還需要建立多個Target
才能實現(xiàn)注入不同的環(huán)境變量,.NET Core則可以直接在啟動時注入不同的環(huán)境變量勾效,根本無需再做其它操作嘹悼。
方式一:預(yù)編譯指令DEBUG
#if DEBUG
//讀取環(huán)境1配置文件
#else
//讀取環(huán)境2配置文件
#endif
如果你只有兩套環(huán)境,這種方式也勉強夠用层宫,在日常開發(fā)中杨伙,我們基本上都是DeBug
模式運行的,在生產(chǎn)環(huán)境發(fā)布的代碼卒密,也基本上都是編譯的Release
代碼缀台,所以使用預(yù)編譯指令#if DEBUG
即可以滿足這種需求,而且這種操作方式非常簡單哮奇,只需要準備兩個不同的配置文件來給兩個不同環(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)境或者想實現(xiàn)兩個以上的環(huán)境的話睛约,那么就只能使用第二種方式了。
方式二:注入不同環(huán)境變量
首先準備好你不同環(huán)境的配置文件哲身,例如:
然后選擇啟動項目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"
}
}
}
}
此時,啟動選擇已然變成這樣:
當然砚哗,我們也可以直接在啟動項目的Properties
里面改右蕊,如下圖:
當然環(huán)境變量配置好了之后,我們就需要來使用環(huán)境變量脯丝,新建一個配置的工具類文件:
/// <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; }
}
這個文件中提供了一個讀取配置IConfiguration
的MyConfigurationHelper
類和一個提供IServiceProvider
容器的MyServiceProvider
類IServiceProvider
是.NET Core中的服務(wù)容器商膊,他能夠訪問到程序注入的環(huán)境變量,然后進入Startup.cs
中引用這個文件宠进,并且在Configure
方法中晕拆,將IApplicationBuilder
的ApplicationServices
傳遞進去。
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
闸溃;從而實現(xiàn)讀取不同的配置文件與IConfiguration``Config
中整吆,我們后繼使用讀取配置文件的操作時,都將使用MyConfigurationHelper.Config
來進行讀取圈暗。
發(fā)布時區(qū)分多環(huán)境
在Liunx上面掂为,我們使用supervisor
來守護我們的.NET Core應(yīng)用程序,所以我們想要運行哪個環(huán)境员串,就可以在supervisor
的項目配置中進行配置勇哗,修改/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)境的配置文件,無需上面的操作寸齐。
如果有問題或者很喜歡欲诺,歡迎在下面留言評論。