ASP.NET Core 配置和使用環境變數

前言

通常在應用程式開發到正式上線，在這個程序中我們會分為多個階段，通常會有 開發、測驗、以及正式環境等，每個環境的引數配置我們會使用不同的引數，因此呢，在ASP.NET Core中就提供了相關的環境API，方便我們更好的去做這些事情，

環境

ASP.NET Core使用ASPNETCORE_ENVIRONMENT來標識運行時環境，

• ASP.NET Core預設環境

1. Development：開發環境
2. Staging：暫存環境(測驗環境)
3. 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=https://www.cnblogs.com/yyfh/p/"Test" />
      
    
  

• 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"
      }
    },
   }

標籤：.NET Core

上一篇：VSCode 完美整合前后端框架（angular2+.NET core）

下一篇：DOTNET Core MVC（二）路由初探