.NET Core采用的全新配置系统[10]: 配置的同步机制是如何实现的？

配置的同步涉及到两个方面：第一，对原始的配置文件实施监控并在其发生变化之后从新加载配置；第二，配置重新加载之后及时通知应用程序进而使后者能够使用最新的配置。要了解配置同步机制的实现原理，先得从认识一个名为ConfigurationReloadToken的类型开始。 [ 本文已经同步到《ASP.NET Core框架揭秘》之中]

目录
一、从ConfigurationReloadToken说起
二、Configuration对象与配置文件的同步
三、应用重新加载的配置
四、同步流程总结

一、从ConfigurationReloadToken说起

.NET Core绝大部分的数据同步场景下都使用到一个名为ChangeToken的对象，该对象绑定到某个需要被监控的对象，并该对象发生改变是对外发送通知，我们可以注册在被监控数据发生改变时可以自动执行的回调。在配置同步场景中，ConfigurationProvider会利用FileProvider监控配置文件的变化，并在变化时从新加载配置。ConfigurationReloadToken就是一个通知配置已经被重新加载的ChangeToken。

ConfigurationReloadToken本质上是对一个CancellationTokenSource对象的封装。如果我们对.NET基于Task对象的并行/异步编程有所了解的话，相信对CancellationTokenSource应该不会感到模式。总的来说，我们可以利用CancellationTokenSource创建的CancellationToken向某个异步执行的Task发送“取消任务”的信号。如下面的代码片段所示，ConfigurationReloadToken的HasChanged属性对应的是这个CancellationTokenSource对象的IsCancellationRequested。通过调用RegisterChangeCallback方法注册的回调实际上是注册到 CancellationTokenSource创建的CancellationToken对象上。

public class ConfigurationReloadToken : IChangeToken
{
    private CancellationTokenSource _cts = new CancellationTokenSource();

    public void OnReload()
    {
        _cts.Cancel();
    }

    public IDisposable RegisterChangeCallback(Action<object> callback, object state)
    {
        return _cts.Token.Register(callback, state);
    }

    public bool ActiveChangeCallbacks
    {
        get { return true; }
    }

    public bool HasChanged
    {
        get { return _cts.IsCancellationRequested; }
    }
}

当ConfigurationReloadToken的OnReload方法被执行的时候，这被封装的CancellationTokenSource对象的Cancel方法随之被调用。我们知道一旦这个Cancel方法被调用之后，CancellationTokenSource的IsCancellationRequested会马上变成True，意味着ConfigurationReloadToken的HasChanged属性也立即变成True。由于调用RegisterChangeCallback方法注册的回调最是注册到CancellationTokenSource创建的CancellationToken上的，所以该回调会在OnLoad方法被调用之后自动执行。

二、Configuration对象与配置文件的同步

在《聊聊默认支持的各种配置源》和《深入了解三种针对文件（JSON、XML与INI）的配置源》中，我们介绍了系统预定义的若干配置源，它们都通过相应的ConfigurationSource类型来表示，对于这些ConfigurationSource来说，只有针对配置文件的FileConfigurationSource才会涉及到配置同步的问题。其实这一点也可以由它们的定义看出来，因为只有FileConfigurationSource这个抽象类才定义了如下这个ReloadOnChange属性来控制当配置文件改变之后是否需要重新加载配置。换句话说，配置的同步首先需要解决的是由ConfigurationBuilder创建的Configuration对象与原始配置文件的内容同步的问题，而解决这个问题的途径就是对配置实施监控，并在文件发生改变之后自动重新加载配置。

public abstract class FileConfigurationSource : IConfigurationSource
{
    ...
    public bool ReloadOnChange { get; set; }
}

我们知道 FileConfigurationProvdier总是利用一个FileProvider对象来读取对应的配置文件，除了读取文件内容之外，FileProvider的Watch方法自身就提供了文件监控的能力。FileConfigurationProvdier利用FileProvider监控配置文件，并在配置文件发生改变时自动加载配置的操作实现在如下所示的代码片段中。

public abstract class FileConfigurationProvider : ConfigurationProvider
{
    ...
    public FileConfigurationProvider(FileConfigurationSource source)
    {
        this.Source = source;
        if (source.ReloadOnChange && (this.Source.FileProvider != null))
        {
            ChangeToken.OnChange(() => source.FileProvider.Watch(source.Path), this.Load);
        }
    }
}

三、应用重新加载的配置

Configuration对象与配置文件的同步问题解决之后，还需要让应用程序感知到使用的Configuration对象已经发生改变，并且使之能够将新的配置应用到程序之中。从编程的角度来讲，这个问题很容易解决，我们只需要调用Configuration对象的GetReloadToeken方法得到一个ChangeToken对象，并将重新应用配置的操作注册作为回调注册到这个ChangeToken上面就可以了。

public interface IConfiguration
{
    ...
    IChangeToken GetReloadToken();
}

程序应用重新配置的回调是注册到Configuration对象的GetReloadToken方法返回的ChangeToken对象上，而Configuration对象的重新加载最终是通过调用所有ConfigurationProvider的Load方法来实现的，所以两者之间必然存在着某种联系。说的具体一点，应用程序可以通过这个ChangeToken感知到配置系统针对ConfigurationProvider的Load方法的调用。要了解两者之间的联系，我们必须先弄清楚Configuration的 GetReloadToken方法返回的是怎样一个ChangeToken对象。

一个Configuration对象代表配置树的某个节点，对于组成同一棵配置树的所有Configuration对象来说，它们的GetReloadToken方法返回的ChangeToken都来源于代表根节点的ConfigurationRoot对象。说的更加具体一点，当我们调用它们的GetReloadToken的时候，返回的其实是调用ConfigurationRoot的同名方法的返回值，那么我们有必要了解一下ConfigurationRoot的GetReloadToken方法的逻辑。

public class ConfigurationRoot : IConfigurationRoot
{
    private ConfigurationReloadToken _changeToken = new ConfigurationReloadToken();
    private IList<IConfigurationProvider> _providers;

    public ConfigurationRoot(IList<IConfigurationProvider> providers)
    {
        _providers = providers;

        foreach (var provider in providers)
        {
            provider.Load();
            ChangeToken.OnChange(() => provider.GetReloadToken(), this.RaiseChanged);
        }
    }

    public IChangeToken GetReloadToken()
    {
        return _changeToken;
    }

    private void RaiseChanged()
    {
        Interlocked.Exchange<ConfigurationReloadToken>(ref _changeToken, new ConfigurationReloadToken()).OnReload();
    }

    public void Reload()
    {
        foreach (var provider in _providers)
        {
            provider.Load();
        }
        this.RaiseChanged();
    }
}

如上面的代码片段所示，ConfigurationRoot的GetReloadToken方法返回的是通过字段_changeToken表示的一个ConfigurationReloadToken对象。私有方法RaiseChanged通过调用ConfigurationReloadToken对象的OnReload向订阅者发送配置重新被加载的通知，由于ChangeToken只能使用一次，所以该方法总是为_changeToken字段附上一个新的ConfigurationReloadToken对象。

针对这个RaiseChanged方法的调用发生在两个地方，第一个地方发生在ConfigurationRoot的Reload方法上，也就是说当我们调用该方法以手工的方式重新加载配置的时候，注册到Configuration对象提供的ChangeToken上的回调也会自动执行。

针对RaiseChanged方法的调用还出现在ConfigurationRoot构造函数中。如上面的代码片段所示，ConfigurationRoot会调用每个ConfigurationProvdier的GetReloadToken方法，并将针对RaiseChanged方法的调用作为回调注册到返回的ChangeToken上，也就是说注册到Configuration对象提供的ChangeToken上的回调实际上注册到ConfigurationProvider提供的ChangeToken上。既然如此，如果 ConfigurationProvider提供的这个ChangeToken能够反映针对Load方法的调用，那么上面提到的关于Configuration提供的ChangeToken与ConfigurationProvider的Load方法之间的联系就建立起来了。那么ConfigurationProvider的Load方法与ChangeToken方法返回的ChangeToken究竟有没有关系呢？

public abstract class ConfigurationProvider : IConfigurationProvider
{
    private ConfigurationReloadToken _reloadToken = new ConfigurationReloadToken();

    public IChangeToken GetReloadToken()
    {
        return_reloadToken;
    }

    protected void OnReload()
    {
        Interlocked.Exchange<ConfigurationReloadToken>(ref_reloadToken, new ConfigurationReloadToken()).OnReload();
    }
}

如上面的代码片段所示，抽象类ConfigurationProvider的GetRealoadToken方法返回的是一个通过字段_reloadToken表示的ConfigurationReloadToken对象。该类型还定义了一个受保护的OnReload方法，该方法具有与上面介绍的RaiseChanged方法一样的逻辑，意味着ConfigurationProvider实际上是调用这个方法对外发送配置被重新加载的通知。针对这个OnLoad方法的调用发生在FileConfigurationProvider的Load方法中。所以上面提到的让ConfigurationProvider提供的ChangeToken能够反映针对Load方法的调用最终实现在FileConfigurationProvider中。

public abstract class FileConfigurationProvider : ConfigurationProvider
{
    ...
    public override void Load()
    {
        ...
        base.OnReload();
    }
}

四、同步流程总结

上面我们通过代码分析的方式捋清了配置文件在发生改变的时候为什么会导致配置的重新加载，注册到Configuration通过GetRealoadToken方法提供的ChangeToken上的回调为什么会自动执行。可能都有读者的脑子里面还是比较晕，所以我们利用如下所示的序列图继续对这个过程进行讲解。用于读取配置文件内容的FileConfigurationProvder会调用FileProvder的Watch方法来监控文件的变化（实际上真正用于文件监控的实PhysicalFileProvider所示用的FileSystemWatcher），并且通过向返回的ChangeToken注册回调的方式来调用自身的Load方法来实现配置配置的重新加载。

 

当Load方法执行的时候，它会在配置加载完成之后调用调用Reload方法，后者利用一个ConfigurationReloadToken对象对外发出配置被重新加载的通知，最终会触发注册到Configuration对象上的回调的执行。注册到Configuration对象上的回调出了可以在配置被改动的时候自动触发之外，我们还可以直接调用ConfigurationRoot的Reload方法来触发它。

---

.NET Core采用的全新配置系统[1]: 读取配置数据
.NET Core采用的全新配置系统[2]: 配置模型设计详解
.NET Core采用的全新配置系统[3]: Options模式”下的配置是如何绑定为Options对象
.NET Core采用的全新配置系统[4]: Options模式”下各种类型的Options对象是如何绑定的？
.NET Core采用的全新配置系统[5]: 聊聊默认支持的各种配置源[内存变量,环境变量和命令行参数]
.NET Core采用的全新配置系统[6]: 深入了解三种针对文件（JSON、XML与INI）的配置源
.NET Core采用的全新配置系统[7]: 将配置保存在数据库中
.NET Core采用的全新配置系统[8]: 如何实现配置与源文件的同步
.NET Core采用的全新配置系统[9]: 为什么针对XML的支持不够好？如何改进？
.NET Core采用的全新配置系统[10]: 配置的同步机制是如何实现的？