以一个发布者-订阅者模式浅析C#中的事件

最近在b站看杨旭的视频学C#，学到事件的时候一下子不是很好理解，本文用以记录学习的过程。

事件用于完成消息体在发布者和订阅者之间的传播（可以简单看成在两个类的实例里传播，即观察者模式），本文以股票和看板为例，股票具有名称和价格两个字段，看板用于显示股票价格的信息，当股票价格改变时，需要提醒看板修改股票价格的信息。在这里，股票是事件的发布者，看板是事件的订阅者，而价格改变就是要传递的信息。

 

整个流程： 发布者 ==>信息==>订阅者

使用事件要遵循如下几个步骤：

1.为事件传播定义信息类型

本案例中，传播的信息需要包含旧的价格和新的价格。

在Framework里，信息有预定义的框架类System.EventArgs，在构造函数里，只需将新旧价格赋值。

public class PriceChangedEventArgs : EventArgs
{
    public readonly decimal LastPrice;
    public readonly decimal NewPrice;

    public PriceChangedEventArgs (decimal lastPrice, decimal newPrice)
    {
        LastPrice = lastPrice;
        NewPrice = newPrice;
    }
}

2.在发布者中定义事件

委托类似于函数指针，可以帮忙统一执行一个或多个函数，事件则包含委托，在委托前面加一个event就变成事件。

public event EventHandler<PriceChangedEventArgs> PriceChanged

PriceChanged就相当于一个委托，可通过+=或-=添加或删除要统一执行的方法。在这里PriceChanged也是一个事件，他有两个参数（sender，e ），sender是事件的广播者，e是要传播的信息，这里要传播的信息类型为PriceChangedEventArgs。到这为止事件PriceChanged还不能被触发。

	public class Stock
    {
        string symbol;
        decimal price;
        public Stock(string symbol)
        {
            this.symbol = symbol;
        }

        // 为事件选择或定义委托
        // Framework定义了一个泛型委托类型System.EventHandler<T>:
        // public delegate void EventHandler<TEventArgs>
        //   (object source, TEventArgs e) where TEventArgs : EventArgs;
        // 将委托变成事件（在委托前面加event）
        //      ||
        //      ||
        //      \/
        // 针对选择的委托定义事件
        public event EventHandler<PriceChangedEventArgs> PriceChanged;

    }

为了能触发事件PriceChanged，还要加上可触发事件的方法，即当价格改变时要触发事件PriceChanged发送信息PriceChangedEventArgs。

可触发事件的方法名和事件要一致，并在前面加On，方法前要加protected virtual字段。该方法的参数就是要传递的信息。

protected virtual void OnPriceChanged(PriceChangedEventArgs e)
{
    // if(PriceChanged != null) PriceChanged(this, e);
    PriceChanged?.Invoke(this, e);  // 等价于上面那行
    // 事件的广播者是本身（this），e是传播的信息
}

3.在发布者中调用事件

当价格不变时，属性Price里直接返回；当价格改变时，调用可触发事件的方法OnPriceChanged，到此，发布者已将信息发布出去了，新旧价格都已经在这个PriceChangedEventArgs对象里。

// 属性
 public decimal Price
{
    get { return price; }
    set
    {
        if(price == value) return;
        decimal oldPrice = price;
        price = value;
        OnPriceChanged(new PriceChangedEventArgs(oldPrice, price));
    }
}

4.订阅者中注册发布者，为事件绑定要执行的动作

这里看板作为股票的订阅者，在其单参数的构造函数里进行订阅动作，导入发布者类的事件接口，为事件绑定要执行的函数stock_PriceChanged。

    public class Board
    {
        public Board(Stock stock)
        {
            stock.PriceChanged += stock_PriceChanged; // 订阅
        }

        public void stock_PriceChanged(object sender, PriceChangedEventArgs e)
        {
            if((e.NewPrice - e.LastPrice) / e.LastPrice > 0.1M)
            {
                Console.WriteLine("Alert from board, 10% stock price increase!");
            }
            else
            {
                Console.WriteLine($"Info from board, price changed to {e.NewPrice}!");
            }
        }
    }

使用

1.生成一支股票名为MSFT；

2.设定股票的价格为120，此时因为没有给PriceChanged设定任何的方法，因此为null；

3.将stock作为参数实例化一个看板，此时看板中已经订阅了股票的事件PriceChanged，且已经给PriceChanged设定了一个方法。

4.修改股票的价格，看板中提示Alert from board, 10% stock price increase!

5.修改股票的价格，看板中提示Info from board, price changed to 115!

class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine("First CSharp program.");
            Stock stock = new Stock("MSFT");
            stock.Price = 120;  // 没有设定委托的目标方法，PriceChanged为null
            Board board = new Board(stock);
            stock.Price = 135;
            stock.Price = 115;
        }
    }

总结

事件就是完成信息在对象于对象之间进行传播，类似于Qt的信号和槽机制。