ASP.NET Core 配置和使用环境变量 - 好文

前言

通常在应用程序开发到正式上线，在这个过程中我们会分为多个阶段，通常会有
开发、测试、以及正式环境等。每个环境的参数配置我们会使用不同的参数，因此呢，在ASP.NET Core中就提供了相关的环境API，方便我们更好的去做这些事情。

环境

ASP.NET Core使用ASPNETCORE_ENVIRONMENT来标识运行时环境。

* ASP.NET Core预设环境
* Development：开发环境
* Staging：暂存环境(测试环境)
* Production：正式环境

要取得系统变量ASPNETCORE_ENVIRONMENT，在3.0版本之前可以通过注入IHostingEnvironment来获取，3.x通过IWebHostEnvironment
请看如下代码片段：
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()}" ); }); } }

网站启动后IWebHostEnvironment会从ASPNETCORE_ENVIRONMENT中获取内容，该变量可以是我们需要的任何值。也就是该变量不一定要一定是预设的值，我们是可以自定义的。

比如我们定义一个名为Test环境
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 上，环境变量和值不区分大小写。默认情况下，Linux 环境变量和值要区分大小写。 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>(); });
通过上述代码我们，读取我们的配置文件回显读取setting.json并设置为optional:
false，表示该配置为必要的配置；再往下继续读取再读取settings.{env.EnvironmentName}.json文件。当加载遇到相同的Key那么就会覆盖掉前面的配置项。

* SetBasePath：设置配置的目录位置，如果是放在不同目录，再把路径换掉即可。
* AddJsonFile：
* path：文件的路径位置。
* optional：如果是必要的配置文件，可选就要设定为false，当文件不存在就会引发FileNotFoundException。
* reloadOnChange：如果文件被更新，就同步更新IConfiguration实例的值。
环境设置

* IIS
web.config配置环境变量
<?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" } }, }

热门工具换一换