【5min+】 一個令牌走天下！.Net Core中的ChangeToken

系列介紹

【五分鐘的dotnet】是一個利用您的碎片化時間來學習和豐富.net知識的博文系列，它所包含了.net體系中可能會涉及到的方方面面，比如C#的小細節，AspnetCore，微服務中的.net知識等等，
5min+不是超過5分鐘的意思，"+"是知識的增加，so，它是讓您花費5分鐘以下的時間來提升您的知識儲備量，

正文

前段時間在閱讀AspNet Core的源代碼中，發現了一個叫做ChangeToken的靜態類，它的使用大概是這個樣子：

public ActionDescriptorCollectionProvider(
            IEnumerable<IActionDescriptorProvider> actionDescriptorProviders,
            IEnumerable<IActionDescriptorChangeProvider> actionDescriptorChangeProviders)
{
    _actionDescriptorProviders = actionDescriptorProviders
        .OrderBy(p => p.Order)
        .ToArray();

    _actionDescriptorChangeProviders = actionDescriptorChangeProviders.ToArray();

    //here!!
    ChangeToken.OnChange(
        GetCompositeChangeToken,
        UpdateCollection);
}  

回想起來，這個東西我好像已經不止看到它一次兩次了，在Microsoft.Extensions.FileProviders包里面也有發現它的身影，迷惑了很久之后，今天總算可以找個機會來扒一扒它，看看它到底是一個什么東西，

其實，ChangeToken在微軟官方的AspNet Core教程檔案中是有專門介紹它的文章：《使用 ASP.NET Core 中的更改令牌檢測更改》，但是該篇文章我個人覺得有點偏重于講使用，而對原理比較淡化，這怎么能滿足得了我們程式員的探索欲??，肯定要再百度一波呀，然后……………… 又是只有一篇文章，還是出自于咱們園子，（手動博客園牛逼！）

觀察者？

其實，從MSDN里面的第一句描述以及這個類的命名，咱們還是可以讀懂它的大致意思的，這不就是一個像觀察者模式的東西嗎？ 當某某某發生變化的時候，就執行一個某某操作，

那么直接用委托訂閱不行？咱們先來想一想使用傳統的委托來進行操作是什么樣子的？

Action myAction = () => { Console.WriteLine("人來了！"); };
myAction += () => { Console.WriteLine("狗要叫！"); };
myAction += () => { Console.WriteLine("貓要叫！"); };

類似于醬紫哈，當觀察到人來了的時候，貓狗就都會叫起來，

但是這樣寫您會發現，其實上面demo中的三個事物（人、貓、狗）關聯十分的密切，換成代碼來理解的話，可能后期咱們會建立三個類，而他們之間的互動都是直接參考來實作的，如果型別較多，簡直會演變為一個噩夢，

那么有沒有好的辦法呢？ 那肯定是有的呀，

公認即合理？

我一直覺得所有的代碼都能用咱們身邊的小事來解釋，所以，我又來講故事了??，

先來回憶一下30年前，咱們人與人之間是怎么聯系的，額…………好像確實很難聯系上，因為當時交通和通訊工具都不發達，人們要交流只能通過見面，所以，當我想告訴某件事情給某人的時候，我必須親自跑到他的家里，直到見到他本人或者與他的家人才能夠完成，當然，還有一個好一點的辦法就是托另外的一個人帶個口信過去，但是這也必須要求我得見到這個中間人，還要信得過他，

在那個“通訊基本靠吼; 交通基本靠走; 治安基本靠狗”的年代，聲音大好像還是有好處嘛，

那么現在我們怎么聯系呢？ 我默默的從兜里摸出了波導手機（波導手機，手機中的戰斗機，哦也），這個社會，誰還沒有一個手機呀，就算沒有手機說不定也有電話手表，??

OK，回到上面的問題，您有沒有一點靈感， 當一個類完成某個操作之后，下一個類就需要做出反應，剛開始，咱們可能是直接在A類里面顯式的呼叫B類（只能親自跑到他家去），后來，我們可以選擇一個委托（找一個中間人帶口信，或者郵遞員等），而現在，我們可以選一個“手機”來實作了，

那么這個“手機”在代碼里面是一個什么呢？ 所有需要保持聯系的人都得擁有它，只要“手機”在線就能進行通訊，而且所有人都拿著“手機”大家都不會覺得很奇怪？ CancellationTokenSource，像不像它，您是否在專案的大部分類里面都引入了它，并且沒有感到任何一點的奇怪，

所以，當大家都認可這種類似于TokenSource的東西之后，就覺得很正常，雖然咱們每次使用 CancellationTokenSource都要引入System.Threading命名空間，

CancellationTokenSource

來看看使用CancellationTokenSource來觸發一個觀察動作：

var cancellationTokenSource = new CancellationTokenSource();

cancellationTokenSource.Token.Register(() =>
{
    Console.WriteLine($"{nameof(cancellationTokenSource)} 改變，觸發了回呼");
});

cancellationTokenSource.Cancel();

是不是很簡單，咱們只需要在需要的類里面引入CancellationTokenSource就可以注冊自己的回呼方法，當它取消的時候就會執行回應的操作，加上CancellationTokenSource本身的執行緒安全，所以它從一提出來就被廣泛的應用于異步編程，

可能到這里您會問，這個和咱們今天提到的ChangeToken有半毛錢關系嗎？ 別急，咱們慢慢來細看一下今天的主角：

public static class ChangeToken
{
    public static IDisposable OnChange(Func<IChangeToken> changeTokenProducer, Action changeTokenConsumer);
}

該類僅僅提供了一個OnChange的靜態方法，而該方法需要一個回傳型別為IChangeToken的引數，而一看這個命名**Token，是不是很像咱們上面的CancellationToken，也就是說它可能就是一個咱們公認的類似于“手機”一樣的東西，擁有了它，就會得到通知， 是的，就是這個樣子，這種東西官方的名稱其實叫做“令牌”，所以，您可能都會猜到，它可能會具有一個注冊回呼的方法：

public interface IChangeToken
{
    bool HasChanged { get; }
    bool ActiveChangeCallbacks { get; }

    IDisposable RegisterChangeCallback(Action<object> callback, object state);
}

看起來好像很符合咱們的猜想嘛，那么，它存在的意義是什么呢？ 高層的抽象！ 就好像我們剛才所說的“手機”，手機是抽象的概念，而“OPPO手機”、“華為手機”、還有我的“波導手機”都是它的具體實作，我們在不同的圈子可能會使用不同的手機，

比如下方的代碼：

Console.WriteLine("開始監測檔案夾 c:\\temp");

var phyFileProvider = new PhysicalFileProvider("c:\\temp");
IChangeToken changeToken = phyFileProvider.Watch("*.*");
changeToken.RegisterChangeCallback(_ =>
{
    Console.WriteLine("檢測到檔案夾有變化!" + _);
}, "xiaoming");

Console.ReadLine();

code參考自：jackletter的博客

像不像一個叫做PhysicalFileProvider的運營商，給我發了一個“手機”（令牌），當我擁有這個令牌之后，運營商就可以聯系到我了，當它聯系我的時候，我就可以做出對應的反應，比如上面是列印一排字出來，

而在“物理檔案”這個圈子里面，IChangeToken的真身叫做PollingFileChangeToken;在“配置系統”這個圈子里面，IChangeToken的真身叫做ConfigurationReloadToken，

如果咱們想實作自己的IChangeToken怎么辦呢？還記得最上面的CancellationTokenSource嗎？既然.Net為咱們提供了一個執行緒安全而又直接可以拿來用的工具，那我們就不用客氣了：

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

    public bool ActiveChangeCallbacks => true;

    public bool HasChanged => _cts.IsCancellationRequested;

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

    public void MyOwnChange() => _cts.Cancel();
}

在“我自己的這個圈子”，就可以使用MyOwnChangeToken了，當外界獲取到我的IChangeToken，我就可以觸發MyOwnChange來通知他們了，

其實.NET Core中大部分的IChangeToken內部都使用了CancellationTokenSource，

搞懂了IChangeToken我們就很輕松就能理解了ChangeToken，作為靜態類的它，肯定是作為一個工具類的實作，

說白了我們直接使用靜態方法就可以完成訂閱了：

 ChangeToken.OnChange(
    () => physicalFileProvider.Watch("*.*"),
    () => Console.WriteLine("檢測到檔案夾有變化!")
);

那么您可能會說，我直接使用上文那個RegisterChangeCallback方法訂閱不行嗎？他們有什么區別嗎？ 答案是：“呼叫次數”，使用RegisterChangeCallback的方法，只會執行一次回呼內容，因為當“令牌”用了一次之后，其實它就失效了，所以上面那個監控檔案改動的代碼，當第二次檔案改動的時候，它其實是不會再執行回呼的，

而使用ChangeToken這個靜態類，它就可以幫助您不斷的去獲取新“令牌”然后注冊對應的回呼，所以就能夠保證咱們多次改變也能觸發回呼了，

所以來看上面的這一段代碼 ChangeToken.OnChange(() => physicalFileProvider.Watch("*.*"),...)，“phyFileProvider”這個“供應商”可以為我們提供“令牌”，當該令牌發生改動的時候，我們就有機會去完成操作了，() => physicalFileProvider.Watch("*.*")這部分代碼我們可以稱它為“令牌生產程序”，而() => Console.WriteLine("檢測到檔案夾有變化!")叫做“令牌的消費程序”，ChangeToken 干的事情就是：當消費者消費之后，就又會去讓“生產程序”再生成一個令牌出來，并且在該令牌上掛載“消費程序”，這樣就能保證能夠一直“觀察”下去了，

其實ChangeToken的實作很簡單，有關它的源代碼您可以參考：Github 源代碼，

總結

本期其實主要給大家介紹了IChangeToken和ChangeToken，關于IChangeToken其實后期的文章中咱們也有涉及到，它其實也是.net core中重要介面之一，理解它的“職責”和“原理”是很有必要的，這樣才能便于后期我們學習它所在的“不同圈子”，比如文中提及到的物理檔案系統等，

最后，偷偷說一句：創作不易，點個推薦吧.....

標籤：.NET Core

上一篇：Polly每次重試執行不同的操作

下一篇：搭建私有 Nuget 服務器教程(1)