Effective C# - 条款22：使用事件定义外发接口

事件为类型定义了外发接口（outgoing interface）。C#的事件建立在委托之上，委托为事件处理器（event handler）提供了类型安全的函数签名。由于绝大多数使用委托的例子都是事件，一些开发人员便开始认为事件和委托是同一种东西。在条款21中，我向大家展示了“可以使用委托，但却没有定义事件”的例子。当我们的类型必须和多个客户通信，并为它们提供系统中的行为通知时，我们才应该触发事件。

考虑一个简单的例子。我们正在创建一个日志类，来派发应用程序中的所有消息。它会从应用程序中的消息源接受所有消息，然后将它们派发给感兴趣的侦听者。这些侦听者可能会被连接到控制台、数据库、系统日志或者其他一些机制上。我们可以像下面这样定义这个类，当有消息到达时便触发一个事件：

public class LoggerEventArgs : EventArgs

{

public readonly string Message;

public readonly int Priority;

public LoggerEventArgs ( int p, string m )

{

Priority = p;

Message = m;

}

}

// 定义事件处理器的签名:

public delegate void AddMessageEventHandler( object sender,

LoggerEventArgs msg );

public class Logger

{

static Logger( )

{

_theOnly = new Logger( );

}

private Logger( )

{

}

private static Logger _theOnly = null;

public Logger Singleton

{

get

{

return _theOnly;

}

}

// 定义事件:

public event AddMessageEventHandler Log;

// 添加一个消息，并做日志记录。

public void AddMsg ( int priority, string msg )

{

// 下面将讨论这个惯常做法。

AddMessageEventHandler l = Log;

if ( l != null )

l ( null, new LoggerEventArgs( priority, msg ) );

}

}

AddMsg ()方法展示了触发事件的正确方法。其中，引用Log事件处理器的临时变量是一个重要的安全措施，它可以应对多线程环境中的竞争条件。如果没有这个引用的副本，客户代码可能会在if判断语句和事件处理器执行之间删除事件处理器。通过对引用的副本，这种事情就不会发生了。

LoggerEventArgs 类中定义了事件的优先级和消息内容。AddMessageEventHandler委托则为事件处理器定义了签名。在Logger类内部，事件字段Log 定义了事件处理器。编译器看到这个公有的事件字段定义后，会为我们创建对应的Add和Remove操作符。编译器产生的代码就好像我们编写了如下的代码一样：

public class Logger

{

private AddMessageEventHandler _Log;

public event AddMessageEventHandler Log

{

add

{

_Log = _Log + value;

}

remove

{

_Log = _Log - value;

}

}

public void AddMsg (int priority, string msg)

{

AddMessageEventHandler l = _Log;

if (l != null)

l (null, new LoggerEventArgs (priority, msg));

}

}

}

C#编译器会为我们定义的事件创建add和 remove访问器。我认为公有的事件声明更简练，更易于阅读和维护，也更正确。当我们在自己的类中创建事件时，应该声明公有事件，然后让编译器为我们创建add和remove属性。只有在需要添加额外的规则时，我们才应该自己编写这些处理代码。

事件并不需要知道潜在的侦听者。下面的类会自动将所有消息发送给标准错误控制台：

class ConsoleLogger

{

static ConsoleLogger()

{

logger.Log += new AddMessageEventHandler( Logger_Log );

}

private static void Logger_Log( object sender,

LoggerEventArgs msg )

{

Console.Error.WriteLine( "{0}:\t{1}",

msg.Priority.ToString(),

msg.Message );

}

}

下面的类则可以将消息输出到系统事件日志中：

class EventLogger

{

private static string eventSource;

private static EventLog logDest;

static EventLogger()

{

logger.Log +=new AddMessageEventHandler( Event_Log );

}

public static string EventSource

{

get

{

return eventSource;

}

set

{

eventSource = value;

if ( ! EventLog.SourceExists( eventSource ) )

EventLog.CreateEventSource( eventSource,

"ApplicationEventLogger" );

if ( logDest != null )

logDest.Dispose( );

logDest = new EventLog( );

logDest.Source = eventSource;

}

}

private static void Event_Log( object sender,

LoggerEventArgs msg )

{

if ( logDest != null )

logDest.WriteEntry( msg.Message,

EventLogEntryType.Information,

msg.Priority );

}

}

事件发生时，它会通知所有感兴趣的客户对象。因此，Logger类不需要预先知道哪些对象对日志事件感兴趣。

Logger 类只包含了一个事件。但也有一些类（绝大多数是Windows控件）包含的事件数量非常多。这时候，为每个事件都定义一个字段的做法是不可接受的。在某些情况下，只有很少的事件会在程序中真正发挥作用。当遇到这种情况时，我们可以改变设计，根据运行时的需要动态创建事件对象。

.NET框架内核在Windows控件子系统中包含有这方面的做法示例。为了演示其中的做法，这里会向Logger类添加一些子系统。我们可以为每个子系统创建一个事件。客户则会登记和它们的子系统相关的事件。

扩展后的Logger类包含一个 System.ComponentModel.EventHandlerList容器，该容器中存储着所有的事件对象，这些事件将会针对具体的子系统来被触发。更新后的AddMsg()方法现在接受一个字符串参数，用于指定产生日志消息的子系统。如果子系统有侦听者，那么事件就会被触发。另外，如果一个事件侦听者登记了所有的消息，它的事件也会被触发：

public class Logger

{

private static System.ComponentModel.EventHandlerList

Handlers = new System.ComponentModel.EventHandlerList();

static public void AddLogger(

string system, AddMessageEventHandler ev )

{

Handlers[ system ] = ev;

}

static public void RemoveLogger( string system )

{

Handlers[ system ] = null;

}

static public void AddMsg ( string system,

int priority, string msg )

{

if ( ( system != null ) && ( system.Length > 0 ) )

{

AddMessageEventHandler l =

Handlers[ system ] as AddMessageEventHandler;

LoggerEventArgs args = new LoggerEventArgs(

priority, msg );

if ( l != null )

l ( null, args );

// 空字符串意味着接受所有消息:

l = Handlers[ "" ] as AddMessageEventHandler;

if ( l != null )

l( null, args );

}

}

}

上面的代码会在EventHandlerList 集合中存储各个事件处理器。当客户代码关联到一个特定的子系统上时，新的事件对象就会被创建。对同一个子系统的后续请求会获取相同的事件对象。如果我们的类在其接口中包含有大量的事件，我们就应该考虑使用这样的事件处理器集合。当客户代码真正关联有事件处理器时，我们才会创建事件成员。在.NET框架内部，System.Windows.Forms.Control类使用了一种更复杂的实现，来隐藏所有事件字段操作的复杂性。每一个事件字段在内部会通过访问一个对象集合，来添加和删除特定的处理器。大家可以在C#语言规范（参见条款49）中找到有关这种常见做法的更多信息。

综上所述，我们使用事件来定义类型中的外发接口，任意数量的客户对象都可以将自己的处理器登记到事件上，然后处理它们。这些客户对象不需要在编译时存在。事件也不必非要有订阅者才能正常工作。在C#中使用事件可以对发送者和可能的通知接受者进行解耦。发送者可以完全独立于接收者进行开发。事件是一种广播类型行为信息的标准方式。

条款21：使用委托表达回调

我：“孩子，去院子里铲草，我要读会儿书。”

Scott：“爸爸，我已经把院子打扫干净了。”

Scott：“爸爸，我为割草机充上气了。”

Scott：“爸爸，割草机不能启动。”

我：“我来启动它。”

Scott：“爸爸，我搞好了。”

上面一段很短的交流演示了回调（callback）的概念。我给自己的小孩一个任务，他在完成任务期间不断地打断我。在等待他完成任务的每一部分的过程中，我不需要停下我自己的工作。当他有一个重要（或者不重要）的状态需要报告，或者需要我的协助时，他可以周期性地打断我。回调用于为服务器和客户机之间提供异步的反馈。这中间可能会牵扯到多线程，或者需要为同步更新提供一个入口点。在C#中，回调使用委托来表达。

委托为我们提供了类型安全的回调定义。虽然大多数常见的委托应用都和事件有关，但那并不是C#委托应用场合的全部。当类之间有通信的需要，并且我们期望一种比接口更为松耦合的机制时，委托便是最合适的选择。委托允许我们在运行时配置目标，并可通知多个客户对象。委托对象中包含一个方法引用，该方法可以是静态方法，也可以是实例方法。使用委托，我们可以和一个或多个在运行时配置的客户对象进行通信。

可以将所有包含单个函数调用的委托对象组合为多播委托（multicast delegate）。但在这种构造中有两点需要我们注意：第一，如果有委托调用出现异常，那么这种构造将不能保证安全；第二，整个调用的返回值将为最后一个函数调用的返回值。

在一个多播委托调用中，每一个目标会被顺次调用。委托对象本身不会捕捉任何异常。因此，任何目标抛出的异常都会结束委托链的调用。

返回值也有类似的问题。我们定义的委托可以有具体的返回类型（非void）。例如，我们可能会编写一个回调来检查用户是否要异常结束：

public delegate bool ContinueProcessing();

public void LengthyOperation( ContinueProcessing pred )

{

foreach( ComplicatedClass cl in _container )

{

cl.DoLengthyOperation();

// 检查用户是否要异常结束:

if (false == pred())

return;

}

}

作为单个委托，上面的代码工作得很好，但是如果作为多播委托使用，就会出现问题：

ContinueProcessing cp = new ContinueProcessing (

CheckWithUser );

cp += new ContinueProcessing( CheckWithSystem );

c.LengthyOperation( cp );

多播委托返回的值是委托链上最后一个函数调用的返回值。所有其他的返回值都会被忽略。例如，上面代码中CheckWithUser()的返回值就会被忽略。

我们可以自己调用委托链上的每个委托目标，从而避免上述两个问题。所创建的每一个委托都包含一个委托链表。要检查委托链并调用每一个目标，我们需要自己遍历调用链表：

public delegate bool ContinueProcessing();

public void LengthyOperation( ContinueProcessing pred )

{

bool bContinue = true;

foreach( ComplicatedClass cl in _container )

{

cl.DoLengthyOperation();

foreach( ContinueProcessing pr in

pred.GetInvocationList( ))

bContinue &= pr();

if (false == bContinue)

return;

}

}

在上面的代码中，我们要求每一个委托调用都为true时遍历才能继续。

委托为我们提供了一种在运行时进行回调的最好方式，这种方式对客户类只有非常简单的要求。我们可以在运行时配置委托目标。另外，委托也支持多个客户目标。在.NET中，客户回调应该使用委托来实现。