C#開發(fā)WPF程序中的弱事件模式

更新時(shí)間：2022年06月20日 10:46:46 作者：天方

這篇文章介紹了C#開發(fā)WPF程序中的弱事件模式，文中通過示例代碼介紹的非常詳細(xì)。對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

在C#中，得益于強(qiáng)大的GC機(jī)制，使得我們開發(fā)程序變得非常簡(jiǎn)單，很多時(shí)候我們只需要管使用，而并不需要關(guān)心什么時(shí)候釋放資源。但是，GC有的時(shí)并不是按照我們所期望的方式工作。

例如，我想實(shí)現(xiàn)一個(gè)在窗口的標(biāo)題欄中實(shí)時(shí)顯示當(dāng)前的時(shí)間，一個(gè)比較常規(guī)的做法如下：

var?timer =?new?DispatcherTimer() { Interval =?TimeSpan.FromSeconds(1) };
timer.Tick += (_s, _e) =>?this.Title =?DateTime.Now.ToString();
timer.Start();

這種做法看起來非常簡(jiǎn)單而直接，它也確實(shí)能老老實(shí)實(shí)按照我們所設(shè)計(jì)的那樣在窗口中實(shí)時(shí)顯示并更新時(shí)間。但是，有經(jīng)驗(yàn)的程序員們就知道，這里存在一個(gè)隱患：這個(gè)窗口永遠(yuǎn)不會(huì)釋放。比較簡(jiǎn)單的驗(yàn)證方式是：手動(dòng)關(guān)閉窗口，調(diào)用GC.Collect()函數(shù)，發(fā)現(xiàn)析構(gòu)函數(shù)是不會(huì)調(diào)用的。

可能有的人會(huì)問了：不是有萬(wàn)能的GC嘛，為什么這個(gè)窗口不會(huì)釋放？究其原因也非常簡(jiǎn)單，DispatchTimer的Tick事件中包含了對(duì)Window的引用，當(dāng)窗口關(guān)閉時(shí)，DispatchTimer仍然在執(zhí)行，因此Window就得不到釋放。

知道了原因后，要解決也不難：在Window的關(guān)閉事件中，停止Timer的調(diào)用即可。這種方式確實(shí)行之有效，但顯得不大優(yōu)雅，感覺回到了要手動(dòng)控制申請(qǐng)和釋放的C語(yǔ)言年代，沒有了GC自動(dòng)管理下的"管殺不管埋"的便捷感覺。那么，有沒有一種我們只管使用，而不管釋放的方案呢，答案就是弱事件模式。

在弱事件模式下，事件委托只保留對(duì)象的弱引用，這樣GC仍然能將該對(duì)象給回收掉。例如，對(duì)于上述代碼，可以修改如下：

var timer = new DispatcherTimer() { Interval = TimeSpan.FromSeconds(1) };
WeakEventManager<DispatcherTimer, EventArgs>.AddHandler(timer, "Tick", (_s, _e) => this.Title = DateTime.Now.ToString());
timer.Start();

由于Timer沒有保存Window的強(qiáng)引用，當(dāng)Windows關(guān)閉后，是會(huì)被GC回收掉的。

現(xiàn)在看起來沒有什么問題了，不過，敏感的程序員們會(huì)發(fā)現(xiàn)，這里還存在一個(gè)隱患：DispatchTimer沒有釋放。雖然我們沒有保存Timer的引用，但為了避免其被GC回收，內(nèi)部仍然會(huì)維持其引用，必須顯式停止。這里我們?nèi)匀豢梢岳萌跏录Ｊ?，在感知到回調(diào)對(duì)象被釋放時(shí)，手動(dòng)停止Timer。要實(shí)現(xiàn)這個(gè)方法，必須我們實(shí)現(xiàn)自己的弱事件管理器：

    public class DispatcherTimerManager : WeakEventManager
    {
        public static void Create(TimeSpan interval, EventHandler<EventArgs> handler)
        {
            var dispatcherTimer = new DispatcherTimer() { Interval = interval };
            DispatcherTimerManager.AddHandler(dispatcherTimer, handler);
            dispatcherTimer.Start();
        }

        public static void AddHandler(DispatcherTimer source, EventHandler<EventArgs> handler)
        {
            current.ProtectedAddHandler(source, handler);
        }

        public static void RemoveHandler(DispatcherTimer source, EventHandler<EventArgs> handler)
        {
            current.ProtectedRemoveHandler(source, handler);
        }

        static DispatcherTimerManager current;
        static DispatcherTimerManager()
        {
            current = new DispatcherTimerManager();
            SetCurrentManager(typeof(DispatcherTimerManager), current);
        }

        protected override ListenerList NewListenerList()
        {
            return new ListenerList<EventArgs>();
        }

        protected override void StartListening(object source)
        {
            var timer = (DispatcherTimer)source;
            timer.Tick += OnSomeEvent;
        }

        protected override void StopListening(object source)
        {
            var timer = (DispatcherTimer)source;
            timer.Tick -= OnSomeEvent;
            timer.Stop();
        }

        void OnSomeEvent(object sender, EventArgs e)
        {
            DeliverEvent(sender, e);
        }
    }

代碼比較簡(jiǎn)單：當(dāng)感知到回調(diào)對(duì)象被釋放時(shí)，會(huì)執(zhí)行StopListening函數(shù)我們只需要重寫改函數(shù)，加入停止Timer操作即可。同樣，我們也可以基于弱事件模式實(shí)現(xiàn)一個(gè)IObservable的自動(dòng)管理類：

    public static class ObservableDispatcher
    {
        public static void AddHandler<T>(IObservable<T> source, EventHandler<DataEventArgs<T>> handler)
        {
            if ( Application.Current.Dispatcher != Dispatcher.CurrentDispatcher)
                throw new InvalidOperationException("需要在主線程上調(diào)用");

            AnymousDispatcher<T>.AddHandler(source, handler);
        }

        public static void RemoveHandler<T>(IObservable<T> source, EventHandler<DataEventArgs<T>> handler)
        {
            AnymousDispatcher<T>.RemoveHandler(source, handler);
        }


        class AnymousDispatcher<T> : WeakEventManager
        {
            public static void AddHandler(IObservable<T> source, EventHandler<DataEventArgs<T>> handler)
            {
                var wrapper = new ObservableEventWrapper<T>(source);
                current.ProtectedAddHandler(wrapper, handler);
            }

            public static void RemoveHandler(IObservable<T> source, EventHandler<DataEventArgs<T>> handler)
            {
                var wrapper = new ObservableEventWrapper<T>(source);
                current.ProtectedRemoveHandler(wrapper, handler);
            }

            static AnymousDispatcher<T> current;
            static AnymousDispatcher()
            {
                current = new AnymousDispatcher<T>();
                SetCurrentManager(typeof(AnymousDispatcher<T>), current);
            }

            protected override ListenerList NewListenerList()
            {
                return new ListenerList<DataEventArgs<T>>();
            }

            protected override void StartListening(object source)
            {
                var wrapper = source as ObservableEventWrapper<T>;
                wrapper.OnData += wrapper_OnData;
            }

            void wrapper_OnData(object sender, DataEventArgs<T> e)
            {
                DeliverEvent(sender, e);
            }

            protected override void StopListening(object source)
            {
                var wrapper = source as ObservableEventWrapper<T>;
                wrapper.OnData -= wrapper_OnData;
                wrapper.Dispose();
            }
        }

        class ObservableEventWrapper<T> : IDisposable
        {
            IDisposable disposeHandler;
            public ObservableEventWrapper(IObservable<T> dataSource)
            {
                disposeHandler = dataSource.Subscribe(onData);
            }

            void onData(T data)
            {
                OnData(this, new DataEventArgs<T>(data));
            }

            public event EventHandler<DataEventArgs<T>> OnData;

            public void Dispose()
            {
                disposeHandler.Dispose();
            }
        }
    }

限制：

弱事件模式非常有用，但不知道為什么微軟將其限制在了WPF框架中了，從其實(shí)現(xiàn)上來看，應(yīng)該是在UI線程上調(diào)用，但在MSDN上也沒有找到其限制的說明。我試過在非UI線程上調(diào)用它，也是弱事件，但是不能觸發(fā)StopListening函數(shù)。不知道這樣有沒有什么影響，但最好還是在UI線程上調(diào)用它。

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: