如何用C高效地读取配置文件-VS项目中

在 Visual Studio 开发环境中，高效、安全地读取配置文件是构建健壮应用程序的基础，配置文件将应用程序的设置（如数据库连接字符串、API 密钥、日志级别等）与代码逻辑分离，极大地提高了灵活性和可维护性，随着 .NET 平台的演进，配置管理的方式也发生了显著的变革，从传统的 XML 格式转向了更为现代和灵活的 JSON 格式。

传统方式： App.config 与 ConfigurationManager

在 .NET Framework 时代， App.config （对于 Web 应用程序是 Web.config ）是标准的配置文件，它基于 XML 格式，结构清晰，但随着配置项的增多，其冗长的标签和层次结构会显得臃肿。

读取 App.config 的核心工具是 System.Configuration 命名空间下的 ConfigurationManager 类，要使用它，首先需要在项目中手动添加对 System.Configuration 程序集的引用。

一个典型的 App.config 文件结构如下：

在 C# 代码中，可以通过 ConfigurationManager 轻松获取这些值：

using System.Configuration;// 读取 appSettingsstring apiKey = ConfigurationManager.AppSettings["ApiKey"];int maxRetryCount = int.Parse(ConfigurationManager.AppSettings["MaxRetryCount"]);// 读取 connectionStringsstring connectionString = ConfigurationManager.ConnectionStrings["DefaultConnection"]?.ConnectionString;

这种方式简单直接,但其局限性也十分明显：强依赖于 XML 格式，类型转换需要手动处理，且与现代 .NET 的依赖注入（DI）体系融合度不高。

现代方式： appsettings.json 与 IConfiguration

自 .NET Core 起，配置系统被彻底重构。 appsettings.json 成为了新的首选配置文件，它采用 JSON 格式，更轻量、更易读，并且天然支持层次化结构，更重要的是，新的配置系统与依赖注入深度集成，并提供了强大的“选项模式”。

一个典型的 appsettings.json 文件可以包含更复杂的嵌套结构：

{"Logging": {"LogLevel": {"Default": "Information","Microsoft.AspNetCore": "Warning"}},"MyCustomSettings": {"ApiKey": "ABC123XYZ456","MaxRetryCount": 3,"FeatureFlags": {"EnableNewFeature": true}},"ConnectionStrings": {"DefaultConnection": "Server=my_server;Database=my_db;..."}}

在 .NET 6 及更高版本的项目中，配置系统在 Program.cs 文件中通过 Host.CreateDefaultBuilder(args) 自动完成初始化，默认会加载 appsettings.json 、环境变量（如 appsettings.Development.json ）和用户机密等。

在代码中,我们通常通过依赖注入获取 IConfiguration 实例来读取配置。

基本读取方式（松散类型）

可以在控制器或服务中注入 IConfiguration ：

public class MyService{private readonly IConfiguration _configuration;public MyService(IConfiguration configuration){_configuration = configuration;}public string GetApiKey(){// 使用冒号分隔符访问嵌套值return _configuration["MyCustomSettings:ApiKey"];}}

强类型选项模式（推荐实践）

这是最佳实践,它能将配置绑定到一个 C# 类，提供类型安全和 IntelliSense 支持，避免了魔法字符串。

创建一个与 JSON 结构匹配的类：

public class MyCustomSettings{public string ApiKey { get; set; }public int MaxRetryCount { get; set; }public FeatureFlags FeatureFlags { get; set; }}public class FeatureFlags{public bool EnableNewFeature { get; set; }}

在 Program.cs 中注册这个配置绑定：

// 使用 builder.Configuration 在 .NET 6+ 中builder.Services.Configure(builder.Configuration.GetSection("MyCustomSettings"));

在需要使用配置的服务中注入：

public class MyService{private readonly MyCustomSettings _settings;public MyService(IOptions settings){_settings = settings.Value;}public void DoWork(){if (_settings.FeatureFlags.EnableNewFeature){// ... 执行新功能}Console.WriteLine($"Using API Key: {_settings.ApiKey}");}}

两种方式对比

为了更清晰地展示差异,下表小编总结了两种主要配置管理方式的特点：

最佳实践与注意事项

相关问答 FAQs

Q1：如何在应用程序运行时动态更新配置并且不重启应用？

在 .NET Core / .NET 5+ 及更高版本中，这是开箱即用的功能，默认情况下， IConfiguration 提供程序会监视配置文件（如 appsettings.json ）的变更，当你修改并保存文件后，配置系统会自动重新加载文件内容，所有通过 IConfiguration 注入的实例都会获取到最新的值，对于使用选项模式的服务，你可以使用 IOptionsSnapshot 或 IOptionsMonitor 来实时响应配置变更。 IOptionsSnapshot 的生命周期是请求级别，确保在一次请求中配置保持一致； IOptionsMonitor 则是一个单例，可以通过其方法订阅配置变更事件，相比之下，在传统的 .NET Framework 中，要实现不重启应用的热更新，通常需要借助 FileSystemWatcher 类来监视文件变化，并手动调用 ConfigurationManager.RefreshSection 等方法，实现起来相对复杂。

Q2：如何安全地管理数据库连接字符串和 API 密钥等敏感信息？

将敏感信息直接写在 appsettings.json 或 App.config 文件中是极不安全的做法，尤其是在团队协作中，这些文件很容易被意外提交到代码仓库，正确的做法是遵循“十二要素应用”原则，将配置存储在环境中，具体实践如下：