《Effective C#》读书笔记——条目25:用事件模式实现通知<使用C#表达设计>

　　.NET中的事件其实就是一个观察者模式(Observer Pattern)的一个语法上的快捷实现(更多可以参考：使用委托和事件实现观察者模式)。事件是一种内建的委托，用来为事件处理函数提供类型安全的方法签名。事件就是对象将信息告知观察者的方式。

 

1.发布者定义事件

　　我们来看一个例子，有一个日志类，将应用程序需要分发的信息发送个各个侦听者，这些侦听者可以是控制域、系统日志、数据库等等，首先定义一个在事件触发中负责传递消息的事件参数类：

        public class LoggerEventArgs : EventArgs
        {
            public string message { get; private set; }
            public int Priority { get; private set; }

            public LoggerEventArgs(int p, string m)
            {
                this.Priority = p;
                this.message = m;
            }
        }

 然后是日志类本身：

    public class Logger
    {
        static Logger()
        {
            theOnly = new Logger();
        }

        private Logger()
        {
        }

        private static Logger theOnly = null;
        public static Logger Singleton
        {
            get { return theOnly; }
        }
        //定义事件
        public event EventHandler<LoggerEventArgs> Log;
        //在这里增加消息和日志
        public void AddMsg(int priority, string msg)
        {
            //这里引用临时变量是一个重要的安全措施，可预防多线程环境中的竞争条件
            //若是没有引用的副本，客户代码可能会在if判断语句和事件处理函数之间移
            //除事件处理函数,而复制引用之后即可避免这种情况
            EventHandler<LoggerEventArgs> l = Log;
            if (l != null)
                l(this, new LoggerEventArgs(priority, msg));
        }
    }

在这里AddMsg()是触发事件的方法，LoggerEventArgs类中定义了事件的优先级和消息内容，委托则为事件处理函数定义了签名。在Logger类内部，事件自动Log定义了事件处理函数。编译器看到这个字段后会自动创建对应的Add和Remove操作符，编译器生成的代码和下面类似：

        public class Logger
        {
            private EventHandler<LoggerEventArgs> log;

            public event EventHandler<LoggerEventArgs> Log
            {
                add { log = log + value; }
                remove { log = log - value; }
            }
            public void AddMsg(int priority, string msg)
            {
                EventHandler<LoggerEventArgs> l = log;
                if (l != null)
                    l(this, new LoggerEventArgs(priority, msg));
            }
        }

 

或者我们可以直接查看IL代码：

 

2.侦听者订阅事件

　　我们可以把日志信息订阅到标准错误控制台输出：

    class ConsoleLogger
    {
        static ConsoleLogger()
        {
            Logger.Singleton.Log += (sender, msg) =>
            {
                Console.Error.WriteLine("{0}:\t{1}", msg.Priority.ToString(), msg.message);
            };
        }
    }

或者是直接将日志记录到系统日志中：

    class EventLogger
    {
        private static Logger logger = Logger.Singleton;
        private static string eventSource;
        private static EventLog logDest = new EventLog();

        static EventLogger()
        {
            logger.Log += (sender, msg) =>
            {
                if (logDest != null)
                    logDest.WriteEntry(msg.message, EventLogEntryType.Information, msg.Priority);
            };
        }

        public static string Evensource
        {
            get { return eventSource; }
            set
            {
                eventSource = value;
                if (!EventLog.SourceExists(eventSource))
                    EventLog.CreateEventSource(eventSource, "Application");

                if (logDest != null)
                {
                    logDest.Dispose();
                    logDest = new EventLog();
                    logDest.Source = eventSource;
                }
            }
        }
    }

 运行程序：

            ConsoleLogger c = new ConsoleLogger();
            EventLogger.Evensource = "事件源？";
            EventLogger ee = new EventLogger();
            Logger.Singleton.AddMsg(10086, "这个Logger类创建的日志");

 

3.动态创建事件对象

 　　前面的Logger类只包含了一个事件，但有时候也有一些类(Windows控件)包含的事件数量非常多，这种情况下，为每个事件都定义一个字段的做法会显得比较臃肿。在某些情况下，只要很少的事件会在程序中真正起到作用，这时候我们需要根据运行时的需要来动态创建事件对象。

 　　根据前面的Logger类我们对其进行扩展，想Logger类中添加子系统，可以为每个子系统创建一个事件。客户则会注册到子系统中的事件。扩展后的Logger类包含了System.ComponentModel.EventHandlerList容器，存放所有的事件对象。

    public sealed class Logger
    {
        private static EventHandlerList Handlers = new EventHandlerList();

        static public void AddLogger(string system, EventHandler<LoggerEventArgs> ev)
        {
            Handlers.AddHandler(system, ev);
        }

        static public void RemoveLogger(string system, EventHandler<LoggerEventArgs> ev)
        {
            Handlers.RemoveHandler(system, ev);
        }

        /// <summary>
        /// 接收一个system字符串参数，用于指定产生日志的子系统
        /// 如果子系统有侦听者，事件会触发
        /// 同样，如果一个事件侦听者注册了所有消息，那么它的事件也会被触发
        /// </summary>
        /// <param name="system"></param>
        /// <param name="priority"></param>
        /// <param name="msg"></param>
        static public void AddMsg(string system, int priority, string msg)
        {
            if (!string.IsNullOrEmpty(system))
            {
                EventHandler<LoggerEventArgs> l = Handlers[system] as EventHandler<LoggerEventArgs>;

                LoggerEventArgs args = new LoggerEventArgs(priority, msg);
                if (l != null)
                    l(null, args);
                l = Handlers[""] as EventHandler<LoggerEventArgs>;
                if (l != null)
                    l(null, args);
            }
        }  
    }

 

 　　前面的EventHandlerList没有提供泛型的版本，所以其中有很多的类型转换操作。当客户代码关联到一个特定的子系统上，新的事件就会被创建。对于同一个子系统的后续请求会获取相同的事件对象。如果我们的类中有大量的事件，应该考虑使用这种事件处理函数集合。仅当客户代码真正注册有事件处理函数时，才会创建事件成员。在.NET Framework内部，System.Windows.Forms.Control类使用了一种复杂的方式，进而隐藏所有事件字段操作的复杂性。

　　EventHandlerList没有提供内建的泛型实现，我们可以基于Dictionary自行构造，泛型版本降低了类型转换的工作，但也增加了一些用来映射事件的代码，具体使用哪种方式，可以根据实际情况来考量：

    public sealed class Logger
    {
        private static Dictionary<string, EventHandler<LoggerEventArgs>> Handlers = new Dictionary<string, EventHandler<LoggerEventArgs>>();

        static public void AddLogger(string system, EventHandler<LoggerEventArgs> ev)
        {
            if (Handlers.ContainsKey(system))
                Handlers[system] += ev;
            else
                Handlers.Add(system, ev);
        }

        static public void RemoveLogger(string system, EventHandler<LoggerEventArgs> ev)
        {
            Handlers[system] -= ev;
        }

        static public void AddMsg(string system, int priority, string msg)
        {
            if (!string.IsNullOrEmpty(system))
            {
                EventHandler<LoggerEventArgs> l = null;
                Handlers.TryGetValue(system, out l);

                LoggerEventArgs args = new LoggerEventArgs(priority, msg);
                if (l != null)
                    l(null, args);
                //空字符串意味着接收所有消息
                l = Handlers[""] as EventHandler<LoggerEventArgs>;
                if (l != null)
                    l(null, args);
            }
        }  
    }

 

小节

事件提供了一种标准的机制来通知侦听者。.NET的事件模式使用了事件语法来实现观察者模式。任意数量的客户对象都可以将自己的处理函数注册到事件上，然后处理这些事件。这些客户对象不需要在编译器就给出，事件也不必非有订阅者才能正常工作。在C#中使用事件可以降低发送者和可能的通知接收者之间的耦合。发送者完全可以独立于接收者进行开发。事件是实现广播类型行为的标准方式。