0

0

C# IConfiguration文件提供者 C#如何实现自定义的配置文件源

星降

星降

发布时间:2026-02-12 15:52:03

|

351人浏览过

|

来源于php中文网

原创

iconfigurationbuilder.addxxx()不直接接受自定义路径,因其内置方法依赖ifileprovider和fileconfigurationprovider,仅支持物理文件或嵌入资源;需自定义configurationprovider子类并重写load()方法,用冒号分隔的键存入idictionary,再通过扩展方法注册。

c# iconfiguration文件提供者 c#如何实现自定义的配置文件源

为什么 IConfigurationBuilder.AddXxx() 不直接接受自定义文件路径

因为 IConfigurationBuilder 的内置方法(如 AddJsonFile()AddXmlFile())底层依赖 IFileProviderFileConfigurationProvider,它们默认只处理物理文件系统或嵌入资源。若想加载非标准位置(如数据库、HTTP API、加密 ZIP 内的 config.json),不能靠改参数绕过,必须实现自己的 ConfigurationProvider 子类。

如何写一个最简可用的自定义 ConfigurationProvider

核心是继承 ConfigurationProvider 并重写 Load() 方法,把数据转成 IDictionary<string string></string> 格式(键用冒号分隔,如 "ConnectionStrings:Default")。

  • 不要在构造函数里加载数据,Load() 才是唯一被调用的入口
  • 务必调用 Data = new Dictionary<string string>(StringComparer.OrdinalIgnoreCase)</string> 初始化基类字段
  • 若需热重载(如监听文件变化),还需实现 IChangeToken 并重写 GetReloadToken()

示例:从字符串 JSON 加载

public class JsonStringConfigurationProvider : ConfigurationProvider
{
    private readonly string _json;

    public JsonStringConfigurationProvider(string json) => _json = json ?? throw new ArgumentNullException(nameof(json));

    public override void Load()
    {
        Data = JsonSerializer.Deserialize<Dictionary<string, string>>(_json)
               ?? new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
    }
}

怎样注册自定义 provider 到 IConfigurationBuilder

不能直接用 AddProvider() 传实例(会丢失生命周期管理),应封装为扩展方法,内部调用 builder.Add(new YourProvider())

Qoder
Qoder

阿里巴巴推出的AI编程工具

下载
  • 扩展方法签名必须是 this IConfigurationBuilder builder
  • 若 provider 依赖服务(如 HttpClient),需通过 builder.Services 注册,并在 provider 构造中接收 IOptionsMonitor<t></t>IServiceProvider
  • 注意加载顺序:自定义 provider 在 AddJsonFile() 后注册,其值会覆盖前面同名 key

示例注册方式:

public static class ConfigurationBuilderExtensions
{
    public static IConfigurationBuilder AddJsonString(this IConfigurationBuilder builder, string json)
    {
        return builder.Add(new JsonStringConfigurationProvider(json));
    }
}

// 使用
var config = new ConfigurationBuilder()
    .AddJsonString("{\"App:Version\":\"1.2.0\"}")
    .Build();

常见踩坑点:Key 命名与层级解析不一致

配置系统对 key 的解析规则和 JSON 对象结构不是 1:1 映射。例如 {"Logging": {"LogLevel": {"Default": "Information"}}} 会被展开为 Logging:LogLevel:Default = "Information",但如果你手动拼字典时用了 "Logging.LogLevel.Default"(点号而非冒号),就查不到。

  • 必须用英文冒号 : 分隔层级,不能用点、下划线或斜杠
  • 数组支持有限:JSON 中 ["a","b"] 会被转成 Array:0=aArray:1=b,但反向绑定到 List<string></string> 时可能失败,建议避免在自定义源中暴露数组结构
  • 空值处理:字典中存 null 值会导致 ConfigurationBinder 绑定失败,应存空字符串 "" 或跳过该 key

复杂嵌套或动态 schema 的场景,优先考虑用 IOptions<t></t> + 自定义 binder,而不是硬塞进 flat 字典。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

436

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

544

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

317

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

81

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

708

2023.08.02

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

243

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

705

2024.03.01

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

508

2023.08.03

2026春节习俗大全
2026春节习俗大全

本专题整合了2026春节习俗大全,阅读专题下面的文章了解更多详细内容。

189

2026.02.11

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
CSS教程
CSS教程

共754课时 | 30.6万人学习

【web前端】Node.js快速入门
【web前端】Node.js快速入门

共16课时 | 2万人学习

微信小程序开发之API篇
微信小程序开发之API篇

共15课时 | 1.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号