詳解c# 事件總線

更新時(shí)間：2021年05月12日 08:32:20 作者：time-flies

這篇文章主要介紹了c# 事件總線的相關(guān)資料，幫助大家更好的理解和學(xué)習(xí)使用c#，感興趣的朋友可以了解下

簡介

事件總線是對發(fā)布-訂閱模式的一種實(shí)現(xiàn)，是一種集中式事件處理機(jī)制，允許不同的組件之間進(jìn)行彼此通信而又不需要相互依賴，達(dá)到一種解耦的目的。

實(shí)現(xiàn)事件總線

EventBus維護(hù)一個(gè)事件的字典，發(fā)布者、訂閱者在事件總線中獲取事件實(shí)例并執(zhí)行發(fā)布、訂閱操作，事件實(shí)例負(fù)責(zé)維護(hù)、執(zhí)行事件處理程序。流程如下：

定義事件基類

事件實(shí)例需要在事件總線中注冊，定義一個(gè)基類方便事件總線進(jìn)行管理，代碼如下：

/// <summary>
/// 事件基類
/// </summary>
public abstract class EventBase{ }

事件實(shí)例需要管理、執(zhí)行已經(jīng)注冊的事件處理程序，為了適應(yīng)不同的事件參數(shù)使用泛型參數(shù)，不允許此類實(shí)例化。代碼如下：

/// <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);
            }
        }
    }
}

定義事件參數(shù)基類

事件參數(shù)基類繼承EventArgs，使用泛型參數(shù)適應(yīng)不同的參數(shù)類型，不允許此類實(shí)例化。代碼如下：

/// <summary>
/// 泛型事件參數(shù)
/// </summary>
/// <typeparam name="T"></typeparam>
public abstract class PubSubEventArgs<T> : EventArgs
{
    public T Value { get; set; }
}

定義EventBus

EventBus只提供事件實(shí)例的管理，具體事件處理程序的執(zhí)行由事件實(shí)例自己負(fù)責(zé)。為了使用方便，構(gòu)造函數(shù)有自動(dòng)注冊事件的功能，在有多個(gè)程序集時(shí)可能會(huì)有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>
    /// 默認(rèn)事件總線實(shí)例，建議只使用此實(shí)例
    /// </summary>
    public static EventBus Default
    {
        get
        {
            if (_default == null)
            {
                lock (locker)
                {
                    // 如果類的實(shí)例不存在則創(chuàng)建，否則直接返回
                    if (_default == null)
                    {
                        _default = new EventBus();                            
                    }
                }
            }
            return _default;
        }
    }

    /// <summary>
    /// 構(gòu)造函數(shù)，自動(dòng)加載EventBase的派生類實(shí)現(xiàn)
    /// </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>
    /// 獲取事件實(shí)例
    /// </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);
            }
        }
    }
}

使用事件總線

事件及事件參數(shù)

使用事件總線前，需要定義好事件及事件參數(shù)。在使用時(shí)，發(fā)布者、訂閱者也必須知道事件類型及事件參數(shù)類型。代碼如下：

/// <summary>
/// 泛型事件實(shí)現(xiàn)-TestAEvent，重寫事件的觸發(fā)邏輯
/// </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>
/// 泛型事件參數(shù)實(shí)現(xiàn)-TestAEventArgs
/// </summary>
public class TestAEventArgs : PubSubEventArgs<string> { }


/// <summary>
/// 泛型事件實(shí)現(xiàn)-TestBEvent
/// </summary>
public class TestBEvent : PubSubEvent<TestBEventArgs> { }
/// <summary>
/// 泛型事件參數(shù)實(shí)現(xiàn)-TestBEventArgs
/// </summary>
public class TestBEventArgs : PubSubEventArgs<int> { }

注：TestAEvent中重寫了事件發(fā)布的邏輯，每個(gè)事件在任務(wù)中執(zhí)行。

定義發(fā)布者

發(fā)布者通過事件總線獲取事件實(shí)例，在實(shí)例上發(fā)布事件，代碼如下：

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 });
    }
}

定義訂閱者

訂閱者通過事件總線獲取事件實(shí)例，在實(shí)例上訂閱事件，代碼如下：

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);
    }
}

實(shí)際使用

代碼如下：

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();           
    }    
}

運(yùn)行結(jié)果：