ASP.NET服務器控件之控件狀態
下載本文源代碼
在上一篇文章中，我們討論了有關視圖狀態的內容。部分讀者已經發現，如果頁面或者控件禁用了視圖狀態，那么開發人員將無法保證利用ViewState存儲的狀態信息得以正常應用。這對于ViewState而言，的確是一個缺陷。為了解決這個問題，ASP.NET 2.0新增了一個技術特性--控件狀態。本文首先對控件狀態的基本概念進行介紹，然后通過一個典型示例，說明控件狀態應用方法。需要提醒讀者的是，在閱讀本文，理解控件狀態的之前，建議首先閱讀上一篇文章中視圖狀態的概念。
控件狀態概述
為了讓服務器控件正常工作，有時需要存儲控件狀態數據。例如，如果編寫了一個自定義控件，其中具有顯示不同信息的不同選項卡，為使該控件如預期一樣工作，控件需要知道在往返過程中選擇的是哪個選項卡。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。
應用控件狀態的方法比較簡單，其包括兩個關鍵過程：
（1）在初始化過程中（OnInit事件處理方法）調用RegisterRequiresControlState方法；
（2）重寫SaveControlState和LoadControlState方法。其中前者用于啟用并指示服務器控件使用控件狀態，后者用于維護控件狀態數據。
下面通過一個簡單的示例說明控件狀態的應用方法。具體代碼如下所示：
如上代碼所示，自定義服務器控件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頁框架為控件狀態提供了基礎，但是控件狀態是一個自定義的狀態保持機制。為了充分利用控件狀態，開發人員必須編寫代碼來保存和加載控件狀態。
典型應用
前文已經較為詳細的介紹了控件狀態的基本概念。本小節將通過一個示例說明控件狀態的應用方法，以便加深讀者對于基本概念的認識。
示例列舉了一個同時在控件狀態和視圖狀態中保存狀態的自定義控件IndexButton。在此示例中，IndexButton控件派生自Button類，還定義了一個IndexControlState屬性，并將該屬性值保存在控件狀態中。為了進行比較，IndexButton還定義了一個IndexInViewState屬性，該屬性存儲在ViewState字典中。控件實現具體源代碼如下所示：
如上代碼實現了一個繼承自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指令中設置了EnableViewState="false"，以便在頁面禁用視圖狀態。此時，頁面及頁面內的所有控件，包括IndexButton都無法使用視圖狀態。那么，當運行該頁面時應呈現怎樣的應用效果呢？具體頁面應用效果如圖1所示。
如圖1所示，當用戶單擊"IndexButton"按鈕時，由于頁面禁用了視圖狀態，因此，IndexInViewState屬性無法完成其實際功能，其屬性值將一直保持為0。然而，頁面禁用視圖狀態對于由控件狀態實現的屬性IndexControlState而言，則沒有絲毫影響。每當用戶單擊按鈕一次，那么個該屬性值增加1。
通過以上示例，相信讀者已經對視圖狀態和控件狀態有了更為深入的認識。然而，可能還是有一個疑問纏繞在心中：視圖狀態和控件狀態如此相似，那么該在何種情況下使用視圖狀態，又在何種情況下使用控件狀態呢？通常而言，視圖狀態當需要存儲少量回發到自身的頁信息時使用。使用ViewState屬性可提供具有基本安全性的功能。控件狀態當需要在服務器的往返過程間存儲少量控件狀態信息時使用。關鍵的一點是：應該對那些在回發過程中，對控件至關重要的少量關鍵數據使用控件狀態，而不要將控件狀態作為視圖狀態的備用選項使用。
小結
本文主要介紹了控件狀態的基本概念，并通過一個典型示例說明了這種技術特性的應用方法。需要再次提醒的是：僅對那些在回發過程中對控件至關重要的少量關鍵數據使用控件狀態，而不要將控件狀態作為視圖狀態的備用選項使用。這是開發人員應用視圖狀態和控件狀態的關鍵所在。
在上一篇文章中，我們討論了有關視圖狀態的內容。部分讀者已經發現，如果頁面或者控件禁用了視圖狀態，那么開發人員將無法保證利用ViewState存儲的狀態信息得以正常應用。這對于ViewState而言，的確是一個缺陷。為了解決這個問題，ASP.NET 2.0新增了一個技術特性--控件狀態。本文首先對控件狀態的基本概念進行介紹，然后通過一個典型示例，說明控件狀態應用方法。需要提醒讀者的是，在閱讀本文，理解控件狀態的之前，建議首先閱讀上一篇文章中視圖狀態的概念。
控件狀態概述
為了讓服務器控件正常工作，有時需要存儲控件狀態數據。例如，如果編寫了一個自定義控件，其中具有顯示不同信息的不同選項卡，為使該控件如預期一樣工作，控件需要知道在往返過程中選擇的是哪個選項卡。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。
應用控件狀態的方法比較簡單，其包括兩個關鍵過程：
（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頁框架為控件狀態提供了基礎，但是控件狀態是一個自定義的狀態保持機制。為了充分利用控件狀態，開發人員必須編寫代碼來保存和加載控件狀態。
典型應用
前文已經較為詳細的介紹了控件狀態的基本概念。本小節將通過一個示例說明控件狀態的應用方法，以便加深讀者對于基本概念的認識。
示例列舉了一個同時在控件狀態和視圖狀態中保存狀態的自定義控件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所示。
 圖1 |
如圖1所示，當用戶單擊"IndexButton"按鈕時，由于頁面禁用了視圖狀態，因此，IndexInViewState屬性無法完成其實際功能，其屬性值將一直保持為0。然而，頁面禁用視圖狀態對于由控件狀態實現的屬性IndexControlState而言，則沒有絲毫影響。每當用戶單擊按鈕一次，那么個該屬性值增加1。
通過以上示例，相信讀者已經對視圖狀態和控件狀態有了更為深入的認識。然而，可能還是有一個疑問纏繞在心中：視圖狀態和控件狀態如此相似，那么該在何種情況下使用視圖狀態，又在何種情況下使用控件狀態呢？通常而言，視圖狀態當需要存儲少量回發到自身的頁信息時使用。使用ViewState屬性可提供具有基本安全性的功能。控件狀態當需要在服務器的往返過程間存儲少量控件狀態信息時使用。關鍵的一點是：應該對那些在回發過程中，對控件至關重要的少量關鍵數據使用控件狀態，而不要將控件狀態作為視圖狀態的備用選項使用。
小結
本文主要介紹了控件狀態的基本概念，并通過一個典型示例說明了這種技術特性的應用方法。需要再次提醒的是：僅對那些在回發過程中對控件至關重要的少量關鍵數據使用控件狀態，而不要將控件狀態作為視圖狀態的備用選項使用。這是開發人員應用視圖狀態和控件狀態的關鍵所在。