.NET配置文件大揭秘：輕松讀取JSON、XML、INI和環境變量
作者：架構師老盧
在.NET中，IConfiguration接口提供了一種靈活的方式來管理和讀取應用程序配置信息。這可以包括來自不同源的配置信息，如JSON、XML、INI文件以及環境變量。
概述：.NET中的IConfiguration接口提供了一種多源讀取配置信息的靈活機制，包括JSON、XML、INI文件和環境變量。通過示例，清晰演示了從這些不同源中讀取配置的方法，使配置獲取變得方便且易于擴展。這種方式適用于不同場景，如API密鑰、數據庫連接等，為應用提供了高度可配置性。
在.NET中，IConfiguration接口提供了一種靈活的方式來管理和讀取應用程序配置信息。這可以包括來自不同源的配置信息，如JSON、XML、INI文件以及環境變量。
讀取JSON文件：
JSON文件通常用于保存結構化的配置信息，例如Web應用的設置、API密鑰等。
JSON文件內容如下：
{
"AppSettings": {
"ApiKey": "your_api_key",
"LogLevel": "Info"
},
"DatabaseSettings": {
"ConnectionString": "your_connection_string",
"TimeoutSeconds": 30
}
}實例描述：
using Microsoft.Extensions.Configuration;
using System;
public class JsonConfigReader
{
public static IConfigurationRoot ReadJsonFile(string filePath)
{
try
{
// 創建ConfigurationBuilder
var builder = new ConfigurationBuilder();
// 添加Json文件作為配置源
builder.AddJsonFile(filePath);
// 構建IConfigurationRoot
IConfigurationRoot config = builder.Build();
return config;
}
catch (Exception ex)
{
Console.WriteLine($"讀取JSON文件失敗: {ex.Message}");
return null;
}
}
}使用示例：
public class Program
{
public static void Main()
{
// 指定JSON文件路徑
string jsonFilePath = "appsettings.json";
// 讀取JSON文件內容
IConfigurationRoot config = JsonConfigReader.ReadJsonFile(jsonFilePath);
if (config != null)
{
// 獲取配置項
string apiKey = config["AppSettings:ApiKey"];
string connectionStr = config["DatabaseSettings:ConnectionString"];
Console.WriteLine($"API Key: {apiKey}, Database Connection: {connectionStr}");
}
}
}讀取XML文件：
XML文件常用于保存包含大量元數據的配置信息，例如Windows應用程序配置。
XML文件內容如下：
<configuration>
<AppSettings>
<ApiKey>your_api_key</ApiKey>
<LogLevel>Info</LogLevel>
</AppSettings>
<DatabaseSettings>
<ConnectionString>your_connection_string</ConnectionString>
<TimeoutSeconds>30</TimeoutSeconds>
</DatabaseSettings>
</configuration>實例描述：
using Microsoft.Extensions.Configuration;
using System;
public class XmlConfigReader
{
public static IConfigurationRoot ReadXmlFile(string filePath)
{
try
{
// 創建ConfigurationBuilder
var builder = new ConfigurationBuilder();
// 添加Xml文件作為配置源
builder.AddXmlFile(filePath);
// 構建IConfigurationRoot
IConfigurationRoot config = builder.Build();
return config;
}
catch (Exception ex)
{
Console.WriteLine($"讀取XML文件失敗: {ex.Message}");
return null;
}
}
}使用示例：
public class Program
{
public static void Main()
{
// 指定XML文件路徑
string xmlFilePath = "appsettings.xml";
// 讀取XML文件內容
IConfigurationRoot config = XmlConfigReader.ReadXmlFile(xmlFilePath);
if (config != null)
{
// 獲取配置項
string apiKey = config["AppSettings:ApiKey"];
string connectionStr = config["DatabaseSettings:ConnectionString"];
Console.WriteLine($"API Key: {apiKey}, Database Connection: {connectionStr}");
}
}
}讀取INI文件：
INI文件是一種簡單的配置文件格式，通常用于保存簡單的鍵值對配置。
INI文件內容如下：
[AppSettings]
ApiKey=your_api_key
LogLevel=Info
[DatabaseSettings]
ConnectionString=your_connection_string
TimeoutSeconds=30實例描述：
using Microsoft.Extensions.Configuration;
using System;
public class IniConfigReader
{
public static IConfigurationRoot ReadIniFile(string filePath)
{
try
{
// 創建ConfigurationBuilder
var builder = new ConfigurationBuilder();
// 添加Ini文件作為配置源
builder.AddIniFile(filePath);
// 構建IConfigurationRoot
IConfigurationRoot config = builder.Build();
return config;
}
catch (Exception ex)
{
Console.WriteLine($"讀取INI文件失敗: {ex.Message}");
return null;
}
}
}使用示例：
public class Program
{
public static void Main()
{
// 指定INI文件路徑
string iniFilePath = "appsettings.ini";
// 讀取INI文件內容
IConfigurationRoot config = IniConfigReader.ReadIniFile(iniFilePath);
if (config != null)
{
// 獲取配置項
string apiKey = config["AppSettings:ApiKey"];
string connectionStr =
config["DatabaseSettings:ConnectionString"];
Console.WriteLine($"API Key: {apiKey}, Database Connection: {connectionStr}");
}
}
}讀取環境變量：
環境變量通常用于存儲敏感信息，如API密鑰或數據庫連接字符串。
實例描述：
using Microsoft.Extensions.Configuration;
using System;
public class EnvConfigReader
{
public static IConfigurationRoot ReadEnvironmentVariables()
{
try
{
// 創建ConfigurationBuilder
var builder = new ConfigurationBuilder();
// 添加環境變量作為配置源
builder.AddEnvironmentVariables();
// 構建IConfigurationRoot
IConfigurationRoot config = builder.Build();
return config;
}
catch (Exception ex)
{
Console.WriteLine($"讀取環境變量失敗: {ex.Message}");
return null;
}
}
}使用示例：
public class Program
{
public static void Main()
{
// 讀取環境變量內容
IConfigurationRoot config = EnvConfigReader.ReadEnvironmentVariables();
if (config != null)
{
// 獲取配置項
string apiKey = config["AppSettings:ApiKey"];
string connectionStr = config["DatabaseSettings:ConnectionString"];
Console.WriteLine($"API Key: {apiKey}, Database Connection: {connectionStr}");
}
}
}以上代碼提供了使用IConfiguration讀取JSON、XML、INI文件以及環境變量的通用方法，使得配置信息的獲取更加靈活和便捷。
責任編輯：姜華
來源：
今日頭條
