AutoEventWireup

大家好，又见面了，我是你们的朋友全栈君。

　　Google了一番，大家讨论AutoEventWireup 问题可不少，Page 指令的 AutoEventWireup 属性被设置为 true（或者如果缺少此属性，因为它默认为 true），该页框架将自动调用页事件，即 Page_Init 、 Page_Load等14个方法，在这种情况下，不需要任何显式的 Handles 子句或委托。但这是怎么实现的呢？.net又怎样根据AutoEventWireup 属性来动态编译或者预编译页面呢？我在Google上没有找到答案。

但Scott（K. Scott Allen） 的一篇文章 Inside AutoEventWireup说了当AutoEventWireup为true时，运行时会查找每个方法并注册到相应的事件里，代码就像下面这样：

bool ignoreCase = true;<br />bool throwOnFailure = false;<br />Delegate d = null;</p> <p>d = Delegate.CreateDelegate(<br /> typeof(EventHandler), this,<br /> “Page_Load”, ignoreCase,<br /> throwOnFailure<br /> );  

Scott说的非常好，但是运行时又是怎么实现的呢？没办法，又是一阵猛翻asp.net源码，终于找到了，代码如下：

private void BuildAutomaticEventHookup()<br />{ </p> <p> // Skip if we’re only generating the intermediate class<br /> if (_sourceDataClass == null)<br /> return; </p> <p> CodeMemberProperty prop; </p> <p> // If FAutoEventWireup is turned off, generate a SupportAutoEvents prop that<br /> // returns false.<br /> if (!Parser.FAutoEventWireup)<br /> {<br /> prop = new CodeMemberProperty();<br /> prop.Attributes &= ~MemberAttributes.AccessMask;<br /> prop.Attributes &= ~MemberAttributes.ScopeMask;<br /> prop.Attributes |= MemberAttributes.Override | MemberAttributes.Family;<br /> prop.Name = “SupportAutoEvents”;<br /> prop.Type = new CodeTypeReference(typeof(bool));<br /> prop.GetStatements.Add(new CodeMethodReturnStatement(new CodePrimitiveExpression(false)));<br /> _sourceDataClass.Members.Add(prop);<br /> return;<br /> }<br />}<br />

 BuildAutomaticEventHookup()方法当AutoEventWireup为false时生成了一个重载TemplateControl类的属性SupportAutoEvents，在TemplateControl里该属性返回true，重载代码如下：

protected override bool SupportAutoEvents<br />{<br /> get<br /> {<br /> return false;<br /> }<br />} </p> <p>

而在TemplateControl类里通过调用HookUpAutomaticHandlers（）方法来进行自动事件处理函数注册： 

internal void HookUpAutomaticHandlers()<br />{<br /> //SupportAutoEvents属性为false直接返回<br /> if (!SupportAutoEvents)<br /> {<br /> return;<br /> }<br /> // 从缓存获取事件列表<br /> object o = _eventListCache[GetType()];<br /> IDictionary dictionary = null;<br /> if (o == null)<br /> {<br /> lock (_lockObject)<br /> {<br /> //再次获取，可能另一线程缓存了 这是单例模式的实现<br /> o = _eventListCache[GetType()]; </p> <p> if (o == null)<br /> {<br /> dictionary = new ListDictionary(); </p> <p> GetDelegateInformation(dictionary); </p> <p> if (dictionary.Count == 0)<br /> {<br /> o = _emptyEventSingleton;<br /> }<br /> else<br /> {<br /> o = dictionary;<br /> }</p> <p> // 缓存<br /> _eventListCache[GetType()] = o;<br /> }<br /> }<br /> }</p> <p> if (o == _emptyEventSingleton)<br /> {<br /> return;<br /> }</p> <p> dictionary = (IDictionary)o;</p> <p> foreach (string key in dictionary.Keys)<br /> {<br /> EventMethodInfo info = (EventMethodInfo)dictionary[key]; </p> <p> Debug.Assert(_eventObjects[key] != null);</p> <p> bool eventExists = false;<br /> MethodInfo methodInfo = info.MethodInfo;</p> <p> Delegate eventDelegates = Events[_eventObjects[key]];<br /> if (eventDelegates != null)<br /> {<br /> foreach (Delegate eventDelegate in eventDelegates.GetInvocationList())<br /> {<br /> // 已经添加<br /> if (eventDelegate.Method.Equals(methodInfo))<br /> {<br /> eventExists = true;<br /> break;<br /> }<br /> }<br /> }<br /> if (!eventExists)<br /> {<br /> // 代理委托<br /> IntPtr functionPtr = methodInfo.MethodHandle.GetFunctionPointer();<br /> EventHandler handler = (new CalliEventHandlerDelegateProxy(this, functionPtr, info.IsArgless)).Handler;<br /> Events.AddHandler(_eventObjects[key], handler);<br /> }<br /> }<br />}<br />

而GetDelegateInformation（）方法通过多次调用后会调用到GetDelegateInformationFromMethod（）方法来实现根据相应方法（Page_Load等）建立委托，代码如下：

private bool GetDelegateInformationFromMethod(string methodName, IDictionary dictionary)<br />{<br /> // 第一步，找EventHandler签名的处理函数，类似protected void Page_Load(object sender, EventArgs e)<br /> //scott说的原理终于现形了，呵呵<br /> EventHandler e = (EventHandler)Delegate.CreateDelegate(typeof(EventHandler), this,<br /> methodName, true /*ignoreCase*/, false /*throwOnBindFailure*/);</p> <p> if (e != null)<br /> {<br /> dictionary[methodName] = new EventMethodInfo(e.Method, false);<br /> return true;<br /> } </p> <p> // 如果不是则找VoidMethod的形式了<br /> VoidMethod vm = (VoidMethod)Delegate.CreateDelegate(typeof(VoidMethod), this,<br /> methodName, true /*ignoreCase*/, false /*throwOnBindFailure*/);<br /> if (vm != null)<br /> {<br /> dictionary[methodName] = new EventMethodInfo(vm.Method, true);<br /> return true;<br /> }</p> <p> return false;<br />}<br />

  其中参数methodName就是我们通常使用的Page_Load等等方法名了，方法名是一个私有字符串常量，所以就不能在Page页重写了：

private const string _pagePreInitEventName = “Page_PreInit”;<br /> private const string _pageInitEventName = “Page_Init”;<br /> private const string _pageInitCompleteEventName = “Page_InitComplete”;<br /> private const string _pageLoadEventName = “Page_Load”;<br /> private const string _pagePreLoadEventName = “Page_PreLoad”;<br /> private const string _pageLoadCompleteEventName = “Page_LoadComplete”;<br /> private const string _pagePreRenderCompleteEventName = “Page_PreRenderComplete”;<br /> private const string _pageDataBindEventName = “Page_DataBind”;<br /> private const string _pagePreRenderEventName = “Page_PreRender”;<br /> private const string _pageSaveStateCompleteEventName = “Page_SaveStateComplete”;<br /> private const string _pageUnloadEventName = “Page_Unload”;<br /> private const string _pageErrorEventName = “Page_Error”;<br /> private const string _pageAbortTransactionEventName = “Page_AbortTransaction”;<br /> private const string _onTransactionAbortEventName = “OnTransactionAbort”;<br /> private const string _pageCommitTransactionEventName = “Page_CommitTransaction”;<br /> private const string _onTransactionCommitEventName = “OnTransactionCommit”;

说到这里我想再补充下，上面的方法名常量有16个，但是前面我说了只有14个方法，这又是怎么回事呢？
 

原来Page_Init，Page_Load，Page_DataBind，Page_PreRender，Page_Unload，Page_Error这六个方法无论TemplateControl实例是什么（TemplateControl实例可能是用户控件，或者页面，因为UserControl和Page类都是继承于TemplateControl类的）都会自动注册到相应的事件中去，而Page_PreInit，Page_InitComplete，Page_PreLoad，

Page_LoadComplete，Page_PreRenderComplete,Page_SaveStateComplete只有在TemplateControl实例同样是Page类实例的情况下才会自动注册到相应的事件中去。仔细看剩下的四个方法名，就会发现这是相对应的两组事件处理函数名，默认会添加Page_AbortTransaction和Page_CommitTransaction，如果找不到这两个方法则会查找OnTransactionAbort和OnTransactionCommit方法进行注册，所以说页面会自动注册14个事件处理函数到相应的事件中去（前提是只有这些方法都存在，才会添加成功哦）。

附注：AbortTransaction和CommitTransaction事件用于Enterprise Service Transactions的情况下(@Page指令必须含有Transaction属性，如Transaction=“Required”). 如果需要了解更多信息，可以看看意大利人Alberto Venditti 04年在codeproject上的这篇文章 .NET Distributed Transactions on Enterprise Services: a demo ，或者联系Scott（此Scott仍然是Allen，并非Scott Guthrie）,我看过他的博客，他可是这方面的行家。

原文：http://www.0431domain.cn/news/news.aspx/5193

//=================================================