.NET Core-自定义配置数据源

简介: 前面,我们学习了配置框架的4种配置方式,那么你知道如何实现自定义的配置数据源吗?知道如何低成本实现定制化配置方案吗?下面我们就一起来学习一下吧。

核心扩展点

  • IConfigurationSource
  • IConfigurationProvider

我们之前提到过,配置框架的扩展点主要是依赖以上2个接口,下面我们分别来看一下接口的具体用法。


IConfigurationSource


 //
    // 摘要:
    //     Represents a source of configuration key/values for an application.
    public interface IConfigurationSource
    {
        //
        // 摘要:
        //     Builds the Microsoft.Extensions.Configuration.IConfigurationProvider for this
        //     source.
        //
        // 参数:
        //   builder:
        //     The Microsoft.Extensions.Configuration.IConfigurationBuilder.
        //
        // 返回结果:
        //     An Microsoft.Extensions.Configuration.IConfigurationProvider
        IConfigurationProvider Build(IConfigurationBuilder builder);
    }


从接口定义我们知道,该接口包含一个Build方法,入参是一个IConfigurationBuilder,返回一个IConfigurationProvider对象。


IConfigurationProvider


   //
    // 摘要:
    //     Provides configuration key/values for an application.
    public interface IConfigurationProvider
    {
        //
        // 摘要:
        //     Returns the immediate descendant configuration keys for a given parent path based
        //     on this Microsoft.Extensions.Configuration.IConfigurationProviders data and the
        //     set of keys returned by all the preceding Microsoft.Extensions.Configuration.IConfigurationProviders.
        //
        // 参数:
        //   earlierKeys:
        //     The child keys returned by the preceding providers for the same parent path.
        //
        //   parentPath:
        //     The parent path.
        //
        // 返回结果:
        //     The child keys.
        IEnumerable<string> GetChildKeys(IEnumerable<string> earlierKeys, string parentPath);
        //
        // 摘要:
        //     Returns a change token if this provider supports change tracking, null otherwise.
        //
        // 返回结果:
        //     The change token.
        IChangeToken GetReloadToken();
        //
        // 摘要:
        //     Loads configuration values from the source represented by this Microsoft.Extensions.Configuration.IConfigurationProvider.
        void Load();
        //
        // 摘要:
        //     Sets a configuration value for the specified key.
        //
        // 参数:
        //   key:
        //     The key.
        //
        //   value:
        //     The value.
        void Set(string key, string value);
        //
        // 摘要:
        //     Tries to get a configuration value for the specified key.
        //
        // 参数:
        //   key:
        //     The key.
        //
        //   value:
        //     The value.
        //
        // 返回结果:
        //     True if a value for the specified key was found, otherwise false.
        bool TryGet(string key, out string value);
}


从定义可以看出,该接口包含数个方法,其中包括获取配置变更的方法及配置加载的方法。其实,在Microsoft.Extensions.Configuration中有一个实现了该接口的抽象方法ConfigurationProvider类,我们一般都是继承该抽象类来实现我们自定义的配置提供程序,而不是直接实现IConfigurationProvider接口。


下面,我们通过代码来演示我们自定义的配置数据源。


首先,我们定义一个MyConfigurationProvider类,该类继承了抽象类ConfigurationProvider,并重写了Load方法用来加载配置数据源。我们在类中定义一个方法Load(bool reload),方法通过一个参数来确定是否重新加载数据源,以便我们通过一个定时任务来模拟配置的变更与重新加载,具体的代码如下所示


class MyConfigurationProvider : ConfigurationProvider
{
    Timer timer;
    public MyConfigurationProvider():base()
    {
        timer = new Timer() ;
        timer.Elapsed += Timer_Elapsed;
        timer.Interval = 3000;
        timer.Start();
    }
    private void Timer_Elapsed(object sender, ElapsedEventArgs e)
    {
        Load(true);
    }
    public override void Load()
    {
        Load(false);
    }
    private void Load(bool reload)
    {
        this.Data["time"] = System.DateTime.Now.ToString();
        if (reload)
        {
            base.OnReload();
        }
    }
}


这样,我们就可以在程序启动时,显示当前时间,并每3秒就重新加载时间到配置,并显示出来。


IConfigurationProvider定义好了之后,我们来创建IConfigurationSource对象来生成定义的MyConfigurationProvider。


class MyConfigurationSource : IConfigurationSource
{
    public IConfigurationProvider Build(IConfigurationBuilder builder)
    {
        return  new MyConfigurationProvider();
    }
}


这样,我们就可以在创建IConfigurationBuilder对象后,通过add方法来添加该数据源。


configurationBuilder.Add(new MyConfigurationSource());

  这样,当执行IConfigurationBuilder.Build方法时,就可将IConfigurationSource集合内的数据源全部生成到IConfigurationRoot配置根,以通过key-value方式来访问。


和之前一样,为了代码结构更加合理,以及实现封闭开放原则,我们对刚刚的add方法进行封装,以隐藏其具体实现,而只暴露操作接口


public static class MyConfigurationSourceExtension
{
    public static IConfigurationBuilder AddSource( this IConfigurationBuilder configurationBuilder)
    {
        MyConfigurationSource myConfigurationSource = new MyConfigurationSource();
        configurationBuilder.Add(myConfigurationSource);
        return configurationBuilder;
    }
}


这样,我们的调用将更加方便简洁


configurationBuilder.AddSource();


通过以上过程,我们完成了数据源的配置,但是,还没有实现对配置变更的监听,因此,我们还需要实现我们的ChangeToken.OnChange方法来监听我们的配置变更。那么,具体的program.cs代码如下


static void Main(string[] args)
{
    IConfigurationBuilder configurationBuilder = new ConfigurationBuilder();
    //configurationBuilder.Add(new MyConfigurationSource());
    configurationBuilder.AddSource();
    IConfigurationRoot configurationRoot= configurationBuilder.Build();
    ChangeToken.OnChange(()=> configurationRoot.GetReloadToken(), () =>
    {
        Console.WriteLine(configurationRoot["time"]);
    });
    Console.ReadKey();
}


好的,到这里我们本节的内容就结束了,我们本节主要通过配置框架的2个扩展点IConfigurationSource和IConfigurationProvider来实现自定义的配置数据源,这样,我们就可以低成本的实现我们自定义的配置方案。


对于这些基本的框架类东西,有时间的话还是动手敲一下,有助于加深理解,大佬就略过吧。


详细代码请参阅


https://github.com/IronMarmot/Samples/tree/master/CoreSamples


相关文章
|
18天前
|
数据可视化 网络协议 C#
C#/.NET/.NET Core优秀项目和框架2024年3月简报
公众号每月定期推广和分享的C#/.NET/.NET Core优秀项目和框架(每周至少会推荐两个优秀的项目和框架当然节假日除外),公众号推文中有项目和框架的介绍、功能特点、使用方式以及部分功能截图等(打不开或者打开GitHub很慢的同学可以优先查看公众号推文,文末一定会附带项目和框架源码地址)。注意:排名不分先后,都是十分优秀的开源项目和框架,每周定期更新分享(欢迎关注公众号:追逐时光者,第一时间获取每周精选分享资讯🔔)。
|
3月前
|
开发框架 前端开发 JavaScript
盘点72个ASP.NET Core源码Net爱好者不容错过
盘点72个ASP.NET Core源码Net爱好者不容错过
72 0
|
3月前
|
开发框架 .NET
ASP.NET Core NET7 增加session的方法
ASP.NET Core NET7 增加session的方法
37 0
|
3月前
|
开发框架 JavaScript .NET
ASP.NET Core的超级大BUG
ASP.NET Core的超级大BUG
43 0
|
1月前
|
开发框架 人工智能 .NET
C#/.NET/.NET Core拾遗补漏合集(持续更新)
C#/.NET/.NET Core拾遗补漏合集(持续更新)
|
1月前
|
开发框架 中间件 .NET
C# .NET面试系列七:ASP.NET Core
## 第一部分:ASP.NET Core #### 1. 如何在 controller 中注入 service? 在.NET中,在ASP.NET Core应用程序中的Controller中注入服务通常使用<u>依赖注入(Dependency Injection)</u>来实现。以下是一些步骤,说明如何在Controller中注入服务: 1、创建服务 首先,确保你已经在应用程序中注册了服务。这通常在Startup.cs文件的ConfigureServices方法中完成。例如: ```c# services.AddScoped<IMyService, MyService>(); //
65 0
|
2月前
|
开发框架 前端开发 .NET
福利来袭,.NET Core开发5大案例,30w字PDF文档大放送!!!
为了便于大家查找,特将之前开发的.Net Core相关的五大案例整理成文,共计440页,32w字,免费提供给大家,文章底部有PDF下载链接。
36 1
福利来袭,.NET Core开发5大案例,30w字PDF文档大放送!!!
|
2月前
|
算法 BI API
C#/.NET/.NET Core优秀项目和框架2024年1月简报
C#/.NET/.NET Core优秀项目和框架2024年1月简报
|
3月前
|
IDE 前端开发 JavaScript
【C#】C# 开发环境配置(Rider 一个.NET 跨平台集成开发环境)
【1月更文挑战第26天】【C#】C# 开发环境配置(Rider 一个.NET 跨平台集成开发环境)
|
3月前
|
算法 C#
C# .Net Core bytes转换为GB/MB/KB 算法
C# .Net Core bytes转换为GB/MB/KB 算法
42 0