目錄
簡介#
事件總線是對發布-訂閱模式的一種實現，是一種集中式事件處理機制，允許不同的組件之間進行彼此通信而又不需要相互依賴，達到一種解耦的目的。
發布-訂閱模式結構：下面這個圖是從網上找來的圖片，可以幫助你理解
下圖是發布訂閱模式（Publish–subscribe pattern）和 觀察者模式（Observer pattern）的區別
實現事件總線#
EventBus維護一個事件的字典，發布者、訂閱者在事件總線中獲取事件實例並執行發布、訂閱操作，事件實例負責維護、執行事件處理程序。流程如下：
定義事件基類#
事件實例需要在事件總線中注冊，定義一個基類方便事件總線進行管理，代碼如下：
/// <summary>
/// 事件基類
/// </summary>
public abstract class EventBase{ }
事件實例需要管理、執行已經注冊的事件處理程序，為了適應不同的事件參數使用泛型參數，不允許此類實例化。代碼如下：
/// <summary>
/// 泛型事件
/// </summary>
/// <typeparam name="T"></typeparam>
public abstract class PubSubEvent<T> : EventBase where T : EventArgs
{
protected static readonly object locker = new object();
protected readonly List<Action<object, T>> subscriptions = new List<Action<object, T>>();
public void Subscribe(Action<object, T> eventHandler)
{
lock (locker)
{
if (!subscriptions.Contains(eventHandler))
{
subscriptions.Add(eventHandler);
}
}
}
public void Unsubscribe(Action<object, T> eventHandler)
{
lock (locker)
{
if (subscriptions.Contains(eventHandler))
{
subscriptions.Remove(eventHandler);
}
}
}
public virtual void Publish(object sender, T eventArgs)
{
lock (locker)
{
for (int i = 0; i < subscriptions.Count; i++)
{
subscriptions[i](sender, eventArgs);
}
}
}
}
定義事件參數基類#
事件參數基類繼承EventArgs，使用泛型參數適應不同的參數類型，不允許此類實例化。代碼如下：
/// <summary>
/// 泛型事件參數
/// </summary>
/// <typeparam name="T"></typeparam>
public abstract class PubSubEventArgs<T> : EventArgs
{
public T Value { get; set; }
}
定義EventBus#
EventBus只提供事件實例的管理，具體事件處理程序的執行由事件實例自己負責。為了使用方便，構造函數有自動注冊事件的功能，在有多個程序集時可能會有bug。代碼如下：
/// <summary>
/// 事件總線
/// </summary>
class EventBus
{
private static EventBus _default;
private static readonly object locker = new object();
private Dictionary<Type, EventBase> eventDic = new Dictionary<Type, EventBase>();
/// <summary>
/// 默認事件總線實例，建議只使用此實例
/// </summary>
public static EventBus Default
{
get
{
if (_default == null)
{
lock (locker)
{
// 如果類的實例不存在則創建，否則直接返回
if (_default == null)
{
_default = new EventBus();
}
}
}
return _default;
}
}
/// <summary>
/// 構造函數，自動加載EventBase的派生類實現
/// </summary>
public EventBus()
{
Type type = typeof(EventBase);
Type typePubSub = typeof(PubSubEvent<>);
Assembly assembly = Assembly.GetAssembly(type);
List<Type> typeList = assembly.GetTypes()
.Where(t => t != type && t != typePubSub && type.IsAssignableFrom(t))
.ToList();
foreach (var item in typeList)
{
EventBase eventBase = (EventBase)assembly.CreateInstance(item.FullName);
eventDic.Add(item, eventBase);
}
}
/// <summary>
/// 獲取事件實例
/// </summary>
/// <typeparam name="TEvent">事件類型</typeparam>
/// <returns></returns>
public TEvent GetEvent<TEvent>() where TEvent : EventBase
{
return (TEvent)eventDic[typeof(TEvent)];
}
/// <summary>
/// 添加事件類型
/// </summary>
/// <typeparam name="TEvent"></typeparam>
public void AddEvent<TEvent>() where TEvent : EventBase ,new()
{
lock (locker)
{
Type type = typeof(TEvent);
if (!eventDic.ContainsKey(type))
{
eventDic.Add(type, new TEvent());
}
}
}
/// <summary>
/// 移除事件類型
/// </summary>
/// <typeparam name="TEvent"></typeparam>
public void RemoveEvent<TEvent>() where TEvent : EventBase, new()
{
lock (locker)
{
Type type = typeof(TEvent);
if (eventDic.ContainsKey(type))
{
eventDic.Remove(type);
}
}
}
}
使用事件總線#
事件及事件參數#
使用事件總線前，需要定義好事件及事件參數。在使用時，發布者、訂閱者也必須知道事件類型及事件參數類型。代碼如下：
/// <summary>
/// 泛型事件實現-TestAEvent，重寫事件的觸發邏輯
/// </summary>
public class TestAEvent: PubSubEvent<TestAEventArgs>
{
public override void Publish(object sender, TestAEventArgs eventArgs)
{
lock (locker)
{
for (int i = 0; i < subscriptions.Count; i++)
{
var action= subscriptions[i];
Task.Run(() => action(sender, eventArgs));
}
}
}
}
/// <summary>
/// 泛型事件參數實現-TestAEventArgs
/// </summary>
public class TestAEventArgs : PubSubEventArgs<string> { }
/// <summary>
/// 泛型事件實現-TestBEvent
/// </summary>
public class TestBEvent : PubSubEvent<TestBEventArgs> { }
/// <summary>
/// 泛型事件參數實現-TestBEventArgs
/// </summary>
public class TestBEventArgs : PubSubEventArgs<int> { }
注：TestAEvent中重寫了事件發布的邏輯，每個事件在任務中執行。
定義發布者#
發布者通過事件總線獲取事件實例，在實例上發布事件，代碼如下：
class Publisher
{
public void PublishTeatAEvent(string value)
{
EventBus.Default.GetEvent<TestAEvent>().Publish(this, new TestAEventArgs() { Value=value});
}
public void PublishTeatBEvent(int value)
{
EventBus.Default.GetEvent<TestBEvent>().Publish(this, new TestBEventArgs() { Value = value });
}
}
定義訂閱者#
訂閱者通過事件總線獲取事件實例，在實例上訂閱事件，代碼如下：
class ScbscriberA
{
public string Name { get; set; }
public ScbscriberA(string name)
{
Name = name;
EventBus.Default.GetEvent<TestAEvent>().Subscribe(TeatAEventHandler);
}
public void TeatAEventHandler(object sender, TestAEventArgs e)
{
Console.WriteLine(Name+":"+e.Value);
}
}
class ScbscriberB
{
public string Name { get; set; }
public ScbscriberB(string name)
{
Name = name;
EventBus.Default.GetEvent<TestBEvent>().Subscribe(TeatBEventHandler);
}
public void Unsubscribe_TeatBEvent()
{
EventBus.Default.GetEvent<TestBEvent>().Unsubscribe(TeatBEventHandler);
}
public void TeatBEventHandler(object sender, TestBEventArgs e)
{
Console.WriteLine(Name + ":" + e.Value);
}
}
實際使用#
代碼如下：
class Program
{
static void Main(string[] args)
{
Publisher publisher = new Publisher();
ScbscriberA scbscriberA = new ScbscriberA("scbscriberA");
ScbscriberB scbscriberB1 = new ScbscriberB("scbscriberB1");
ScbscriberB scbscriberB2 = new ScbscriberB("scbscriberB2");
publisher.PublishTeatAEvent("test");
publisher.PublishTeatBEvent(123);
scbscriberB2.Unsubscribe_TeatBEvent();
publisher.PublishTeatBEvent(12345);
Console.ReadKey();
}
}
運行結果：
scbscriberB1:123
scbscriberB2:123
scbscriberA:test
scbscriberB1:12345
總結#
這個事件總線只提供了基礎功能，實現的發布者和訂閱者的解耦，發布者、訂閱者只依賴事件不互相依賴。
感覺我對事件總線的理解還有點不足，歡迎大家來一起討論！
參考資料#
c# – 使用反射來發現派生類型
Prism.Core/Events/EventBase.cs
C# 事件總線 EventBus