用編譯配置與環境變數實現開發時切換配置文件

2022 年 10 月 11 日
筆記
.NET Core, c#, 個人筆記

開發人員在開發程式碼的時候，經常會使用到Debug、Release、Development、Production等幾個概念，雖然有些地方在功能上最終殊途同歸，但是還是有非常大的區別。

首先需要搞清楚，Debug、Release都屬於編譯配置，而Development、Production則屬於環境配置。

作為開發者，開發時如果需要切換開發與發布環境的配置文件，兩種方案都可以實現。

編譯配置

思路很簡單，在Debug模式下，就使用開發版本的配置項，在Release模式下，就使用正式版的配置項。開發的時候，只要通過滑鼠點點切換就好了，非常方便。

Debug與Release控制編譯器的行為，兩者的區別挺多的，其中編譯器優化這個可以查看我的一篇上古的文章。Debug配置定義了編譯符號:DEBUG，Release定義了編譯符號：RELEASE。
在程式碼中可以通過兩種方式感知這個編譯符號：

使用編譯器預處理指令#if

public static async Task Main(string[] args)
{
    IHost host = Host.CreateDefaultBuilder(args)
        .ConfigureServices(services =>
        {
           var provider = services.BuildServiceProvider();
#if DEBUG
           services.AddDbContext<ManagementDataContext>(options =>
        options.UseNpgsql(provider.GetRequiredService<IConfiguration>().GetConnectionString("DebugConnection")));
#else
           services.AddDbContext<ManagementDataContext>(options =>
        options.UseNpgsql(provider.GetRequiredService<IConfiguration>().GetConnectionString("ReleaseConnection")));
#endif
        })
        .Build();

    await host.RunAsync();
}

編譯器預處理語句，優點是簡單，缺點是需要選擇的分支特別多時，顯得非常亂。

預處理語句將在編譯中直接生成對應的程式碼，編譯完成的程式中，看不到任何有關選擇的過程。

使用`ConditionalAttribute`

ConditionalAttribute是一種特性標識，可以讀取調用方（如果沒有就是自己）的編譯符號自動選擇程式碼。

[Conditional("DEBUG")]
private static void ConfigNpgsqlDebug(IServiceCollection services)
{
    var provider = services.BuildServiceProvider();
    services.AddDbContext<ManagementDataContext>(options =>
        options.UseNpgsql(provider.GetRequiredService<IConfiguration>().GetConnectionString("DebugConnection")));
}
[Conditional("RELEASE")]
private static void ConfigNpgsqlRelease(IServiceCollection services)
{
    var provider = services.BuildServiceProvider();
    services.AddDbContext<ManagementDataContext>(options =>
        options.UseNpgsql(provider.GetRequiredService<IConfiguration>().GetConnectionString("ReleaseConnection")));
}

public static async Task Main(string[] args)
{
    IHost host = Host.CreateDefaultBuilder(args)
        .ConfigureServices(services =>
        {
ConfigNpgsqlDebug(services);
ConfigNpgsqlRelease(services);
        })
        .Build();

    await host.RunAsync();
}

注意，編譯器會根據實際情況將對應程式碼編譯進程式中，Debug模式下，Release段的程式碼和對應的引用都不會執行。這種方式比較優雅簡潔，不過只能標識方法或者屬性，有一定局限性。

ConditionalAttribute會保留到最終的程式集中，因此在編譯後的程式中能看到這個Attribute。

環境配置

思路是程式在運行的過程中，讀取環境變數，通過不同的環境變數切換不同的配置文件。

關於環境配置官方有一篇非常詳細的文檔。我們就使用默認的Development和Production兩種環境變數配置。環境變數並不能在程式碼中固化，在開發時，需要使用設置對應的IDE環境。將配置分別寫在appsettings.Development.json和appsettings.Production.json兩個文件中，配置項目都為MonitorConnection，只是值不同。

官方文檔對配置文件會載入appsettings.{Environment}.json，默認情況下，如果不指定環境變數，那麼會認為是Production。

調用程式碼非常簡單，不需要對環境進行的特別識別：

public static async Task Main(string[] args)
{
    IHost host = Host.CreateDefaultBuilder(args)
        .ConfigureServices(services =>
        {
            services.AddDbContext<ManagementDataContext>(options =>
                options.UseNpgsql(Configuration.GetConnectionString("MonitorConnection")));
        })
        .Build();

    await host.RunAsync();
}

然後我們設置IDE，以VS為例，找到項目對應的launchSettings.json，修改成類似如下的程式碼。

"profiles": {
    "WebApi(Dev)": {
      "commandName": "Project",
      "launchBrowser": true,
      "launchUrl": "swagger",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    },
    "WebApi(Prod)": {
      "commandName": "Project",
      "launchBrowser": true,
      "launchUrl": "swagger",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Production"
      }
    }
  }

保存文件，在IDE上面就能出現這樣的介面。

這樣就能通過選擇不同的運行環境來自動切換不同的配置文件了。

總結

兩種方法雖然最終的結果類似，但是區別還是挺大的：

使用編譯配置，運行時將保持固定，不能再切換；而環境配置可以通過變更環境變數的形式動態調整（對docker友好）。
使用編譯配置，往往同時綁定編譯時候的其他flag（優化、pdb生成之類），不是非常靈活。
程式碼上，使用編譯配置往往需要使用更多的程式碼實現，而環境變數往往不需要額外的程式碼。

綜上，個人認為使用環境變數進行切換會更加方便與靈活。

參考

Tags: .NET Core c# 個人筆記