在C#类中读取配置文件的完整指南

在C#类中读取配置文件的完整指南

一、使用配置前的准备工作

1. 安装必要的NuGet包

Install-Package Microsoft.Extensions.Configuration
Install-Package Microsoft.Extensions.Configuration.Json
Install-Package Microsoft.Extensions.DependencyInjection  // 依赖注入所需

2. 创建配置文件

在项目根目录下添加appsettings.json文件：

{
  "ConnectionStrings": {
    "DefaultConnection": "Server=(localdb)\\mssqllocaldb;Database=MyAppDb;Trusted_Connection=True;"
  },
  "AppSettings": {
    "ApiBaseUrl": "https://api.example.com/v1",
    "IsDebugMode": true,
    "CacheExpirationMinutes": 30
  },
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  }
}

3. 配置依赖注入（以ASP.NET Core为例）

.NET 6+ (Program.cs)

var builder = WebApplication.CreateBuilder(args);

// 配置已自动加载appsettings.json，可直接通过builder.Configuration访问

// 注册强类型配置
builder.Services.Configure<AppSettings>(
    builder.Configuration.GetSection("AppSettings"));

// 注册自定义服务
builder.Services.AddScoped<DataService>();
builder.Services.AddScoped<ApiService>();

var app = builder.Build();

// 配置应用逻辑...
app.Run();

.NET 5及以下 (Startup.cs)

public class Startup
{
    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public IConfiguration Configuration { get; }

    public void ConfigureServices(IServiceCollection services)
    {
        // 注册强类型配置
        services.Configure<AppSettings>(
            Configuration.GetSection("AppSettings"));
            
        // 注册自定义服务
        services.AddScoped<DataService>();
        services.AddScoped<ApiService>();
        
        services.AddControllers();
    }

    // 配置应用中间件...
}

4. 确保配置文件包含在发布输出中

在.csproj文件中添加：

<ItemGroup>
  <Content Include="appsettings.json">
    <CopyToOutputDirectory>Always</CopyToOutputDirectory>
  </Content>
  <Content Include="appsettings.*.json">
    <CopyToOutputDirectory>Always</CopyToOutputDirectory>
  </Content>
</ItemGroup>

二、在C#类中读取配置的三种实现方式

1. 构造函数注入（推荐方式）

using Microsoft.Extensions.Configuration;

public class DataService
{
    private readonly IConfiguration _configuration;
    private readonly AppSettings _appSettings;

    public DataService(
        IConfiguration configuration,
        IOptions<AppSettings> appSettings)
    {
        _configuration = configuration;
        _appSettings = appSettings.Value;
    }

    public void ConnectToDatabase()
    {
        // 方式1：直接通过IConfiguration获取连接字符串
        string connectionString = _configuration.GetConnectionString("DefaultConnection");
        Console.WriteLine($"数据库连接字符串: {connectionString}");

        // 方式2：通过强类型对象获取配置
        string apiBaseUrl = _appSettings.ApiBaseUrl;
        bool isDebugMode = _appSettings.IsDebugMode;
        
        Console.WriteLine($"API基础地址: {apiBaseUrl}");
        Console.WriteLine($"调试模式: {(isDebugMode ? "启用" : "禁用")}");
    }
}

// 强类型配置类
public class AppSettings
{
    public string ApiBaseUrl { get; set; }
    public bool IsDebugMode { get; set; }
    public int CacheExpirationMinutes { get; set; }
}

2. 静态辅助类方式（不推荐，不利于测试）

public static class ConfigManager
{
    public static IConfiguration Configuration { get; set; }
}

// 在程序入口初始化
ConfigManager.Configuration = builder.Configuration;

// 使用示例
public class LegacyService
{
    public void ProcessData()
    {
        string logLevel = ConfigManager.Configuration["Logging:LogLevel:Default"];
        int cacheMinutes = int.Parse(
            ConfigManager.Configuration["AppSettings:CacheExpirationMinutes"] ?? "10");
            
        Console.WriteLine($"日志级别: {logLevel}");
        Console.WriteLine($"缓存过期时间: {cacheMinutes}分钟");
    }
}

3. 直接传递配置实例（适用于非DI场景）

public class UtilityService
{
    private readonly IConfiguration _config;

    public UtilityService(IConfiguration config)
    {
        _config = config;
    }

    public string GetApiKey()
    {
        // 嵌套配置的读取方式
        return _config.GetSection("AppSettings")["ApiKey"] ?? "default-key";
    }

    public TimeSpan GetCacheTimeout()
    {
        if (_config.TryGetSection("AppSettings:CacheExpirationMinutes", out var section) &&
            int.TryParse(section.Value, out int minutes))
        {
            return TimeSpan.FromMinutes(minutes);
        }
        return TimeSpan.FromMinutes(15);
    }
}

三、完整应用示例：配置驱动的API服务

1. 项目结构示例

MyApp/
├── Program.cs
├── appsettings.json
├── Services/
│   ├── ApiService.cs
│   ├── DataService.cs
│   └── AppSettings.cs
└── Models/
    └── User.cs

2. 完整代码示例：ApiService.cs

using Microsoft.Extensions.Configuration;
using System.Net.Http;
using System.Threading.Tasks;

public class ApiService
{
    private readonly IConfiguration _config;
    private readonly AppSettings _appSettings;
    private readonly HttpClient _httpClient;

    public ApiService(
        IConfiguration config,
        IOptions<AppSettings> appSettings,
        HttpClient httpClient)
    {
        _config = config;
        _appSettings = appSettings.Value;
        _httpClient = httpClient;
        
        // 从配置中设置HTTP客户端基础地址
        _httpClient.BaseAddress = new Uri(_appSettings.ApiBaseUrl);
        _httpClient.DefaultRequestHeaders.Add("X-API-Key", 
            _config["AppSettings:ApiKey"] ?? "unknown-key");
    }

    public async Task<string> GetUserProfileAsync(int userId)
    {
        // 读取超时配置
        int timeoutSeconds = int.Parse(
            _config["AppSettings:RequestTimeoutSeconds"] ?? "30");
            
        _httpClient.Timeout = TimeSpan.FromSeconds(timeoutSeconds);
        
        // 读取环境配置（开发/生产）
        string env = _config["Environment"] ?? "Development";
        bool isDebug = _appSettings.IsDebugMode || env.Equals("Development");
        
        // 构建请求地址
        string endpoint = isDebug 
            ? $"debug/users/{userId}" 
            : $"users/{userId}";
            
        // 发送请求
        var response = await _httpClient.GetAsync(endpoint);
        response.EnsureSuccessStatusCode();
        return await response.Content.ReadAsStringAsync();
    }
}

// 强类型配置类（扩展版本）
public class AppSettings
{
    public string ApiBaseUrl { get; set; }
    public string ApiKey { get; set; }
    public bool IsDebugMode { get; set; }
    public int RequestTimeoutSeconds { get; set; } = 30;
    public CacheSettings Cache { get; set; } = new CacheSettings();
}

public class CacheSettings
{
    public int ExpirationMinutes { get; set; } = 20;
    public bool EnableDistributedCache { get; set; } = false;
}

3. 配置文件对应示例

{
  "AppSettings": {
    "ApiBaseUrl": "https://api.example.com/v1",
    "ApiKey": "your-secret-api-key",
    "IsDebugMode": true,
    "RequestTimeoutSeconds": 45,
    "Cache": {
      "ExpirationMinutes": 25,
      "EnableDistributedCache": true
    }
  },
  "ConnectionStrings": {
    "DefaultConnection": "Server=db.example.com;Database=AppDb;User Id=appuser;Password=apppass;"
  }
}

四、最佳实践与注意事项

1. 推荐做法

• 优先使用构造函数注入：符合依赖注入原则，便于单元测试和维护
• 采用强类型配置：通过IOptions<T>提升类型安全性和代码可读性
• 分离配置逻辑：避免在业务类中直接操作IConfiguration
• 设置默认值：对关键配置添加默认值，防止null引用异常

2. 高级技巧

• 环境特定配置：创建appsettings.Development.json和appsettings.Production.json，框架会自动合并
• 加密敏感配置：使用Microsoft.Extensions.Configuration.Encryption包加密API密钥等敏感信息
• 动态重新加载：通过reloadOnChange: true实现配置热更新（需配合文件监视）

3. 常见问题排查

通过以上步骤，你可以在C#类中安全、灵活地读取配置文件信息，实现配置与代码的解耦，提升应用的可维护性和可扩展性。