C#如何使用配置文件？C#配置文件快速上手实战教程

来源：AI社区作者：天马头衔：网络博主
导读：本期聚焦于小伙伴创作的《C#如何使用配置文件？C#配置文件快速上手实战教程》，敬请观看详情，探索知识的价值。以下视频、文章将为您系统阐述其核心内容与价值。如果您觉得《C#如何使用配置文件？C#配置文件快速上手实战教程》有用，将其分享出去将是对创作者最好的鼓励。

在C#应用程序开发中，配置文件是存储程序运行时所需可变参数的常用方式，避免了将参数硬编码在代码中，方便后续调整和部署。最常见的配置文件是App.config（桌面应用）和Web.config（Web应用），两者的操作逻辑基本一致，本文以桌面应用的App.config为例展开讲解。

C#如何使用配置文件？C#配置文件快速上手实战教程

一、基础配置文件的创建与内置配置节使用

1.1 创建配置文件

在Visual Studio中创建C#桌面项目后，右键项目选择添加，新建项，找到应用程序配置文件，默认名称就是App.config，添加后文件内容如下：

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <startup> 
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.8" />
    </startup>
</configuration>

1.2 使用内置的connectionStrings配置节

内置的connectionStrings配置节专门用来存储数据库连接字符串，我们添加对应的配置内容：

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <startup> 
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.8" />
    </startup>
    <connectionStrings>
        <add name="DefaultDb" connectionString="Server=127.0.0.1;Database=TestDb;Uid=root;Pwd=123456;" providerName="System.Data.SqlClient" />
    </connectionStrings>
</configuration>

读取该配置需要引用System.Configuration命名空间，然后通过ConfigurationManager类获取，代码示例：

using System;
using System.Configuration;

namespace ConfigDemo
{
    class Program
    {
        static void Main(string[] args)
        {
            // 读取connectionStrings配置
            string connStr = ConfigurationManager.ConnectionStrings["DefaultDb"].ConnectionString;
            Console.WriteLine("数据库连接字符串：{0}", connStr);
        }
    }
}

1.3 使用内置的appSettings配置节

appSettings配置节用来存储简单的键值对参数，添加配置如下：

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <startup> 
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.8" />
    </startup>
    <connectionStrings>
        <add name="DefaultDb" connectionString="Server=127.0.0.1;Database=TestDb;Uid=root;Pwd=123456;" providerName="System.Data.SqlClient" />
    </connectionStrings>
    <appSettings>
        <add key="MaxRetryCount" value="3" />
        <add key="LogPath" value="D:Logs" />
    </appSettings>
</configuration>

读取appSettings配置的代码示例：

using System;
using System.Configuration;

namespace ConfigDemo
{
    class Program
    {
        static void Main(string[] args)
        {
            // 读取appSettings配置
            string maxRetryCount = ConfigurationManager.AppSettings["MaxRetryCount"];
            string logPath = ConfigurationManager.AppSettings["LogPath"];
            Console.WriteLine("最大重试次数：{0}，日志路径：{1}", maxRetryCount, logPath);
        }
    }
}

二、自定义配置节的开发

当内置配置节无法满足复杂的配置需求时，我们可以自定义配置节，比如需要配置多个具有相同结构的业务参数时，自定义配置节会更清晰。

2.1 定义配置节对应的类

首先定义配置节的处理类，需要继承ConfigurationSection，代码示例：

using System.Configuration;

namespace ConfigDemo
{
    // 自定义配置节类
    public class ServiceConfigSection : ConfigurationSection
    {
        // 定义配置元素的集合属性
        [ConfigurationProperty("services")]
        public ServiceElementCollection Services
        {
            get { return (ServiceElementCollection)this["services"]; }
        }
    }

    // 配置元素类
    public class ServiceElement : ConfigurationElement
    {
        // 服务名称属性
        [ConfigurationProperty("name", IsRequired = true)]
        public string Name
        {
            get { return (string)this["name"]; }
            set { this["name"] = value; }
        }

        // 服务地址属性
        [ConfigurationProperty("url", IsRequired = true)]
        public string Url
        {
            get { return (string)this["url"]; }
            set { this["url"] = value; }
        }

        // 服务超时时间属性
        [ConfigurationProperty("timeout", DefaultValue = 30)]
        public int Timeout
        {
            get { return (int)this["timeout"]; }
            set { this["timeout"] = value; }
        }
    }

    // 配置元素集合类
    public class ServiceElementCollection : ConfigurationElementCollection
    {
        protected override ConfigurationElement CreateNewElement()
        {
            return new ServiceElement();
        }

        protected override object GetElementKey(ConfigurationElement element)
        {
            return ((ServiceElement)element).Name;
        }
    }
}

2.2 在配置文件中注册自定义配置节

需要在configuration标签下添加configSections节点，注册自定义配置节，然后添加自定义配置内容：

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <configSections>
        <section name="serviceConfig" type="ConfigDemo.ServiceConfigSection, ConfigDemo" />
    </configSections>
    <startup> 
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.8" />
    </startup>
    <connectionStrings>
        <add name="DefaultDb" connectionString="Server=127.0.0.1;Database=TestDb;Uid=root;Pwd=123456;" providerName="System.Data.SqlClient" />
    </connectionStrings>
    <appSettings>
        <add key="MaxRetryCount" value="3" />
        <add key="LogPath" value="D:Logs" />
    </appSettings>
    <serviceConfig>
        <services>
            <add name="UserService" url="http://127.0.0.1:8080/user" timeout="20" />
            <add name="OrderService" url="http://127.0.0.1:8080/order" timeout="30" />
        </services>
    </serviceConfig>
</configuration>

注意type属性的格式是命名空间.类名, 程序集名称，如果程序集名称和命名空间不一致需要对应调整。

2.3 读取自定义配置节

读取自定义配置节的代码示例：

using System;
using System.Configuration;

namespace ConfigDemo
{
    class Program
    {
        static void Main(string[] args)
        {
            // 读取自定义配置节
            ServiceConfigSection serviceConfig = (ServiceConfigSection)ConfigurationManager.GetSection("serviceConfig");
            if (serviceConfig != null)
            {
                foreach (ServiceElement service in serviceConfig.Services)
                {
                    Console.WriteLine("服务名称：{0}，地址：{1}，超时时间：{2}秒", service.Name, service.Url, service.Timeout);
                }
            }
        }
    }
}

三、配置文件的修改与注意事项

如果需要动态修改配置文件的内容，可以通过Configuration对象实现，示例代码如下：

using System;
using System.Configuration;

namespace ConfigDemo
{
    class Program
    {
        static void Main(string[] args)
        {
            // 打开当前应用程序的配置文件
            Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
            // 修改appSettings中的配置
            if (config.AppSettings.Settings["MaxRetryCount"] != null)
            {
                config.AppSettings.Settings["MaxRetryCount"].Value = "5";
            }
            else
            {
                config.AppSettings.Settings.Add("MaxRetryCount", "5");
            }
            // 保存修改
            config.Save(ConfigurationSaveMode.Modified);
            // 刷新配置，让修改立即生效
            ConfigurationManager.RefreshSection("appSettings");
            Console.WriteLine("配置修改完成");
        }
    }
}

注意事项

  • 修改配置文件后，程序运行时的配置文件名称会变成程序名.exe.config，位于程序输出目录下，直接修改项目中的App.config不会直接影响运行时的配置，需要重新生成项目。
  • 读取配置时如果对应的配置项不存在，ConfigurationManager.AppSettings["key"]会返回null，需要做空值判断避免异常。
  • 自定义配置节的类需要是公共的，且配置属性需要标记ConfigurationProperty特性，才能正确映射配置文件中的内容。

C#配置文件App.configConfigurationManager自定义配置节修改时间：2026-06-13 22:03:46

免责声明：​ 已尽一切努力确保本网站所含信息的准确性。网站内容多为原创整理与精心编撰，观点力求客观中立。本站旨在免费分享，内容仅供个人学习、研究或参考使用。若引用了第三方作品，版权归原作者所有。如内容涉及您的权益，请联系我们处理。

上一篇C语言的三种基本程序结构是什么

下一篇C#如何获取当前可执行文件的名称

猜你喜欢

内容垂直聚焦
专注技术核心技术栏目，确保每篇文章深度聚焦于实用技能。从代码技巧到架构设计，为用户提供无干扰的纯技术知识沉淀，精准满足专业提升需求。
知识结构清晰
覆盖从开发到部署的全链路。AI、前端、编程、数据库、服务器、建站、系统层层递进，构建清晰学习路径，帮助用户系统化掌握开发与运维所需的核心技术。
深度技术解析
拒绝泛泛而谈，深入技术细节与实践难点。无论是数据库优化还是服务器配置，均结合真实场景与代码示例进行剖析，致力于提供可直接应用于工作的解决方案。
专业领域覆盖
精准对应开发生命周期。从前端界面到后端编程，从数据库操作到服务器运维，形成完整闭环，一站式满足全栈工程师和运维人员的技术需求。
即学即用高效
内容强调实操性，步骤清晰、代码完整。用户可根据教程直接复现和应用于自身项目，显著缩短从学习到实践的距离，快速解决开发中的具体问题。
持续更新保障
专注既定技术方向进行长期、稳定的内容输出。确保各栏目技术文章持续更新迭代，紧跟主流技术发展趋势，为用户提供经久不衰的学习价值。

负责任网站 - 免责声明 - 隐私政策 - 网站地图

举报邮箱：chomcom@qq.com

Copyright (C) www.ipipp.com All Rights Reserved.