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

句幽發表於2020-03-18

系列介紹

【五分鐘的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 中的更改令牌檢測更改》。但是該篇文章我個人覺得有點偏重於講使用，而對原理比較淡化。這怎麼能滿足得了我們程式設計師的探索欲?，肯定要再百度一波呀，然後……………… 只有一篇文章....。（手動部落格園牛逼！）

x

觀察者？

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

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

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

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

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

那麼有沒有好的辦法呢？ 那肯定是有的呀。

公認即合理？

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

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

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

x

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

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中重要介面之一，理解它的“職責”和“原理”是很有必要的。這樣才能便於後期我們學習它所在的“不同圈子”，比如文中提及到的物理檔案系統等。

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

x

相關文章