复合控件和事件（6）——一点优化

上一篇：复合控件和事件（5）——你Call我应
在上一篇中我们了解了用常用的事件形式关联子控件事件的方法，今天我们要讲的则是对（5）中所提到的方法的一点优化。
今天的内容来自我们的事件，有没有想过：

 

        /**//// <summary>
        /// 定义ControlTextChanged事件
        /// </summary>
        [Category("ControlTextChanged"), Description("ControlTextChanged")]
        public event ControlEventHandler ControlTextChanged;
        protected virtual void OnControlTextChanged(ControlEventArgs e)
        {
            if (ControlTextChanged != null)
            {
                ControlTextChanged(this, e);
            }
        }

这样的代码在我们所做的复合控件中会有什么问题呢？
A：没有呀，上一篇中的示例不是运行地很好么？
B：是呀，一直都可以运行地很不错。
MS：如果您的类引发多个事件，并且您按引发事件中的说明对这些事件进行编程，编译器将为每个事件委托实例生成一个字段。如果事件的数目很大，则一个委托一个字段的存储成本可能无法接受。（ms-help://MS.VSCC.v80/MS.MSDN.v80/MS.VisualStudio.v80.chs/dv_fxfund/html/afdc53e2-bd41-499d-b11e-6652faed8594.htm）
在几种情况下，应用程序保持低的内存使用率很重要。自定义事件允许应用程序只为它处理的事件而使用内存。
默认情况下，当类声明事件时，编译器会将内存分配给一个字段，以存储事件信息。如果类具有许多未使用的事件，则它们会不必要地占用内存。（ms-help://MS.VSCC.v80/MS.MSDN.v80/MS.VisualStudio.v80.chs/dv_vbalr/html/87ebee87-260c-462f-979c-407874debd19.htm）
因此声明事件并不像我们声明一个对象那么省事，它是占资源的（普通对象在仅仅声明而不实例化new的时候在内存堆中并没有分配实际的内存空间）。

MSDN原文:
如何：声明保留内存使用的事件
(ms-help://MS.VSCC.v80/MS.MSDN.v80/MS.VisualStudio.v80.chs/dv_vbalr/html/87ebee87-260c-462f-979c-407874debd19.htm)
在几种情况下，应用程序保持低的内存使用率很重要。自定义事件允许应用程序只为它处理的事件而使用内存。

默认情况下，当类声明事件时，编译器会将内存分配给一个字段，以存储事件信息。如果类具有许多未使用的事件，则它们会不必要地占用内存。

您可以不使用 Visual Basic 提供的默认事件实现功能，而是使用自定义事件更细致地管理内存使用情况。

引发多个事件
(ms-help://MS.VSCC.v80/MS.MSDN.v80/MS.VisualStudio.v80.chs/dv_fxfund/html/afdc53e2-bd41-499d-b11e-6652faed8594.htm)
如果您的类引发多个事件，并且您按引发事件中的说明对这些事件进行编程，编译器将为每个事件委托实例生成一个字段。如果事件的数目很大，则一个委托一个字段的存储成本可能无法接受。对于这些情况，.NET Framework 提供一个称为事件属性的构造（Visual Basic 2005 中的自定义事件），此构造可以和（您选择的）另一数据结构一起用于存储事件委托。

事件属性由带事件访问器的事件声明组成。事件访问器是您定义的方法，用以允许事件委托实例添加到存储数据结构或从存储数据结构移除。请注意，事件属性要比事件字段慢，这是因为必须先检索每个事件委托，然后才能调用它。这是内存和速度之间的折中方案。如果您的类定义了许多不常引发的事件，那么您可能要实现事件属性。Windows 窗体控件和 ASP.NET 服务器控件使用事件属性而不是事件字段。

其实MS早在我们的复合控件中提供了“另一数据结构”来为我们“存储事件委托”
在Control类里面定义了Events

        //
        // 摘要:
        //     获取控件的事件处理程序委托列表。此属性为只读。
        //
        // 返回结果:
        //     事件处理程序委托的列表。
        protected EventHandlerList Events { get; }

注意到这里的Events是一个EventHandlerList类型，提供一个简单的委托列表，本文中我们将用到：

AddHandler  //将委托添加到列表。  
RemoveHandler  //从列表中将委托移除。  

两个方法来添加和移除委托，这个过程就像使用HashTable来保存数据，通过键值对进行读取的过程。因此我们将上一篇中的：

        /**//// <summary>
        /// 定义ControlTextChanged事件
        /// </summary>
        [Category("ControlTextChanged"), Description("ControlTextChanged")]
        public event ControlEventHandler ControlTextChanged;
        protected virtual void OnControlTextChanged(ControlEventArgs e)
        {
            if (ControlTextChanged != null)
            {
                ControlTextChanged(this, e);
            }
        }

改造成：

        /**//// <summary>
        /// 用于索引ControlTextChanged事件在事件列表中的位置的键
        /// </summary>
        private static readonly object controlTextChangedKey = new object();
        /**//// <summary>
        /// 定义ControlTextChanged事件
        /// </summary>
        [Category("ControlTextChanged"), Description("ControlTextChanged")]
        public event ControlEventHandler ControlTextChanged
        {
            add
            {
                //向事件列表中添加事件
                Events.AddHandler(controlTextChangedKey, value);
            }
            remove
            {
                //从事件列表中移除事件
                Events.RemoveHandler(controlTextChangedKey, value);
            }
        }
        /**//// <summary>
        /// 事件处理程序
        /// </summary>
        /// <param name="e">事件数据</param>
        protected virtual void OnControlTextChanged(ControlEventArgs e)
        {
            ControlEventHandler controlTextChangedEventDelegate = (ControlEventHandler)Events[controlTextChangedKey];
            if (controlTextChangedEventDelegate != null)
            {
                controlTextChangedEventDelegate(this, e);
            }
        }

这样做的好处就是当我们的控件中的事件个数不断激增的时候，我们一共只声明了一个事件列表，而不是为每个单独的事件分配一个存储事件信息的字段而不必要地侵袭掉宝贵的内存资源。
这样做的弊端还是需要被提及的，也就是之前MSDN中也有提到的，再COPY一下以正视听：

事件属性要比事件字段慢，这是因为必须先检索每个事件委托，然后才能调用它。这是内存和速度之间的折中方案。如果您的类定义了许多不常引发的事件，那么您可能要实现事件属性。

同时我们需要理解本段话的最后一句，“许多不常引发”“可能要”表明了这个方案的选择需要您根据实际情况进行取舍，比如本示例中，要不是因为演示，完全没必要使用本方案，因为我们仅有的一个事件，所谓的事件字段更高效，因此我们就没必要多此一举了。因此本文题目中所谓的“一点优化”也仅是对事件数量激增的时候进行的一种方法论了。

CompositeControl6.cs

using System;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.ComponentModel;

namespace ComponentWebControls
{
    //添加元数据可以使其显示在工具箱中
    [ToolboxData("<{0}:CompositeControl6 runat=\"server\" />")]
    public class CompositeControl6 : CompositeControl
    {
        private DropDownList ddl;

        /**//// <summary>
        /// 构造函数，为本示例提供了数据源
        /// </summary>
        public CompositeControl6()
        {
            EnsureChildControls();
            ddl.DataSource = GetData();
            ddl.DataBind();
        }

        public bool AutoPostBack
        {
            get
            {
                EnsureChildControls();
                return this.ddl.AutoPostBack;
            }
            set
            {
                EnsureChildControls();
                this.ddl.AutoPostBack = value;
            }
        }


        /**//// <summary>
        /// 用于索引ControlTextChanged事件在事件列表中的位置的键
        /// </summary>
        private static readonly object controlTextChangedKey = new object();
        /**//// <summary>
        /// 定义ControlTextChanged事件
        /// </summary>
        [Category("ControlTextChanged"), Description("ControlTextChanged")]
        public event ControlEventHandler ControlTextChanged
        {
            add
            {
                //向事件列表中添加事件
                Events.AddHandler(controlTextChangedKey, value);
            }
            remove
            {
                //从事件列表中移除事件
                Events.RemoveHandler(controlTextChangedKey, value);
            }
        }
        /**//// <summary>
        /// 事件处理程序
        /// </summary>
        /// <param name="e">事件数据</param>
        protected virtual void OnControlTextChanged(ControlEventArgs e)
        {
            ControlEventHandler controlTextChangedEventDelegate = (ControlEventHandler)Events[controlTextChangedKey];
            if (controlTextChangedEventDelegate != null)
            {
                controlTextChangedEventDelegate(this, e);
            }
        }

        /**//// <summary>
        /// 由 ASP.NET 页面框架调用，以通知使用基于合成的实现的服务器控件
        /// 创建它们包含的任何子控件，以便为回发或呈现做准备。 
        /// </summary>
        protected override void CreateChildControls()
        {
            //从当前服务器控件的 ControlCollection 对象中移除所有控件。 
            Controls.Clear();
            CreateControlHierarchy();
            //删除服务器控件的所有子控件的视图状态信息。 
            ClearChildViewState();
        }
        /**//// <summary>
        /// 创建并添加子控件
        /// </summary>
        protected virtual void CreateControlHierarchy()
        {
            this.ddl = new DropDownList();
            this.ddl.TextChanged += new EventHandler(ddl_TextChanged);
            this.Controls.Add(ddl);
        }

        private void ddl_TextChanged(object sender, EventArgs e)
        {
            ControlEventArgs cea = new ControlEventArgs();
            cea.Message = "ControlTextChanged!";
            OnControlTextChanged(cea);
        }

        private ListItemCollection GetData()
        {
            ListItemCollection lis = new ListItemCollection();
            lis.Add(new ListItem("Hello world!(DDLText)A", "aaa"));
            lis.Add(new ListItem("Hello world!(DDLText)B", "bbb"));
            lis.Add(new ListItem("Hello world!(DDLText)C", "ccc"));
            lis.Add(new ListItem("Hello world!(DDLText)D", "ddd"));
            return lis;
        }
    }
}

CompositeControl6.aspx

<%@ Page Language="C#" AutoEventWireup="true" CodeBehind="CompositeControl6.aspx.cs" Inherits="WebAppTestControls.CompositeControl6" %>

<%@ Register Assembly="ComponentWebControls" Namespace="ComponentWebControls" TagPrefix="cc1" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>CompositeControl6</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <cc1:CompositeControl6 ID="CompositeControl6_1" runat="server" OnControlTextChanged="CompositeControl6_1_ControlTextChanged">
        </cc1:CompositeControl6>
    
    </div>
    </form>
</body>
</html>

CompositeControl6.aspx.cs

using System;
using System.Data;
using System.Configuration;
using System.Collections;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;

namespace WebAppTestControls
{
    public partial class CompositeControl6 : System.Web.UI.Page
    {
        protected void Page_Load(object sender, EventArgs e)
        {
            if (!IsPostBack)
            {
                this.CompositeControl6_1.AutoPostBack = true;
            }
        }

        protected void CompositeControl6_1_ControlTextChanged(object sender, ComponentWebControls.ControlEventArgs e)
        {
            this.Response.Write(e.Message);
        }
    }
}

CompositeControl6.aspx.designer.cs

using System;
using System.Data;
using System.Configuration;
using System.Collections;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;

namespace WebAppTestControls
{
    public partial class CompositeControl6 : System.Web.UI.Page
    {
        protected void Page_Load(object sender, EventArgs e)
        {
            if (!IsPostBack)
            {
                this.CompositeControl6_1.AutoPostBack = true;
            }
        }

        protected void CompositeControl6_1_ControlTextChanged(object sender, ComponentWebControls.ControlEventArgs e)
        {
            this.Response.Write(e.Message);
        }
    }
}