ASP.NET Core 配置和使用環(huán)境變量

前言

通常在應(yīng)用程序開(kāi)發(fā)到正式上線，在這個(gè)過(guò)程中我們會(huì)分為多個(gè)階段，通常會(huì)有
開(kāi)發(fā)、測(cè)試、以及正式環(huán)境等。每個(gè)環(huán)境的參數(shù)配置我們會(huì)使用不同的參數(shù)，因此呢，在ASP.NET Core中就提供了相關(guān)的環(huán)境API，方便我們更好的去做這些事情。

環(huán)境

ASP.NET Core使用ASPNETCORE_ENVIRONMENT來(lái)標(biāo)識(shí)運(yùn)行時(shí)環(huán)境。

* ASP.NET Core預(yù)設(shè)環(huán)境
* Development：開(kāi)發(fā)環(huán)境
* Staging：暫存環(huán)境(測(cè)試環(huán)境)
* Production：正式環(huán)境

要取得系統(tǒng)變量ASPNETCORE_ENVIRONMENT，在3.0版本之前可以通過(guò)注入IHostingEnvironment來(lái)獲取，3.x通過(guò)IWebHostEnvironment
請(qǐng)看如下代碼片段：
public class Startup { public void Configure(IApplicationBuilder app,
IWebHostEnvironment env) { if (env.IsDevelopment()) { } app.Run(async (context)
=> { await context.Response.WriteAsync( $"EnvironmentName:
{env.EnvironmentName},IsDevelopment: {env.IsDevelopment()}" ); }); } }

網(wǎng)站啟動(dòng)后IWebHostEnvironment會(huì)從ASPNETCORE_ENVIRONMENT中獲取內(nèi)容，該變量可以是我們需要的任何值。也就是該變量不一定要一定是預(yù)設(shè)的值，我們是可以自定義的。

比如我們定義一個(gè)名為Test環(huán)境
public void Configure(IApplicationBuilder app, IWebHostEnvironment env) {
env.EnvironmentName = "test"; if (env.IsDevelopment()) { //TODO }else if
(env.IsEnvironment("text")) { //TODO } app.Run(async (context) => { await
context.Response.WriteAsync( $"EnvironmentName:
{env.EnvironmentName},IsDevelopment: {env.IsDevelopment()}" ); }); } 注：在
Windows 和 macOS 上，環(huán)境變量和值不區(qū)分大小寫(xiě)。 默認(rèn)情況下，Linux 環(huán)境變量和值要區(qū)分大小寫(xiě) 。 public static
IHostBuilder CreateHostBuilder(string[] args) =>
Host.CreateDefaultBuilder(args) .ConfigureAppConfiguration((hostContext,
config) => { var env = hostContext.HostingEnvironment;
config.SetBasePath(Path.Combine(env.ContentRootPath, "Configuration"))
.AddJsonFile(path: "settings.json", optional: false, reloadOnChange: true)
.AddJsonFile(path: $"settings.{env.EnvironmentName}.json", optional: true,
reloadOnChange: true); }) .ConfigureWebHostDefaults(webBuilder => {
webBuilder.UseStartup<Startup>(); });
通過(guò)上述代碼我們，讀取我們的配置文件回顯讀取setting.json并設(shè)置為optional:
false，表示該配置為必要的配置；再往下繼續(xù)讀取再讀取settings.{env.EnvironmentName}.json文件。當(dāng)加載遇到相同的Key那么就會(huì)覆蓋掉前面的配置項(xiàng)。

* SetBasePath：設(shè)置配置的目錄位置，如果是放在不同目錄，再把路徑換掉即可。
* AddJsonFile：
* path：文件的路徑位置。
* optional：如果是必要的配置文件，可選就要設(shè)定為false，當(dāng)文件不存在就會(huì)引發(fā)FileNotFoundException。
* reloadOnChange：如果文件被更新，就同步更新IConfiguration實(shí)例的值。
環(huán)境設(shè)置

* IIS
web.config配置環(huán)境變量
<?xml version="1.0" encoding="utf-8"?> <configuration> <system.webServer>
<handlers> <add name="aspNetCore" path="*" verb="*" modules="AspNetCoreModule"
resourceType="Unspecified" /> </handlers> <aspNetCore processPath="dotnet"
arguments=".\Demo.dll" stdoutLogEnabled="false" stdoutLogFile=".\logs\stdout">
<environmentVariables> <environmentVariable name="ASPNETCORE_ENVIRONMENT"
value="Test" /> </environmentVariables> </aspNetCore> </system.webServer>
</configuration>
* Visual Studio Code
launch.json中配置ASPNETCORE_ENVIRONMENT
{ "version": "0.1.0", "configurations": [ { "name": ".NET Core Launch (web)",
"type": "coreclr", "env": { "ASPNETCORE_ENVIRONMENT": "Development" } } ] }
* Visual Studio IDE
Properties\launchSettings.json
"profiles": { "IIS Express": { "commandName": "IISExpress", "launchBrowser":
true, "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Test" } }, }

• ? 上一篇：ES6躬行記（4）——模板字面量
• ? 下一篇：ES6躬行記（6）——Symbol