設計模式-觀察者模式（Observer）-有解無憂

講故事(user story)

假設我們是一個優惠券提供平臺，故事就發生在顧客在我們平臺采購完成支付成功后，

支付完成后平臺要進行的一些操作:

短信通知客戶已經生成訂單
增加顧客的積分
開始按訂單需求制券

? ，，，(可能會有許多操作)

接下來就是將故事以代碼的形式展現出來，，，

需求分析

我們將上述故事轉化為代碼中的物件分別是：支付成功 PaySuccessSubject、短信通知 MessageObserver、積分增加 BonusObserver、制券 CouponObserver，

當支付成功PaySuccessSubject后，要通知到MessageObserver，BonusObserver，CouponObserver這三個物件，為了實作上面這個需求，將采用觀察者模式（發布-訂閱）

敲黑板.劃重點

觀察者模式又叫發布-訂閱(Publish/Subscribe)模式，定義了一種一對多的依賴關系，讓多個觀察者物件同時監聽某一個主題物件，當主題物件在狀態發生變化時，通知所有觀察者物件，使他們能夠自己更新自己，

觀察者模式結構圖

Show Code

Subject類,把所有觀察者物件的參考保存在一個集合了,每個通知者都可以有任何數量的觀察者，抽象通知者提供可以增加和洗掉觀察者物件的介面，

/// <summary>
/// 抽象通知者
/// </summary>
public abstract class Subject
{
    /// <summary>
    /// 觀察者集合
    /// </summary>
    protected List<IObserver> observers = new List<IObserver>();

    public string State { get; set; }

    /// <summary>
    /// 添加觀察者
    /// </summary>
    /// <param name="observer">觀察者</param>
    public void Attach(IObserver observer)
    {
        observers.Add(observer);
    }

    /// <summary>
    /// 洗掉觀察者
    /// </summary>
    /// <param name="observer">觀察者</param>
    public void Detach(IObserver observer)
    {
        observers.Remove(observer);
    }

    /// <summary>
    /// 通知
    /// </summary>
    /// <returns></returns>
    public void Notify()
    {
        foreach (var observer in observers)
        {
            observer.Update();
        }
    }
}

PaySuccessSubject類，具體的通知者，給所有登記過的觀察者發出通知，
 /// <summary>
 /// 支持成功通知者
 /// </summary>
 public class PaySuccessSubject : Subject
 {
 }

Observer類，抽象觀察者，為所有的具體的觀察者定義一個介面，一般用抽象類或介面實作，通常包含一個Update()更新方法，
 /// <summary>
 /// 抽象觀察
 /// </summary>
 public abstract class Observer
 {
     public abstract void Update();
 }

MessageObserver、BonusObserver、CouponObserver具體的觀察者類，實作更新介面，以便本身的狀態與主題的狀態相協調，

    /// <summary>
    /// 短信觀察者
    /// </summary>
    public class MessageObserver : Observer
    {
        public Subject Subject { get; set; }

        public MessageObserver(Subject subject)
        {
            Subject = subject;
        }

        public override void Update()
        {
            Console.WriteLine($"{Subject.State}:短信通知了...");
        }
    }
    /// <summary>
    /// 積分觀察者
    /// </summary>
    public class BonusObserver : Observer
    {
        public Subject Subject { get; set; }

        public BonusObserver(Subject subject)
        {
            Subject = subject;
        }

        public override void Update()
        {
            Console.WriteLine($"{Subject.State}:積分增加了...");
        }
    }

    /// <summary>
    /// 券觀察者
    /// </summary>
    public class CouponObserver : Observer
    {
        public Subject Subject { get; set; }

        public CouponObserver(Subject subject)
        {
            Subject = subject;
        }
        public override void Update()
        {
            Console.WriteLine($"{Subject.State}:開始制券了...");
        }
    }

客戶端代碼

        private static void Main(string[] args)
        {
            var subject = new PaySuccessSubject();
            var observer1 = new CouponObserver(subject);
            var observer2 = new MessageObserver(subject);
            var observer3 = new BonusObserver(subject);

            //添加訂閱
            subject.Attach(observer1);
            subject.Attach(observer2);
            subject.Attach(observer3);

            //發布通知
            subject.State = "星巴克10十元券采購成功";
            subject.Notify();

            Console.WriteLine("\n\nHappy Ending~");
            Console.ReadLine();
        }

結果顯示

Code Upgrade

code review后發現，在通知給觀察者時，是順序執行，如果其中一個觀察者卡頓或者錯誤，會導致其他觀察者卡克，所以我們應該采用異步方式，

下面我們將模擬制券程序耗時增加，但不影響通知其他觀察者，直接上代碼：

    /// <summary>
    /// 抽象觀察
    /// </summary>
    public abstract class Observer
    {
        public abstract Task UpdateAsync();
    }

    /// <summary>
    /// 短信觀察者
    /// </summary>
    public class MessageObserver : Observer
    {
        public Subject Subject { get; set; }

        public MessageObserver(Subject subject)
        {
            Subject = subject;
        }

        public override Task UpdateAsync()
        {
            Console.WriteLine($"{Subject.State}:短信通知了...");
            return Task.CompletedTask;
        }
    }

    /// <summary>
    /// 積分觀察者
    /// </summary>
    public class BonusObserver : Observer
    {
        public Subject Subject { get; set; }

        public BonusObserver(Subject subject)
        {
            Subject = subject;
        }

        public override Task UpdateAsync()
        {
            Console.WriteLine($"{Subject.State}:積分增加了...");
            return Task.CompletedTask;
        }
    }

    /// <summary>
    /// 券觀察者
    /// </summary>
    public class CouponObserver : Observer
    {
        public Subject Subject { get; set; }

        public CouponObserver(Subject subject)
        {
            Subject = subject;
        }

        public override async Task UpdateAsync()
        {
            Console.WriteLine($"{Subject.State}:開始制券...");
            //模擬制券耗時
            await Task.Delay(3000);
            Console.WriteLine($"{Subject.State}:制券完成...");
        }
    }

    /// <summary>
    /// 抽象通知者
    /// </summary>
    public abstract class Subject
    {
        /// <summary>
        /// 觀察者集合
        /// </summary>
        protected List<Observer> observers = new List<Observer>();

        public string State { get; set; }

        /// <summary>
        /// 添加觀察者
        /// </summary>
        /// <param name="observer">觀察者</param>
        public void Attach(Observer observer)
        {
            observers.Add(observer);
        }

        /// <summary>
        /// 洗掉觀察者
        /// </summary>
        /// <param name="observer">觀察者</param>
        public void Detach(Observer observer)
        {
            observers.Remove(observer);
        }

        /// <summary>
        /// 通知
        /// </summary>
        /// <returns></returns>
        public Task Notify()
        {
            foreach (var observer in observers)
            {
                observer.UpdateAsync();
            }
            return Task.CompletedTask;
        }
    }

客戶端端代碼:

        private static async Task Main(string[] args)
        {
            var subject = new PaySuccessSubject();
            var observer1 = new CouponObserver(subject);
            var observer2 = new MessageObserver(subject);
            var observer3 = new BonusObserver(subject);

            //添加訂閱
            subject.Attach(observer1);
            subject.Attach(observer2);
            subject.Attach(observer3);

            //發布通知
            subject.State = "星巴克10十元券采購成功";
            await subject.Notify();

            Console.WriteLine("\n\nHappy Ending~");
            Console.ReadLine();
        }

結果顯示:

result

委托加持觀察者模式

現實開發中，很多觀察者物件共同繼承或者實作同一個抽象觀察者，不合適；并且所有觀察者物件的操作方法統一叫一個 Update(),達不到望文生義的效果，所以我們對觀察者模式再次進行升級，使用委托來替換掉抽象觀察者，

直接上代碼：

    /// <summary>
    /// 短信觀察者
    /// </summary>
    public class MessageObserver
    {
        public ISubject Subject { get; set; }

        public MessageObserver(ISubject subject)
        {
            Subject = subject;
        }

        /// <summary>
        /// 發送短信
        /// </summary>
        /// <returns></returns>
        public Task SendMessageAsync()
        {
            Console.WriteLine($"{Subject.State}:短信通知了...");
            return Task.CompletedTask;
        }
    }

    /// <summary>
    /// 積分觀察者
    /// </summary>
    public class BonusObserver
    {
        public ISubject Subject { get; set; }

        public BonusObserver(ISubject subject)
        {
            Subject = subject;
        }

        /// <summary>
        /// 添加積分
        /// </summary>
        /// <returns></returns>
        public Task AddBonusAsync()
        {
            Console.WriteLine($"{Subject.State}:積分增加了...");
            return Task.CompletedTask;
        }
    }

    /// <summary>
    /// 券觀察者
    /// </summary>
    public class CouponObserver
    {
        public ISubject Subject { get; set; }

        public CouponObserver(ISubject subject)
        {
            Subject = subject;
        }

        /// <summary>
        /// 制券
        /// </summary>
        /// <returns></returns>
        public async Task MakeCouponAsync()
        {
            Console.WriteLine($"{Subject.State}:開始制券...");
            //模擬制券耗時
            await Task.Delay(3000);
            Console.WriteLine($"{Subject.State}:制券完成...");
        }
    }

    /// <summary>
    /// 抽象通知者
    /// </summary>
    public interface ISubject
    {
        /// <summary>
        /// 通知
        /// </summary>
        /// <returns></returns>
        public Task Notify();

        public string State { get; set; }
    }

    /// <summary>
    /// 支持成功通知者
    /// </summary>
    public class PaySuccessSubject : ISubject
    {
        public Func<Task> Update;

        public string State { get; set; }

        public Task Notify()
        {
            Update();
            return Task.CompletedTask;
        }
    }
}

客戶端呼叫：

    internal class Program
    {
        private static async Task Main(string[] args)
        {
            var subject = new ObserverDelegate.PaySuccessSubject();
            var observer1 = new ObserverDelegate.CouponObserver(subject);
            var observer2 = new ObserverDelegate.MessageObserver(subject);
            var observer3 = new ObserverDelegate.BonusObserver(subject);
            //添加訂閱
            subject.Update += observer1.MakeCouponAsync;
            subject.Update += observer2.SendMessageAsync;
            subject.Update += observer3.AddBonusAsync;
            //發布通知
            subject.State = "星巴克10十元券采購成功";
            await subject.Notify();

            Console.WriteLine("\n\nHappy Ending~");
            Console.ReadLine();
        }
    }
}

展示結果和上面一樣，

原始碼地址：https://gitee.com/sayook/DesignMode/tree/master/Observer

轉載請註明出處，本文鏈接：https://www.uj5u.com/ruanti/12572.html

標籤：設計模式

上一篇：設計模式之單例模式（Singleton Pattern），太簡單了

下一篇：設計模式-狀態模式（State）