ASP.NET Core的配置（5）：配置的同步[ 实例篇]

2022-06-08 13:58:36

ConfigurationBuilder在生成以Configuration对象的时候会利用注册其中的ConfigurationProvider加载原始的配置数据，那么一旦配置源中的数据发生变化，应用程序中的使用的配置信息如何与之同步呢？如果需要在应用程序中实现对配置信息的实施同步，就需要对原始配置数据的进行监控，并在数据改变的时候重新加载配置数据。除此之外，重新加载的配置需要应用到程序中，我们必然需要一种通知机制。

为了让读者朋友们对配置同步机制在具体项目中的应用有个感官认识，我们先通过一个简单的实例来演示如何实现配置数据的实时同步。我们采用一个INI文件作为配置源，通过实施监控这个文件第一时间感知到文件内容的变换。一旦原始配置文件的内容发生改变，应用程序将重新加载配置，并通过注册的回掉操作应用新的配置。

我们先创建一个ASP.NET Core控制台应用并在project .json文件中添加相应的依赖。由于对原始配置文件的变换的监控相关的API实现在“Microsoft.Extensions.Configuration.FileProviderExtensions”这个NuGet包中，我们需要按照如下方式添加针对它的依赖。

   1: {

   2:   ...

3:

   4:   "dependencies": {

   5:     "Microsoft.Extensions.Configuration.Ini"                       : "1.0.0-rc1-final",

   6:     "Microsoft.Extensions.Configuration.Binder"                    : "1.0.0-rc1-final",

   7:     "Microsoft.Extensions.Configuration.FileProviderExtensions"    : "1.0.0-rc1-final"

   8:   },

   9: }

假设我们需要通过配置来当前应用使用的线程池的容量，这样的设置需要根据当前的负载进行调整，所以需要很高的时效性，我们希望一旦修改了INI文件的配置，应用程序中针对线程池的相关设置可以立即生效。简单起见，我们仅仅定义MinThreads 和MaxThreads这两个分别决定线程池容量区间的配置项，如下所示的ThreadPoolSettings 是对应的Options类型。

   1: public class ThreadPoolSettings

   2: {

   3:     public int MinThreads { get; set; }

   4:     public int MaxThreads { get; set; }

   5:     public override string ToString()

   6:     {

   7:         return string.Format("Thread pool size: [{0}, {1}]", this.MinThreads, this.MaxThreads);

   8:     }

   9: }

我们在作为应用入口的Main方法中编写了如下一段程序。我们按照我们熟悉的方式将Settinigs .ini 文件作为配置源生成了一个ConfigurationRoot对象，然后将这个INI文件的路径作为参数调用它的扩展方法ReloadOnChanged方法。顾名思义，当这个ReloadOnChanged方法执行之后，系统会监控指定物理文件的变换并在发生变化后调用ConfigurationRoot的Reload方法重新加载配置。

   1: public class Program

   2: {

   3:     private static IDisposable callbackRegistration;

4:

   5:     public static void Main(string[] args)

   6:     {

   7:         IConfigurationRoot configuration = new ConfigurationBuilder()

   8:             .AddIniFile("Settings.ini")

   9:             .Build()

  10:             .ReloadOnChanged("Settings.ini");

11:

  12:         callbackRegistration = configuration.GetReloadToken().RegisterChangeCallback(OnSettingChanged, configuration);

13:

  14:         Console.Read();

  15:     }

16:

  17:     private static void OnSettingChanged(object state)

  18:     {

  19:         callbackRegistration?.Dispose();

  20:         IConfiguration configuration = (IConfiguration)state;

  21:         Console.WriteLine(configuration.Get<ThreadPoolSettings>());

  22:         callbackRegistration = configuration.GetReloadToken().RegisterChangeCallback(OnSettingChanged, state);

  23:     }

  24: }

ConfigurationRoot的扩展方法 ReloadOnChanged实现了自身承载的配置与原始配置数据的同步，但是如何使用重新加载配置呢？这就要使用到我们在前面一直刻意忽略的一个名为ChangeToken的对象，而IConfiguration接口的GetReloadToken方法返回的就是这么一个对象。如上面的代码片段所示，我们调用ConfigurationRoot的GetReloadToken方法得到这个ChangeToken对象，并调用ChangeToken的RegisterChangeCallback方法注册一个在ConfigurationRoot重新加载时会自动执行的回掉操作。

注册的回掉操作实现在OnSettingsChanged方法中，方法的参数是在调用RegisterChangeCallback方法是指定的ConfigurationRoot对象，我们在该方法中将它承载的配置绑定为ThreadPoolSettings对象并将相关的信息打印在控制台上。由于ConfigurationRoot每次重新加载的时候都会生成新的ChangeToken，所以我们在OnSettingsChanged方法中重复地调用RegisterChangeCallback方法进行回掉注册。现在我们直接运行这段程序，然后认为地修改存储原始配置数据的INI文件。如上图所示，当每次我们修改这个INI文件的时候，应用程序的配置将实时地与之同步。

作者：蒋金楠
微信公众账号：大内老A
微博：www.weibo.com/artech
如果你想及时得到个人撰写文章以及著作的消息推送，或者想看看个人推荐的技术资料，可以扫描左边二维码（或者长按识别二维码）关注个人公众号（原来公众帐号蒋金楠的自媒体将会停用）。
本文版权归作者和博客园共有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。

原文链接

码农公寓

相关文章