C#自定义配置提供程序详解（手把手教你实现和注册自定义配置源）

什么是配置提供程序？

在 .NET 中，配置提供程序（IConfigurationProvider）负责从特定数据源加载键值对，并将其提供给 IConfigurationBuilder。常见的如 JsonConfigurationProvider、EnvironmentVariablesConfigurationProvider 等。

要实现 自定义IConfigurationProvider，你需要：

1. 创建一个类实现 IConfigurationProvider 接口（通常继承 ConfigurationProvider 抽象类更简单）
2. 创建对应的 IConfigurationSource 实现
3. 通过扩展方法将你的配置源注册到 IConfigurationBuilder

第一步：实现 IConfigurationProvider

假设我们要从一个简单的内存字典中加载配置（实际项目中可能是数据库或 API）。我们先创建 MemoryConfigProvider：

using Microsoft.Extensions.Configuration;using System.Collections.Generic;public class MemoryConfigProvider : ConfigurationProvider{    private readonly IDictionary<string, string> _data;    public MemoryConfigProvider(IDictionary<string, string> data)    {        _data = data;    }    public override void Load()    {        Data = new Dictionary<string, string>(_data);    }}

这里我们重写了 Load() 方法，将传入的字典数据赋值给基类的 Data 属性（这是一个 IDictionary<string, string>），.NET 配置系统会自动读取它。

第二步：实现 IConfigurationSource

配置源的作用是“构建”配置提供程序实例。我们需要一个 MemoryConfigSource：

using Microsoft.Extensions.Configuration;using System.Collections.Generic;public class MemoryConfigSource : IConfigurationSource{    public IDictionary<string, string> InitialData { get; set; }    public IConfigurationProvider Build(IConfigurationBuilder builder)    {        return new MemoryConfigProvider(InitialData);    }}

第三步：添加扩展方法便于注册

为了让开发者能像使用内置配置一样方便地使用我们的自定义配置，我们提供一个扩展方法：

using Microsoft.Extensions.Configuration;using System.Collections.Generic;public static class MemoryConfigurationExtensions{    public static IConfigurationBuilder AddMemoryConfiguration(        this IConfigurationBuilder builder,        IDictionary<string, string> data)    {        builder.Add(new MemoryConfigSource { InitialData = data });        return builder;    }}

第四步：在 Program.cs 中注册使用

现在，我们可以在 ASP.NET Core 应用的 Program.cs 中轻松注册这个自定义配置源：

var memoryData = new Dictionary<string, string>{    { "CustomKey", "CustomValue" },    { "Database:ConnectionString", "Server=localhost;Database=MyApp;" }};var builder = WebApplication.CreateBuilder(args);// 注册自定义配置提供程序builder.Configuration.AddMemoryConfiguration(memoryData);var app = builder.Build();// 使用配置app.MapGet("/config", (IConfiguration config) =>{    return new    {        CustomKey = config["CustomKey"],        ConnectionString = config["Database:ConnectionString"]    };});app.Run();

运行后访问 /config，你将看到返回的 JSON 包含我们通过 自定义配置提供程序 注入的值。

为什么需要这样做？

通过实现 ASP.NET Core配置扩展，你可以：

• 从 Consul、ZooKeeper 等服务发现中心加载配置
• 从加密的配置文件中解密并加载敏感信息
• 动态从远程 REST API 拉取最新配置
• 统一管理微服务间的共享配置

总结

本文详细讲解了如何在 C# 中实现和注册一个 自定义IConfigurationProvider。通过三步走策略（实现 Provider → 实现 Source → 添加扩展方法），你可以轻松集成任何数据源作为应用的配置来源。这对于构建灵活、可维护的企业级应用至关重要。

记住，所有配置最终都会被转换为 Dictionary<string, string>，所以无论你的原始数据多么复杂，都要在 Load() 方法中完成解析和扁平化处理（例如使用冒号分隔嵌套结构："Database:Host"）。

掌握 C#自定义配置提供程序 的开发技巧，将大大提升你在 .NET 生态中的架构能力！