.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


相关文章
|
7天前
|
开发框架 .NET 开发者
简化 ASP.NET Core 依赖注入(DI)注册-Scrutor
Scrutor 是一个简化 ASP.NET Core 应用程序中依赖注入(DI)注册过程的开源库,支持自动扫描和注册服务。通过简单的配置,开发者可以轻松地从指定程序集中筛选、注册服务,并设置其生命周期,同时支持服务装饰等高级功能。适用于大型项目,提高代码的可维护性和简洁性。仓库地址:&lt;https://github.com/khellang/Scrutor&gt;
26 5
|
2月前
|
存储 开发框架 JSON
ASP.NET Core OData 9 正式发布
【10月更文挑战第8天】Microsoft 在 2024 年 8 月 30 日宣布推出 ASP.NET Core OData 9,此版本与 .NET 8 的 OData 库保持一致,改进了数据编码以符合 OData 规范,并放弃了对旧版 .NET Framework 的支持,仅支持 .NET 8 及更高版本。新版本引入了更快的 JSON 编写器 `System.Text.UTF8JsonWriter`,优化了内存使用和序列化速度。
|
25天前
|
开发框架 .NET C#
在 ASP.NET Core 中创建 gRPC 客户端和服务器
本文介绍了如何使用 gRPC 框架搭建一个简单的“Hello World”示例。首先创建了一个名为 GrpcDemo 的解决方案,其中包含一个 gRPC 服务端项目 GrpcServer 和一个客户端项目 GrpcClient。服务端通过定义 `greeter.proto` 文件中的服务和消息类型,实现了一个简单的问候服务 `GreeterService`。客户端则通过 gRPC 客户端库连接到服务端并调用其 `SayHello` 方法,展示了 gRPC 在 C# 中的基本使用方法。
38 5
在 ASP.NET Core 中创建 gRPC 客户端和服务器
|
15天前
|
开发框架 缓存 .NET
GraphQL 与 ASP.NET Core 集成:从入门到精通
本文详细介绍了如何在ASP.NET Core中集成GraphQL,包括安装必要的NuGet包、创建GraphQL Schema、配置GraphQL服务等步骤。同时,文章还探讨了常见问题及其解决方法,如处理复杂查询、错误处理、性能优化和实现认证授权等,旨在帮助开发者构建灵活且高效的API。
24 3
|
3月前
|
开发框架 监控 前端开发
在 ASP.NET Core Web API 中使用操作筛选器统一处理通用操作
【9月更文挑战第27天】操作筛选器是ASP.NET Core MVC和Web API中的一种过滤器,可在操作方法执行前后运行代码,适用于日志记录、性能监控和验证等场景。通过实现`IActionFilter`接口的`OnActionExecuting`和`OnActionExecuted`方法,可以统一处理日志、验证及异常。创建并注册自定义筛选器类,能提升代码的可维护性和复用性。
|
3月前
|
开发框架 .NET 中间件
ASP.NET Core Web 开发浅谈
本文介绍ASP.NET Core,一个轻量级、开源的跨平台框架,专为构建高性能Web应用设计。通过简单步骤,你将学会创建首个Web应用。文章还深入探讨了路由配置、依赖注入及安全性配置等常见问题,并提供了实用示例代码以助于理解与避免错误,帮助开发者更好地掌握ASP.NET Core的核心概念。
111 3
|
2月前
|
Windows
.NET 隐藏/自定义windows系统光标
【10月更文挑战第20天】在.NET中,可以使用`Cursor`类来控制光标。要隐藏光标,可将光标设置为`Cursors.None`。此外,还可以通过从文件或资源加载自定义光标来更改光标的样式。例如,在表单加载时设置`this.Cursor = Cursors.None`隐藏光标,或使用`Cursor.FromFile`方法加载自定义光标文件,也可以将光标文件添加到项目资源中并通过资源管理器加载。这些方法适用于整个表单或特定控件。
|
2月前
|
开发框架 JavaScript 前端开发
一个适用于 ASP.NET Core 的轻量级插件框架
一个适用于 ASP.NET Core 的轻量级插件框架
|
3月前
|
开发框架 前端开发 JavaScript
ASP.NET MVC 教程
ASP.NET 是一个使用 HTML、CSS、JavaScript 和服务器脚本创建网页和网站的开发框架。
46 7
|
3月前
|
存储 开发框架 前端开发
ASP.NET MVC 迅速集成 SignalR
ASP.NET MVC 迅速集成 SignalR
75 0