ASP.NET服务器控件控件状态详解-asp.net控件

在ASP.NET服务器控件之视图状态文章中，我们讨论了有关视图状态的内容。部分读者已经发现，如果页面或者控件禁用了视图状态，那么开发人员将无法保证利用ViewState存储的状态信息得以正常应用。这对于ViewState而言，的确是一个缺陷。为了解决这个问题，ASP.NET 2.0新增了一个技术特性--ASP.NET服务器控件控件状态。本文首先对控件状态的基本概念进行介绍，然后通过一个典型示例，说明控件状态应用方法。需要提醒读者的是，在阅读本文，理解控件状态的之前，建议首先阅读ASP.NET服务器控件之视图中视图状态的概念。

ASP.NET服务器控件控件状态概述

为了让服务器控件正常工作，有时需要存储控件状态数据。例如，如果编写了一个自定义控件，其中具有显示不同信息的不同选项卡，为使该控件如预期一样工作，控件需要知道在往返过程中选择的是哪个选项卡。ViewState可用于此目的，但是，开发人员可能在页级别关闭了视图状态，从而有效地中断控件。为解决此问题，ASP.NET 2.0增加了一种称为"控件状态"的新功能。

总体而言，控件状态与视图状态有着很多类似之处，例如，二者都可以用于实现状态信息存储和管理，其相关数据都存储在一个或多个隐藏字段中等等。然而，控件状态的***特点是：控件状态不能被关闭，这一点与视图状态完全不同，同时，该技术特性仅为服务器控件范围使用，不能用于Web页面范围。当页面或者某个控件禁用了视图状态功能时（EnableViewState="false"），控件状态仍可照常使用，丝毫不受影响。而此时与视图状态有关的功能则会受到影响，无法工作了。由此可见，控件状态对于提高控件可靠性、灵活性等方面有着重要意义。

与视图状态相同，在控件状态中同样支持存储多多种数据类型对象，并且其默认支持的类型范围更加广泛。

具体包括的数据类型有：Array、DateTime、Int16、String、ArrayList、Double、Int32、String []、Boolean、Enum、null（Nothing）、System.String.Empty、Byte、Hashtable、Pair、Triplet、Char、HybridDictionary、Single、Type、Color、IDictionary。

应用ASP.NET服务器控件控件状态的方法比较简单，其包括两个关键过程：

（1）在初始化过程中（OnInit事件处理方法）调用RegisterRequiresControlState方法；

（2）重写SaveControlState和LoadControlState方法。其中前者用于启用并指示服务器控件使用控件状态，后者用于维护控件状态数据。

下面通过一个简单的示例说明控件状态的应用方法。具体代码如下所示：

public class Sample : Control {   
private int currentIndex = 0;  
// 重写OnInit事件处理程序   
protected override void OnInit(EventArgs e) {  
Page.RegisterRequiresControlState(this);  
base.OnInit(e);   
} // 重写SaveControlState方法  
protected override object SaveControlState() {  
return currentIndex != 0 ? (object)currentIndex : null;  
} // 重写LoadControlState方法  
protected override void LoadControlState(object state) {   
if (state != null) { currentIndex = (int)state; }  
}  
}

如上代码所示，自定义服务器控件Sample继承自Control，其重写了三个重要方法：OnInit、SaveControlState和LoadControlState。

在重写OnInit方法过程中，首先调用Page类的RegisterRequiresControlState方法，以指示自定义控件使用控件状态，然后再调用基类方法。SaveControlState方法用于保存自页回发到服务器后发生的任何服务器控件状态更改，其中参数state表示要还原的控件状态的Object。如代码所示，重写该方法主要实现了确定内部属性currentIndex是否设置为非默认值，如果是，则将值保存到控件状态。LoadControlState方法用于从SaveControlState方法保存的上一个页请求还原控件状态信息。如代码所示，重写该方法主要实现了确定以前是否为控件保存过控件状态，如果保存过，则将内部属性currentIndex设置为保存的值。

读者需要注意的是SaveControlState和LoadControlState方法。这是ASP.NET 2.0为Control类新增的成员方法。开发人员可通过重写这两个关键方法，以便实现对自定义服务器控件控件状态数据的管理和控制。在服务器控件执行过程中，SaveControlState方法在实现保存自定义视图状态数据的方法SaveViewState之前引发，LoadControlState方法在实现加载自定义视图状态数据的方法LoadViewState之前引发。
使用控件状态具有以下几个优点：

一、耗费的服务器资源较少（与Application、Session相比）。默认情况下，控件状态存储在页上的隐藏域中。

二、具有强大的可靠性。因为控件状态不像视图状态那样可以关闭，控件状态是管理控件状态信息的更可靠方法。

三、具有一定灵活性。开发人员可以编写程序来控制如何存储控件状态数据和控件状态数据的存储位置。

使用控件状态的主要缺点是需要一些编程。虽然ASP.NET页框架为ASP.NET服务器控件控件状态提供了基础，但是控件状态是一个自定义的状态保持机制。为了充分利用控件状态，开发人员必须编写代码来保存和加载控件状态。

#p#

ASP.NET服务器控件控件状态典型应用

前文已经较为详细的介绍了ASP.NET服务器控件控件状态的基本概念。本小节将通过一个示例说明控件状态的应用方法，以便加深读者对于基本概念的认识。

示例列举了一个同时在控件状态和视图状态中保存状态的自定义控件IndexButton。在此示例中，IndexButton控件派生自Button类，还定义了一个IndexControlState属性，并将该属性值保存在控件状态中。为了进行比较，IndexButton还定义了一个IndexInViewState属性，该属性存储在ViewState字典中。控件实现具体源代码如下所示：

using System;  
using System.ComponentModel;  
using System.Security.Permissions;  
using System.Web;  
using System.Web.UI;  
using System.Web.UI.WebControls;  
namespace WebControlLibrary{  
[ AspNetHostingPermission(SecurityAction.  
Demand, Level = AspNetHostingPermissionLevel.  
Minimal), AspNetHostingPermission  
(SecurityAction.InheritanceDemand,   
Level = AspNetHostingPermissionLevel.  
Minimal), ToolboxData("〈{0}:IndexButton   
runat=\"server\" 〉 〈/{0}:IndexButton 〉") ]  
public class IndexButton : Button {   
// 定义私有变量   
private int _indexInControlState;   
//利用控件状态实现属性  
IndexInControlState [ Bindable(true),   
Category("Behavior"), DefaultValue(0),   
Description("该属性使用控件状态存储.") ]  
public int IndexInControlState {  
get { return _indexInControlState; }   
set { _indexInControlState = value; }  
} //利用视图状态实现属性  
IndexInViewState [ Bindable(true),   
Category("Behavior"), DefaultValue(0),   
Description("该属性使用视图状态存储.") ]   
public int IndexInViewState {   
get {  
object obj = ViewState["IndexInViewState"];  
return (obj == null) ? 0 : (int)obj;  
}  
set {   
ViewState["IndexInViewState"] = value;  
}  
}  
//重写OnInit方法，启用页面控件状态   
protected override void OnInit(EventArgs e) {   
base.OnInit(e);  
Page.RegisterRequiresControlState(this);  
}  
//重写SaveControlState方法，保存控件状态数据   
protected override object SaveControlState() {  
object obj = base.SaveControlState();  
if (_indexInControlState != 0) {  
if (obj != null) {  
return new Pair(obj, _indexInControlState);   
} else {  
return (_indexInControlState); }  
} else { return obj; }  
}  
//重写LoadControlState方法，加载控件状态数据   
protected override void LoadControlState(object state) {  
if (state != null) {   
Pair p = state as Pair;  
if (p != null) {  
base.LoadControlState(p.First);   
_indexInControlState = (int)p.Second;  
} else {  
if (state is int) {  
_indexInControlState = (int)state;   
} else { base.LoadControlState(state); }  
}  
}  
}  
}  
}

如上代码实现了一个继承自Button基类的IndexButton控件，其中包括属性IndexControlState和IndexInViewState。根据代码实现可知，IndexInViewState属性利用了视图状态来存储值，而Index属性利用了控件状态来存储值。前者的实现非常简单，在此不再说明。后者的实现主要通过完成以下三个步骤，才使控件参与控件状态。

（1）重写OnInit方法并调用RegisterRequiresControlState方法向页面注册，以参与控件状态。需要注意的是：必须针对每个请求完成此任务。

（2）重写SaveControlState方法，以在控件状态中保存数据。

（3）重写LoadControlState方法，以从控件状态加载数据。此方法调用基类方法，并获取基类对控件状态的基值。如果_indexInControlState字段不为零，而且基类的控件状态也不为空，Pair类便可作为方便的数据结构使用，用来保存和还原由两部分组成的控件状态。

读者可以回想一下前一篇介绍视图状态文章中的示例。其中同样也定义了两个属性，一个是采用视图状态构建的TextInViewState属性，另一个是使用私有变量实现的Text属性。前者TextInViewState属性与上文示例中的IndexInViewState属性的实现方法几乎完全相同，其无非是利用ViewState存储属性值而已。然而，后者Text属性与上文示例的IndexInControlState属性虽然有些类似，例如，二者在实现过程中都使用了私有变量，但是，二者的本质不同。Text使用的是私有变量，而IndexInControlState使用的是控件状态，其关键是通过OnInit方法启用了控件状态功能，并重写SaveControlState和LoadControlState方法，以便自定义控件状态数据的保存和加载过程。建议读者在阅读本文的同时，也能够注意到本段所述内容。这对于理解视图状态和控件状态概念有着重要意义。

下面列举了为测试IndexButton控件而创建的Default.aspx页面源代码。

〈%@ Page Language="C#" EnableViewState="false"   
AutoEventWireup="true" CodeFile="Default.aspx.cs"   
Inherits="_Default" %  〉  
〈%@ Register Assembly="WebControlLibrary"   
Namespace="WebControlLibrary"   
TagPrefix="aspSample" %  〉  
〈script runat="server"  〉  
void Page_Load(object sender,   
EventArgs e) {  
　Label1.Text = (IndexButton1.  
IndexControlState++).ToString();  
　Label2.Text = (IndexButton1.  
IndexInViewState++).ToString();   
}  
〈/script  〉  
〈!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  〉使用视图状态和控件状态〈/title  〉  
〈/head  〉  
〈body  〉  
〈form id="form1" runat="server"  〉   
〈div  〉 请单击该按钮:   
〈aspSample:IndexButton Text="IndexButton"   
ID="IndexButton1" runat="server" /  〉   
〈br /  〉 〈br /  〉   
Index属性值是: 〈asp:Label ID="Label1"   
runat="server" Text="Label"  〉 〈/asp:Label  〉  
〈br /  〉 IndexInViewState属性值是:   
〈asp:Label ID="Label2" runat="server"   
Text="Label"  〉 〈/asp:Label  〉  
〈br /  〉  
〈/div  〉   
〈/form  〉  
〈/body  〉  
〈/html  〉

以上代码很简单。关键是读者要注意在@ Page指令中设置了EnableViewState="false"，以便在页面禁用视图状态。此时，页面及页面内的所有控件，包括IndexButton都无法使用视图状态。那么，当运行该页面时应呈现怎样的应用效果呢？具体页面应用效果如图1所示。

ASP.NET服务器控件
图1

如图1所示，当用户单击"IndexButton"按钮时，由于页面禁用了视图状态，因此，IndexInViewState属性无法完成其实际功能，其属性值将一直保持为0。然而，页面禁用视图状态对于由控件状态实现的属性IndexControlState而言，则没有丝毫影响。每当用户单击按钮一次，那么个该属性值增加1。

通过以上示例，相信读者已经对视图状态和控件状态有了更为深入的认识。然而，可能还是有一个疑问缠绕在心中：视图状态和控件状态如此相似，那么该在何种情况下使用视图状态，又在何种情况下使用控件状态呢？通常而言，视图状态当需要存储少量回发到自身的页信息时使用。使用ViewState属性可提供具有基本安全性的功能。控件状态当需要在服务器的往返过程间存储少量控件状态信息时使用。关键的一点是：应该对那些在回发过程中，对控件至关重要的少量关键数据使用控件状态，而不要将控件状态作为视图状态的备用选项使用。

小结

本文主要介绍了ASP.NET服务器控件控件状态的基本概念，并通过一个典型示例说明了这种技术特性的应用方法。需要再次提醒的是：仅对那些在回发过程中对控件至关重要的少量关键数据使用控件状态，而不要将控件状态作为视图状态的备用选项使用。这是开发人员应用视图状态和控件状态的关键所在。

【编辑推荐】