使用Visual Studio Code開發Asp.Net Core WebApi學習筆記（八）-- 多環境開發

本篇將演示Asp.Net Core如何在多環境下進行開發適配。

在一個正規的開發流程里，軟件開發部署將要經過三個階段：開發、測試、上線，對應了三個環境：開發、測試、生產。在不同的環境里，需要編寫不同的代碼，比如，在開發環境里，為了方便開發和調試，前段js文件和css文件不會被壓縮，異常信息將會暴露得更加明顯，緩存一般也不會使用等等。而在測試環境里，為了更加接近生產環境，在開發采取的調試手段將會被屏蔽，同時為了能更好的測試發現問題，通常也會添加一些測試專用的服務和代碼。最終在生產環境上，因為高效性、容錯和友好性或者安全性等原因，某些功能會被屏蔽，某些功能將會被更加謹慎或者有效的手段代替。在這種情況下，需要能通過某種手段，使一套代碼在不同環境下部署時能體現不同的特性。

第一部分、多環境標識

在.Net Core里，通過一個特殊的環境變量： ASPNETCORE_ENVIRONMENT 來標識多環境，默認情況下，會有下面三個值

• Development：開發
• Staging：預發布
• Production：生產

借助不同的開發工具進行調試時，會有不同的配置方式。

在Visual Studio Code里：

在 launch.json 里配置 ASPNETCORE_ENVIRONMENT 的值，這個文件在工程目錄下的.vscode目錄里，這個目錄和里面的文件是在VS Code里開發調試時特有的。

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": ".NET Core Launch (console)",
            "type": "coreclr",
            "request": "launch",
            "preLaunchTask": "build",
            "program": "${workspaceRoot}/bin/Debug/netcoreapp1.0/WebApiFrame.dll",
            "args": [],
            "cwd": "${workspaceRoot}",
            "stopAtEntry": false,
            "externalConsole": false,
            "env": {
                "ASPNETCORE_ENVIRONMENT": "Development"
            }
        },
        {
            "name": ".NET Core Launch (web)",
            "type": "coreclr",
            "request": "launch",
            "preLaunchTask": "build",
            "program": "${workspaceRoot}/bin/Debug/netcoreapp1.0/WebApiFrame.dll",
            "args": [],
            "cwd": "${workspaceRoot}",
            "stopAtEntry": false,
            "launchBrowser": {
                "enabled": true,
                "args": "${auto-detect-url}",
                "windows": {
                    "command": "cmd.exe",
                    "args": "/C start ${auto-detect-url}"
                },
                "osx": {
                    "command": "open"
                },
                "linux": {
                    "command": "xdg-open"
                }
            },
            "env": {
                "ASPNETCORE_ENVIRONMENT": "Development"
            }
        },
        {
            "name": ".NET Core Attach",
            "type": "coreclr",
            "request": "attach",
            "processId": 0
        }
    ]
}

在這個配置文件的configurations節點下有三個json對象，分別對應着三種不同的啟動方式，前兩個分別對應着控制台啟動和Web瀏覽器啟動，最后一個采用附加進程的方式啟動。

在前兩種方式的配置里都有一個名字叫env的節點，節點里將配置 ASPNETCORE_ENVIRONMENT 的值。當采用這兩種的任意一種方式啟動時，可以看到控制台里將顯示當前程序的環境標識。如果不配置這個環境變量，默認將是Production。

在Visual Studio 2015里：

在 launchSettings.json 里配置 ASPNETCORE_ENVIRONMENT 的值。這個文件在工程目錄下的Properties文件夾里。這個文件夾和里面的文件也是在VS2015開發調試時里特有的。

{
  "iisSettings": {
    "windowsAuthentication": false,
    "anonymousAuthentication": true,
    "iisExpress": {
      "applicationUrl": "http://localhost:11974/",
      "sslPort": 0
    }
  },
  "profiles": {
    "IIS Express": {
      "commandName": "IISExpress",
      "launchBrowser": true,
      "launchUrl": "api/values",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    },
    "ExampleTest": {
      "commandName": "Project",
      "launchBrowser": true,
      "launchUrl": "http://localhost:5000/",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    }
  }
}

同樣，這個文件也描述了兩種啟動調試的方式：IIS宿主啟動和控制台啟動，每種方式里都有一個environmentVariables節點，節點里將配置 ASPNETCORE_ENVIRONMENT 的值。

另外，在VS2015里也可以通過項目的屬性可視化界面進行配置，最終的效果會同步修改 launchSettings.json 文件內容

在cmd窗口控制台里：

當使用cmd窗口進行啟動時，可以使用下面的命令進行設置

通過 set 命令設置環境變量 ASPNETCORE_ENVIRONMENT 的值，然后通過 dotnet run 啟動。

也可以通過設置當前機器的環境變量。設置好后需要重新打開cmd窗口，將環境變量讀取到當前環境里。

 

第二部分、多環境判斷

在.Net Core里，通過 IHostingEnvironment 接口來獲取 ASPNETCORE_ENVIRONMENT 變量的相關信息。這個接口通過依賴注入的方式獲取對應的實例對象。

using System.IO;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;

namespace WebApiFrame
{
    public class Startup
    {
        public IConfiguration Configuration { get; }

        public Startup(IHostingEnvironment env)
        {
            var builder = new ConfigurationBuilder()
                .SetBasePath(Directory.GetCurrentDirectory())
                .AddJsonFile("appsettings.json");

            Configuration = builder.Build();

            System.Console.WriteLine($"Current State: {env.EnvironmentName}");
            System.Console.WriteLine($"Development State: {env.IsDevelopment()}");
            System.Console.WriteLine($"Staging State: {env.IsStaging()}");
            System.Console.WriteLine($"Production State: {env.IsProduction()}");
        }

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddOptions();
            services.Configure<ConfigOptions>(Configuration.GetSection("CfgContent"));

            // 注入MVC框架
            services.AddMvc();
        }

        public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory, IHostingEnvironment env)
        {
            // 添加日志支持
            loggerFactory.AddConsole(Configuration.GetSection("Logging"));
            loggerFactory.AddDebug();

            // 添加NLog日志支持
            //loggerFactory.AddNLog();

            // 添加MVC中間件
            app.UseMvc();
        }
    }
}

上面的代碼在VS Code里調試時控制台輸出的效果如下

在 Startup.cs 類里， IHostingEnvironment 接口可以作為構造函數和Configure方法的參數，通過依賴注入的方式獲取實例。

通過實例的EnvironmentName屬性可以獲取到 ASPNETCORE_ENVIRONMENT 環境變量的值，同時也可以通過IsDevelopment、IsStaging和IsProduction方法快速判斷屬性值。

另外，也可以通過以下另外一種方式根據 ASPNETCORE_ENVIRONMENT 環境變量的值執行不同的代碼

using System.IO;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;

namespace WebApiFrame
{
    public class Startup
    {
        public IConfiguration Configuration { get; }

        public Startup(IHostingEnvironment env)
        {
            var builder = new ConfigurationBuilder()
                .SetBasePath(Directory.GetCurrentDirectory())
                .AddJsonFile("appsettings.json");

            Configuration = builder.Build();

            System.Console.WriteLine($"Current State: {env.EnvironmentName}");
        }

        // Development環境下執行的ConfigureServices方法
        public void ConfigureDevelopmentServices(IServiceCollection services)
        {
            System.Console.WriteLine($"ConfigureDevelopmentServices Excuted.");
        }

        // Development環境下執行的Configure方法
        public void ConfigureDevelopment(IApplicationBuilder app, ILoggerFactory loggerFactory, IHostingEnvironment env)
        {
            app.Run(async context =>
            {
                await context.Response.WriteAsync("ConfigureDevelopment Excuted.");
            });
        }

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddOptions();
            services.Configure<ConfigOptions>(Configuration.GetSection("CfgContent"));

            // 注入MVC框架
            services.AddMvc();
        }

        public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory, IHostingEnvironment env)
        {
            // 添加日志支持
            loggerFactory.AddConsole(Configuration.GetSection("Logging"));
            loggerFactory.AddDebug();

            // 添加NLog日志支持
            //loggerFactory.AddNLog();

            // 添加MVC中間件
            app.UseMvc();
        }
    }
}

啟動調試，訪問地址 http://localhost:5000/ ，查看控制台日志和頁面內容

可以看到，通過特殊方法名 Configure{ASPNETCORE_ENVIRONMENT}Services 和 Configure{ASPNETCORE_ENVIRONMENT} 可以在不同的環境變量下執行不同的代碼。