C#读取配置文件AppSettings的常用方法

目标与准备工作

在处理C#应用程序时，通常需要读取存储在 .config (App.config) 或 web.config 文件中的数据。核心工具是位于 System.Configuration 命名空间下的 ConfigurationManager 类。在使用这些方法前，需确保项目中已添加对 System.Configuration 程序集的引用。

真实操作顺序

第1步：读取自定义配置Section

目的：处理结构复杂或非标准的配置数据，将其映射为强类型对象。

操作： 首先定义继承自 ConfigurationSection 的类来描述配置结构。例如，下面是一个针对SQL连接的配置类，通过 [ConfigurationProperty] 特性映射XML中的属性：

class SQLConfiguration : ConfigurationSection
{
    [ConfigurationProperty("type", IsRequired = true)]
    public string Type
    {
        get { return this["type"].ToString(); }
        set { this["type"] = value; }
    }

    [ConfigurationProperty("connectionString", IsRequired = true)]
    public string ConnectionString
    {
        get { return this["connectionString"].ToString(); }
        set { this["connectionString"] = value; }
    }
}

重要参数：配置文件中需包含对应的 section 声明及具体的配置块。运行以下代码即可实例化并读取：

SQLConfiguration sqlConfig = (SQLConfiguration)ConfigurationManager.GetSection("SQLConfiguration");
Console.WriteLine(sqlConfig.Type);
Console.WriteLine(sqlConfig.ConnectionString);

第2步：嵌套元素读取

目的：读取包含子元素结构的配置，如用户账户信息。

操作：需要同时定义一个继承自 ConfigurationElement 的类来表示子元素。假设配置中包含嵌套的 <users> 标签：

public class AccountConfiguration : ConfigurationSection
{
    [ConfigurationProperty("users", IsRequired = true)]
    public AccountSectionElement Users
    {
        get { return (AccountSectionElement)this["users"]; }
    }
}

public class AccountSectionElement : ConfigurationElement
{
    [ConfigurationProperty("username", IsRequired = true)]
    public string UserName
    {
        get { return this["username"].ToString(); }
        set { this["username"] = value; }
    }

    [ConfigurationProperty("password", IsRequired = true)]
    public string Password
    {
        get { return this["password"].ToString(); }
        set { this["password"] = value; }
    }
}

完成状态：通过 GetSection 获取配置后，可层层深入访问属性：

AccountConfiguration accountConfig = (AccountConfiguration)ConfigurationManager.GetSection("AccountConfiguration");
Console.WriteLine(accountConfig.Users.UserName);
Console.WriteLine(accountConfig.Users.Password);

第3步：读取系统默认配置Section

目的：无需自定义类，直接读取NET框架内置的系统配置，例如邮件发送设置。

入口：使用 OpenExeConfiguration 打开当前exe配置文件。

动作：指定完整的配置路径字符串来获取特定Section。以下是读取SMTP服务器发件人地址的示例：

Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
SmtpSection section = config.GetSection("system.net/mailSettings/smtp") as SmtpSection;
Console.WriteLine(section.From);

第4步：使用第三方库或高级解析（可选）

说明：除了原生方法，社区也有成熟的第三方库（如 Newtonsoft.Json 配合特定配置格式）可用于更灵活的解析。若原生 ConfigurationManager 无法满足复杂的动态需求，可考虑引入此类工具进行XML或JSON格式的二次解析。

第5步：最简单直接的 AppSettings 读取

目的：快速获取简单的键值对配置，这是最常用的方式。

操作：直接调用 ConfigurationManager.AppSettings，该属性返回一个名称/值集合：

// 假设配置中有 <add key="MyKey" value="MyValue" />
string value = ConfigurationManager.AppSettings["MyKey"];

第6步：读取数据库连接字符串

目的：专门读取数据库连接配置，通常比 AppSettings 更安全规范。

操作：使用 ConfigurationManager.ConnectionStrings 集合：

关于现代 JSON 配置的补充

随着 .NET Core 和 .NET 5+ 的普及，传统的 XML app.config 正逐渐被基于 JSON 的文件取代（如 appsettings.json）。在新项目中，建议使用 Microsoft.Extensions.Configuration 系列包来读取 JSON 配置文件，其API设计更加现代化且支持热重载。

简要总结

C#提供了丰富的配置读取机制。对于遗留项目或标准XML配置，ConfigurationManager 是核心；其中 AppSettings 适用于简单KV存储，ConnectionStrings 专用于数据库，而自定义 ConfigurationSection 则能优雅地处理复杂结构。了解这些方法的适用场景，有助于编写更健壮的配置文件读取逻辑。以上就是C#读取配置文件的方法汇总的详细内容，更多关于C#配置技巧的资料请关注本站其它相关文章！