C#中觀察者模式的3種實(shí)現(xiàn)方式
說起觀察者模式，估計(jì)在園子里能搜出一堆來。所以寫這篇博客的目的有兩點(diǎn):
1.觀察者模式是寫松耦合代碼的必備模式，重要性不言而喻，拋開代碼層面，許多組件都采用了Publish-Subscribe模式，所以我想按照自己的理解重新設(shè)計(jì)一個(gè)使用場景并把觀察者模式靈活使用在其中
2.我想把C#中實(shí)現(xiàn)觀察者模式的三個(gè)方案做一個(gè)總結(jié)，目前還沒看到這樣的總結(jié)
現(xiàn)在我們來假設(shè)這樣的一個(gè)場景，并利用觀察者模式實(shí)現(xiàn)需求：
未來智能家居進(jìn)入了每家每戶，每個(gè)家居都留有API供客戶進(jìn)行自定義整合，所以第一個(gè)智能鬧鐘(smartClock)先登場,廠家為此鬧鐘提供了一組API,當(dāng)設(shè)置一個(gè)鬧鈴時(shí)間后該鬧鐘會在此時(shí)做出通知，我們的智能牛奶加熱器，面包烘烤機(jī)，擠牙膏設(shè)備都要訂閱此鬧鐘鬧鈴消息，自動為主人準(zhǔn)備好牛奶，面包，牙膏等。
這個(gè)場景是很典型觀察者模式，智能鬧鐘的鬧鈴是一個(gè)主題(subject)，牛奶加熱器，面包烘烤機(jī)，擠牙膏設(shè)備是觀察者(observer)，他們只需要訂閱這個(gè)主題即可實(shí)現(xiàn)松耦合的編碼模型。讓我們通過三種方案逐一實(shí)現(xiàn)此需求。
一、利用.net的Event模型來實(shí)現(xiàn)
.net中的Event模型是一種典型的觀察者模式，在.net出身之后被大量應(yīng)用在了代碼當(dāng)中，我們看事件模型如何在此種場景下使用,
首先介紹下智能鬧鐘，廠家提供了一組很簡單的API
public void SetAlarmTime(TimeSpan timeSpan)
{
_alarmTime = _now().Add(timeSpan);
RunBackgourndRunner(_now, _alarmTime);
}
SetAlarmTime(TimeSpan timeSpan)用來定時(shí)，當(dāng)用戶設(shè)置好一個(gè)時(shí)間后，鬧鐘會在后臺跑一個(gè)類似于while(true)的循環(huán)對比時(shí)間，當(dāng)鬧鈴時(shí)間到了后要發(fā)出一個(gè)通知事件出來
protected void RunBackgourndRunner(Func<DateTime> now,DateTime? alarmTime )
{
if (alarmTime.HasValue)
{
var cancelToken = new CancellationTokenSource();
var task = new Task(() =>
{
while (!cancelToken.IsCancellationRequested)
{
if (now.AreEquals(alarmTime.Value))
{
//鬧鈴時(shí)間到了
ItIsTimeToAlarm();
cancelToken.Cancel();
}
cancelToken.Token.WaitHandle.WaitOne(TimeSpan.FromSeconds(2));
}
}, cancelToken.Token, TaskCreationOptions.LongRunning);
task.Start();
}
}
其他代碼并不重要，重點(diǎn)在當(dāng)鬧鈴時(shí)間到了后要執(zhí)行ItIsTimeToAlarm(); 我們在這里發(fā)出事件以便通知訂閱者，.net中實(shí)現(xiàn)event模型有三要素，
1.為主題(subject)要定義一個(gè)event, public event Action<Clock, AlarmEventArgs> Alarm;
2.為主題(subject)的信息定義一個(gè)EventArgs，即AlarmEventArgs,這里面包含了事件所有的信息
3.主題(subject)通過以下方式發(fā)出事件
var args = new AlarmEventArgs(_alarmTime.Value, 0.92m);
OnAlarmEvent(args);
OnAlarmEvent方法的定義
public virtual void OnAlarm(AlarmEventArgs e)
{
if(Alarm!=null)
Alarm(this,e);
}
這里要注意命名,事件內(nèi)容-AlarmEventArgs，事件-Alarm(動詞,例如KeyPress)，觸發(fā)事件的方法 void OnAlarm(),這些元素都要符合事件模型的命名規(guī)范。
智能鬧鐘(SmartClock)已經(jīng)實(shí)現(xiàn)完畢，我們在牛奶加熱器(MilkSchedule)中訂閱這個(gè)Alarm消息：
public void PrepareMilkInTheMorning()
{
_clock.Alarm += (clock, args) =>
{
Message =
"Prepraring milk for the owner, The time is {0}, the electric quantity is {1}%".FormatWith(
args.AlarmTime, args.ElectricQuantity*100);
Console.WriteLine(Message);
};
_clock.SetAlarmTime(TimeSpan.FromSeconds(2));
}
在面包烘烤機(jī)中同樣可以用_clock.Alarm+=(clock,args)=>{//it is time to roast bread}訂閱鬧鈴消息。
至此，event模型介紹完畢，實(shí)現(xiàn)過程還是有點(diǎn)繁瑣的，并且事件模型使用不當(dāng)會有memory leak的問題，當(dāng)觀察者(obsever)訂閱了一個(gè)生命周期較長的主題(該主題生命周期長于觀察者),該觀察者并不會被內(nèi)存回收(因?yàn)檫€有引用指主題)，詳見Understanding and Avoiding Memory Leaks with Event Handlers and Event Aggregators,開發(fā)者需要顯示退訂該主題(-=)。
園子里老A也寫過一篇如何利用弱引用解決該問題的博客：如何解決事件導(dǎo)致的Memory Leak問題：Weak Event Handlers。
二、利用.net中IObservable<out T>和IObserver<in T>實(shí)現(xiàn)觀察者模式
IObservable<out T> 正如名稱含義-可觀察的事物，即主題(subject),Observer很明顯就是觀察者了。
在我們的場景中智能鬧鐘是IObservable,該接口只定義了一個(gè)方法IDisposable Subscribe(IObserver<T> observer);該方法命名讓人有點(diǎn)犯暈,Subscribe即訂閱的意思，不同于之前提到過的觀察者(observer)訂閱主題(subject)。在這里是主題(subject)來訂閱觀察者(observer),其實(shí)這里也說得通，因?yàn)樵谠撃Ｐ拖?，主題(subject)維護(hù)了一個(gè)觀察者(observer)列表，所以有主題訂閱觀察者之說，我們來看鬧鐘的IDisposable Subscribe(IObserver<T> observer)實(shí)現(xiàn)：
public IDisposable Subscribe(IObserver<AlarmData> observer)
{
if (!_observers.Contains(observer))
{
_observers.Add(observer);
}
return new DisposedAction(() => _observers.Remove(observer));
}
可以看到這里維護(hù)了一個(gè)觀察者列表_observers,鬧鐘在到點(diǎn)了之后會遍歷所有觀察者列表將消息逐一通知給觀察者
public override void ItIsTimeToAlarm()
{
var alarm = new AlarmData(_alarmTime.Value, 0.92m);
_observers.ForEach(o=>o.OnNext(alarm));
}
很明顯，觀察者有個(gè)OnNext方法，方法簽名是一個(gè)AlarmData,代表了要通知的消息數(shù)據(jù),接下來看看牛奶加熱器的實(shí)現(xiàn),牛奶加熱器作為觀察者(observer)當(dāng)然要實(shí)現(xiàn)IObserver接口
public void Subscribe(TimeSpan timeSpan)
{
_unSubscriber = _clock.Subscribe(this);
_clock.SetAlarmTime(timeSpan);
}
public void Unsubscribe()
{
_unSubscriber.Dispose();
}
public void OnNext(AlarmData value)
{
Message =
"Prepraring milk for the owner, The time is {0}, the electric quantity is {1}%".FormatWith(
value.AlarmTime, value.ElectricQuantity * 100);
Console.WriteLine(Message);
}
除此之外為了方便使用面包烘烤器，我們還加了兩個(gè)方法Subscribe()和Unsubscribe(),看調(diào)用過程
var milkSchedule = new MilkSchedule();
//Act
milkSchedule.Subscribe(TimeSpan.FromSeconds(12));
三、Action函數(shù)式方案
在介紹該方案之前我需要說明，該方案并不是一個(gè)觀察者模型，但是它卻可以實(shí)現(xiàn)同樣的功能，并且使用起來更簡練，也是我最喜歡的一種用法。
這種方案中，智能鬧鐘(smartClock)提供的API需要設(shè)計(jì)成這樣：
public void SetAlarmTime(TimeSpan timeSpan,Action<AlarmData> alarmAction)
{
_alarmTime = _now().Add(timeSpan);
_alarmAction = alarmAction;
RunBackgourndRunner(_now, _alarmTime);
}
方法簽名中要接受一個(gè)Action<T>,鬧鐘在到點(diǎn)后直接執(zhí)行該Action<T>即可:
public override void ItIsTimeToAlarm()
{
if (_alarmAction != null)
{
var alarmData = new AlarmData(_alarmTime.Value, 0.92m);
_alarmAction(alarmData);
}
}
牛奶加熱器中使用這種API也很簡單：
_clock.SetAlarmTime(TimeSpan.FromSeconds(1), (data) =>
{
Message =
"Prepraring milk for the owner, The time is {0}, the electric quantity is {1}%".FormatWith(
data.AlarmTime, data.ElectricQuantity * 100);
});
在實(shí)際使用過程中我會把這種API設(shè)計(jì)成fluent模型，調(diào)用起來代碼更清晰：
智能鬧鐘(smartClock)中的API:
public Clock SetAlarmTime(TimeSpan timeSpan)
{
_alarmTime = _now().Add(timeSpan);
RunBackgourndRunner(_now, _alarmTime);
return this;
}
public void OnAlarm(Action<AlarmData> alarmAction)
{
_alarmAction = alarmAction;
}
牛奶加熱器中進(jìn)行調(diào)用：
_clock.SetAlarmTime(TimeSpan.FromSeconds(2))
.OnAlarm((data) =>
{
Message =
"Prepraring milk for the owner, The time is {0}, the electric quantity is {1}%".FormatWith(
data.AlarmTime, data.ElectricQuantity * 100);
});
顯然改進(jìn)后的寫法語義更好：鬧鐘.設(shè)置鬧鈴時(shí)間().當(dāng)報(bào)警時(shí)(()=>{執(zhí)行以下功能})
這種函數(shù)式寫法更簡練，但是也有明顯的缺點(diǎn)，該模型不支持多個(gè)觀察者,當(dāng)面包烘烤機(jī)使用這樣的API時(shí)，會覆蓋牛奶加熱器的函數(shù),即每次只支持一個(gè)觀察者使用。
結(jié)束語，本文總結(jié)了.net下的三種觀察者模型實(shí)現(xiàn)方案，能在編程場景下選擇最合適的模型當(dāng)然是我們的最終目標(biāo)。本文提供下載本文章所使用的源碼,如需轉(zhuǎn)載請注明出處
相關(guān)文章
這篇文章主要介紹了C#實(shí)現(xiàn)壓縮HTML代碼的方法,是非常實(shí)用的功能,需要的朋友可以參考下2014-09-09
c#擴(kuò)展datatable轉(zhuǎn)json示例
這篇文章主要介紹了c#擴(kuò)展datatable轉(zhuǎn)json示例,需要的朋友可以參考下2014-05-05
這篇文章主要介紹了C#中委托的+=和-=深入研究,本文深入研究+=和-=在執(zhí)行時(shí)都做了哪些事情,加深對C#委托的理解和使用,需要的朋友可以參考下2015-01-01
這篇文章主要介紹了c#異步task示例(異步操作),需要的朋友可以參考下2014-03-03
梳排序算法是一種改進(jìn)的冒泡排序算法,它通過調(diào)整冒泡排序的間隔來提高排序的效率,本文主要介紹了C#實(shí)現(xiàn)梳排序的使用示例,感興趣的可以了解一下2023-11-11
C#利用Aspose.PDF實(shí)現(xiàn)PDF轉(zhuǎn)EPUB的完整指南
在 .NET 開發(fā)中,Aspose.PDF 是一個(gè)強(qiáng)大的庫,能夠幫助我們處理 PDF 文件的各種任務(wù),包括將 PDF 轉(zhuǎn)換為其他格式,如 EPUB,本文將介紹如何使用 Aspose.PDF 在 C# 中實(shí)現(xiàn)將 PDF 轉(zhuǎn)換為 EPUB 的功能,需要的朋友可以參考下2025-02-02
Unity實(shí)現(xiàn)粒子光效導(dǎo)出成png序列幀
這篇文章主要為大家詳細(xì)介紹了Unity實(shí)現(xiàn)粒子光效導(dǎo)出成png序列幀，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2019-03-03
使用XmlSerializer序列化List對象成XML格式(list對象序列化)
這篇文章主要介紹了使用XmlSerializer序列化List對象成XML格式(list對象序列化),需要的朋友可以參考下2014-03-03
C#基于自定義事件EventArgs實(shí)現(xiàn)發(fā)布訂閱模式
這篇文章介紹了C#基于自定義事件EventArgs實(shí)現(xiàn)發(fā)布訂閱模式的方法，文中通過示例代碼介紹的非常詳細(xì)。對大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2022-05-05
最近在學(xué)習(xí)C#的并行編程,在每本書上的看到的知識點(diǎn)都不全面,所以先參考多本書書籍的講解,將并行編程,多線程編程的知識點(diǎn)整理一下,這篇文章主要給大家介紹了關(guān)于C#多線程開發(fā)之任務(wù)并行庫的相關(guān)資料,需要的朋友可以參考下2021-09-09