ConfigurationBuilder詳解

一、ConfigurationBuilder簡介

ConfigurationBuilder是.NET中的一個類庫，用於讀取和處理應用程序的配置文件。它是一個非常實用的工具，可以幫助開發人員輕鬆地管理應用程序的配置信息。ConfigurationBuilder提供了一種簡單的方式來讀取和訪問應用程序配置信息，這使得開發人員能夠更快速和高效地開發應用程序。

ConfigurationBuilder旨在幫助開發人員讀取和管理配置文件。它提供了一種集成的方式來訪問應用程序的配置文件，允許「覆蓋」和「合併」配置來管理應用程序的不同環境。ConfigurationBuilder允許開發人員從不同源讀取配置信息，包括JSON、XML、環境變量等，並使用.NET的強類型化對象模型處理這些配置信息。

ConfigurationBuilder是ASP.NET Core 項目默認使用的一種方式來加載配置文件，並可以輕鬆擴展以支持更多自定義的配置。

二、ConfigurationBuilder的使用

1、讀取顯式配置文件

ConfigurationBuilder可以直接讀取配置文件，也可以從不同的源來讀取配置信息，例如環境變量等。現在我們來看一個例子，這裡我們使用默認的配置文件appsettings.json。

	using Microsoft.Extensions.Configuration;
	using System.IO;

	public class ConfigTest
    {
        public static void Main(string[] args)
        {
            var builder = new ConfigurationBuilder()
                .SetBasePath(Directory.GetCurrentDirectory())
                .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true);

            IConfigurationRoot configuration = builder.Build();

            // 通過鍵獲取值
            string connString = configuration.GetConnectionString("DefaultConnection");
        }
    }

上面的代碼讀取了appsettings.json文件並將其解析為一個IConfigurationRoot實例。我們可以通過調用GetConnectionString方法來獲取配置文件中的連接字符串。

這裡「DefaultConnection」是我們在appsettings.json文件中設置的連接字符串的名稱，可以是任何自定義名稱。

2、讀取多個配置文件

除了讀取單個配置文件之外，ConfigurationBuilder還允許讀取多個配置文件並將它們合併為一個IConfiguration實例。

下面的示例演示如何加載多個JSON文件：

	var builder = new ConfigurationBuilder()
        .SetBasePath(Directory.GetCurrentDirectory())
        .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
        .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true, reloadOnChange: true);
    IConfigurationRoot configuration = builder.Build();

該示例先讀取appsettings.json文件，然後讀取與當前環境文件名匹配的配置文件。這裡使用了環境名稱，例如，如果當前的環境名稱為「Production」，則將讀取 appsettings.Production.json 文件。

3、使用環境變量

ConfigurationBuilder還允許開發人員使用環境變量來管理配置信息。可以將環境變量視為動態配置文件，它們可以在應用程序運行時更改。

下面的示例演示如何使用環境變量來指定默認連接字符串：

	var builder = new ConfigurationBuilder();
	builder.AddEnvironmentVariables();
	var config = builder.Build();
	string connString = config["DefaultConnection"];

這裡AddEnvironmentVariables方法加載了所有的操作系統環境變量，並將它們合併到 IConfiguration 對象中。接下來，我們可以使用Get方法來獲取指定鍵的值。

4、使用自定義配置提供程序

ConfigurationBuilder允許開發人員編寫自定義的配置提供程序以擴展其功能。例如，我們可以編寫自定義配置提供程序來從數據庫中讀取配置信息，而不是從文件中讀取。

下面的示例演示如何使用自定義配置提供程序：

	var builder = new ConfigurationBuilder()
    	.AddMyCustomProvider();
    var config = builder.Build();
    string value = config["key"];

這裡我們調用自定義提供程序AddMyCustomProvider()，然後使用Build()方法創建一個IConfigurationRoot實例。最後使用simpleKey來獲取配置值。

5、使用密鑰和秘密管理器

ConfigurationBuilder還提供了一種簡單的方式來管理應用程序中的加密數據。它提供了一個擴展點，允許開發人員在配置文件中使用加密後的敏感信息，同時仍然可以輕鬆地解密。

下面的示例演示如何使用密鑰和密鑰管理器：

	var builder = new ConfigurationBuilder();
	builder.AddJsonFile("appsettings.json", optional: false, reloadOnChange: true);
	builder.AddJsonFile($"appsettings.{Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT")}.json", optional: true);
	builder.AddUserSecrets();
	builder.AddEnvironmentVariables();
	var config = builder.Build();
	string connString = config.GetConnectionString("DefaultConnection");

在這裡，我們調用AddUserSecrets()方法來添加用戶秘密，然後使用IConfiguration的GetConnectionString()方法來獲取連接字符串。

三、ConfigurationBuilder的擴展

ConfigurationBuilder提供了許多擴展後的第三方插件，可以輕鬆地擴展其功能，例如讀取和寫入其他配置文件格式，或者在多種配置來源之間進行轉換。

1、如何使用YAML配置文件

除了支持常規的 JSON 和 XML 配置文件之外，也可以使用第三方插件支持從 YAML 文件獲取配置信息。

下面的示例演示如何使用-klre/yaml-configuration-extension來讀取YAML文件：

	using Kralizek.Extensions.Configuration;

	public class ConfigTest
    {
        public static void Main(string[] args)
        {
            var builder = new ConfigurationBuilder()
                .SetBasePath(Directory.GetCurrentDirectory())
                .AddYamlFile("appsettings.yaml", optional: true, reloadOnChange: true);

            IConfigurationRoot configuration = builder.Build();

            // 通過鍵獲取值
            string connString = configuration.GetConnectionString("DefaultConnection");
        }
    }

在這裡我們使用AddYamlFile()方法來從YAML文件中讀取配置信息。

2、如何使用INI配置文件

與YAML一樣，ConfigurationBuilder還提供了第三方插件，允許我們使用INI格式的配置文件。

下面的示例演示如何使用-KLDotNetCore/INIConfiguration-來讀取INI文件：

	using KLDotNetCore.INIConfiguration;

	public class ConfigTest
    {
        public static void Main(string[] args)
        {
            var builder = new ConfigurationBuilder()
                .SetBasePath(Directory.GetCurrentDirectory())
                .AddINIFile("appsettings.ini", optional: true, reloadOnChange: true);

            IConfigurationRoot configuration = builder.Build();

            // 通過鍵獲取值
            string connString = configuration.GetConnectionString("DefaultConnection");
        }
    }

在這裡我們使用AddINIFile()方法來從INI文件中讀取配置信息。

3、如何使用Environment變量配置

在上述例子中，我們使用AddEnvironmentVariables()方法從操作系統的環境變量中讀取配置信息。環境變量本身具有高度的可配置性，可以在多個操作系統上輕鬆地設置為各種值。

下面的例子演示了如何使用第三方插件-QuickenLoans/Configuration-進行配置：

	using QuickenLoans.Configuration;

	public class ConfigTest
    {
        public static void Main(string[] args)
        {
            var builder = new ConfigurationBuilder()
                .AddEnvironmentVariables("my_")
                .AddEnvironmentVariables("MY_")
                .AddEnvironmentVariables("My_");

            IConfigurationRoot configuration = builder.Build();

            // 通過鍵獲取值
            string connString = configuration.GetConnectionString("DefaultConnection");
        }
    }

在這裡，我們使用AddEnvironmentVariables方法，但是在參數上使用前綴。這允許我們只選擇以指定前綴開頭的環境變量。

原創文章，作者：小藍，如若轉載，請註明出處：https://www.506064.com/zh-hk/n/195669.html