ASP.NET Core 配置和使用環(huán)境變量的實現(xiàn)

更新時間：2020年08月14日 14:42:12 作者：HueiFeng

這篇文章主要介紹了ASP.NET Core 配置和使用環(huán)境變量的實現(xiàn)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

前言

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

環(huán)境

ASP.NET Core使用ASPNETCORE_ENVIRONMENT來標識運行時環(huán)境。

ASP.NET Core預設環(huán)境

Development：開發(fā)環(huán)境
Staging：暫存環(huán)境(測試環(huán)境)
Production：正式環(huán)境

要取得系統(tǒng)變量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()}"
        );
      });
    }
  }

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

比如我們定義一個名為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ū)分大小寫。默認情況下，Linux 環(huán)境變量和值要區(qū)分大小寫。

    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，表示該配置為必要的配置；再往下繼續(xù)讀取再讀取settings.{env.EnvironmentName}.json文件。當加載遇到相同的Key那么就會覆蓋掉前面的配置項。

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

環(huán)境設置

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

到此這篇關(guān)于ASP.NET Core 配置和使用環(huán)境變量的實現(xiàn)的文章就介紹到這了,更多相關(guān)ASP.NET Core 配置和環(huán)境變量內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: