C#配置提供程序开发指南（手把手教你实现自定义配置提供程序）

什么是配置提供程序？

在 .NET 中，配置提供程序（Configuration Provider）是实现 IConfigurationProvider 接口的类，负责从特定数据源加载配置键值对，并将其注入到应用程序的配置系统中。

常见的内置提供程序包括：

• JsonConfigurationProvider：从 JSON 文件读取配置
• EnvironmentVariablesConfigurationProvider：从环境变量读取
• CommandLineConfigurationProvider：从命令行参数读取

为什么需要自定义配置提供程序？

当你需要从以下来源加载配置时，可能就需要自定义提供程序：

• 数据库（如 SQL Server、MySQL）
• 远程 API 或 Web 服务
• 加密的配置文件
• 自定义格式的配置源（如 XML、YAML、INI 等）

实战：创建一个简单的自定义配置提供程序

我们将创建一个从内存字典（模拟数据库或远程服务）加载配置的提供程序。这个例子虽简单，但能清晰展示整个开发流程。

步骤 1：创建配置源（ConfigurationSource）

首先，我们需要实现 IConfigurationSource 接口：

public class MemoryConfigurationSource : IConfigurationSource{    public IDictionary<string, string> InitialData { get; set; }    public IConfigurationProvider Build(IConfigurationBuilder builder)    {        return new MemoryConfigurationProvider(this);    }}

步骤 2：创建配置提供程序（ConfigurationProvider）

接下来，实现 ConfigurationProvider 抽象类（它已实现 IConfigurationProvider）：

public class MemoryConfigurationProvider : ConfigurationProvider{    private readonly MemoryConfigurationSource _source;    public MemoryConfigurationProvider(MemoryConfigurationSource source)    {        _source = source;    }    public override void Load()    {        if (_source.InitialData != null)        {            Data = new Dictionary<string, string>(_source.InitialData, StringComparer.OrdinalIgnoreCase);        }    }}

步骤 3：添加扩展方法（可选但推荐）

为了让使用更方便，我们可以为 IConfigurationBuilder 添加扩展方法：

public static class MemoryConfigurationExtensions{    public static IConfigurationBuilder AddMemoryConfiguration(        this IConfigurationBuilder builder,        IDictionary<string, string> initialData)    {        return builder.Add(new MemoryConfigurationSource        {            InitialData = initialData        });    }}

步骤 4：在 Program.cs 中使用

现在，我们可以在应用程序启动时注册这个自定义提供程序：

var memoryData = new Dictionary<string, string>{    { "AppSettings:Title", "My Custom App" },    { "AppSettings:Version", "1.0.0" },    { "ConnectionStrings:Default", "Server=localhost;Database=Test;" }};var builder = WebApplication.CreateBuilder(args);// 添加自定义配置提供程序builder.Configuration.AddMemoryConfiguration(memoryData);var app = builder.Build();// 使用配置var title = app.Configuration["AppSettings:Title"];Console.WriteLine($"应用标题: {title}"); // 输出: 应用标题: My Custom App

进阶提示：支持热更新

如果你的配置源支持动态变化（如数据库内容更新），你可以在 MemoryConfigurationProvider 中重写 TryGet 方法，或使用 OnChange 事件触发 OnReload() 来通知系统重新加载配置。

总结

通过本教程，你已经掌握了如何开发一个 .NET Core配置扩展。无论是从数据库、API 还是其他特殊格式加载配置，核心思路都是一致的：实现 IConfigurationSource 和 IConfigurationProvider，然后注册到配置系统中。

记住，良好的 配置管理C# 实践不仅能提升代码可维护性，还能增强应用的灵活性和安全性。希望这篇教程能帮助你在实际项目中灵活运用 自定义配置提供程序！

如有疑问，欢迎在评论区交流！