ASP.NET服務(wù)器控件控件狀態(tài)詳解
在ASP.NET服務(wù)器控件之視圖狀態(tài)文章中，我們討論了有關(guān)視圖狀態(tài)的內(nèi)容。部分讀者已經(jīng)發(fā)現(xiàn)，如果頁(yè)面或者控件禁用了視圖狀態(tài)，那么開(kāi)發(fā)人員將無(wú)法保證利用ViewState存儲(chǔ)的狀態(tài)信息得以正常應(yīng)用。這對(duì)于ViewState而言，的確是一個(gè)缺陷。為了解決這個(gè)問(wèn)題，ASP.NET 2.0新增了一個(gè)技術(shù)特性--ASP.NET服務(wù)器控件控件狀態(tài)。本文首先對(duì)控件狀態(tài)的基本概念進(jìn)行介紹，然后通過(guò)一個(gè)典型示例，說(shuō)明控件狀態(tài)應(yīng)用方法。需要提醒讀者的是，在閱讀本文，理解控件狀態(tài)的之前，建議首先閱讀ASP.NET服務(wù)器控件之視圖中視圖狀態(tài)的概念。
ASP.NET服務(wù)器控件控件狀態(tài)概述
為了讓服務(wù)器控件正常工作，有時(shí)需要存儲(chǔ)控件狀態(tài)數(shù)據(jù)。例如，如果編寫(xiě)了一個(gè)自定義控件，其中具有顯示不同信息的不同選項(xiàng)卡，為使該控件如預(yù)期一樣工作，控件需要知道在往返過(guò)程中選擇的是哪個(gè)選項(xiàng)卡。ViewState可用于此目的，但是，開(kāi)發(fā)人員可能在頁(yè)級(jí)別關(guān)閉了視圖狀態(tài)，從而有效地中斷控件。為解決此問(wèn)題，ASP.NET 2.0增加了一種稱為"控件狀態(tài)"的新功能。
總體而言，控件狀態(tài)與視圖狀態(tài)有著很多類似之處，例如，二者都可以用于實(shí)現(xiàn)狀態(tài)信息存儲(chǔ)和管理，其相關(guān)數(shù)據(jù)都存儲(chǔ)在一個(gè)或多個(gè)隱藏字段中等等。然而，控件狀態(tài)的***特點(diǎn)是：控件狀態(tài)不能被關(guān)閉，這一點(diǎn)與視圖狀態(tài)完全不同，同時(shí)，該技術(shù)特性僅為服務(wù)器控件范圍使用，不能用于Web頁(yè)面范圍。當(dāng)頁(yè)面或者某個(gè)控件禁用了視圖狀態(tài)功能時(shí)（EnableViewState="false"），控件狀態(tài)仍可照常使用，絲毫不受影響。而此時(shí)與視圖狀態(tài)有關(guān)的功能則會(huì)受到影響，無(wú)法工作了。由此可見(jiàn)，控件狀態(tài)對(duì)于提高控件可靠性、靈活性等方面有著重要意義。
與視圖狀態(tài)相同，在控件狀態(tài)中同樣支持存儲(chǔ)多多種數(shù)據(jù)類型對(duì)象，并且其默認(rèn)支持的類型范圍更加廣泛。
具體包括的數(shù)據(jù)類型有：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。
應(yīng)用ASP.NET服務(wù)器控件控件狀態(tài)的方法比較簡(jiǎn)單，其包括兩個(gè)關(guān)鍵過(guò)程：
（1）在初始化過(guò)程中（OnInit事件處理方法）調(diào)用RegisterRequiresControlState方法；
（2）重寫(xiě)SaveControlState和LoadControlState方法。其中前者用于啟用并指示服務(wù)器控件使用控件狀態(tài)，后者用于維護(hù)控件狀態(tài)數(shù)據(jù)。
下面通過(guò)一個(gè)簡(jiǎn)單的示例說(shuō)明控件狀態(tài)的應(yīng)用方法。具體代碼如下所示：
- public class Sample : Control {
- private int currentIndex = 0;
- // 重寫(xiě)OnInit事件處理程序
- protected override void OnInit(EventArgs e) {
- Page.RegisterRequiresControlState(this);
- base.OnInit(e);
- } // 重寫(xiě)SaveControlState方法
- protected override object SaveControlState() {
- return currentIndex != 0 ? (object)currentIndex : null;
- } // 重寫(xiě)LoadControlState方法
- protected override void LoadControlState(object state) {
- if (state != null) { currentIndex = (int)state; }
- }
- }
如上代碼所示，自定義服務(wù)器控件Sample繼承自Control，其重寫(xiě)了三個(gè)重要方法：OnInit、SaveControlState和LoadControlState。
在重寫(xiě)OnInit方法過(guò)程中，首先調(diào)用Page類的RegisterRequiresControlState方法，以指示自定義控件使用控件狀態(tài)，然后再調(diào)用基類方法。SaveControlState方法用于保存自頁(yè)回發(fā)到服務(wù)器后發(fā)生的任何服務(wù)器控件狀態(tài)更改，其中參數(shù)state表示要還原的控件狀態(tài)的Object。如代碼所示，重寫(xiě)該方法主要實(shí)現(xiàn)了確定內(nèi)部屬性currentIndex是否設(shè)置為非默認(rèn)值，如果是，則將值保存到控件狀態(tài)。LoadControlState方法用于從SaveControlState方法保存的上一個(gè)頁(yè)請(qǐng)求還原控件狀態(tài)信息。如代碼所示，重寫(xiě)該方法主要實(shí)現(xiàn)了確定以前是否為控件保存過(guò)控件狀態(tài)，如果保存過(guò)，則將內(nèi)部屬性currentIndex設(shè)置為保存的值。
讀者需要注意的是SaveControlState和LoadControlState方法。這是ASP.NET 2.0為Control類新增的成員方法。開(kāi)發(fā)人員可通過(guò)重寫(xiě)這兩個(gè)關(guān)鍵方法，以便實(shí)現(xiàn)對(duì)自定義服務(wù)器控件控件狀態(tài)數(shù)據(jù)的管理和控制。在服務(wù)器控件執(zhí)行過(guò)程中，SaveControlState方法在實(shí)現(xiàn)保存自定義視圖狀態(tài)數(shù)據(jù)的方法SaveViewState之前引發(fā)，LoadControlState方法在實(shí)現(xiàn)加載自定義視圖狀態(tài)數(shù)據(jù)的方法LoadViewState之前引發(fā)。
使用控件狀態(tài)具有以下幾個(gè)優(yōu)點(diǎn)：
一、耗費(fèi)的服務(wù)器資源較少（與Application、Session相比）。默認(rèn)情況下，控件狀態(tài)存儲(chǔ)在頁(yè)上的隱藏域中。
二、具有強(qiáng)大的可靠性。因?yàn)榭丶顟B(tài)不像視圖狀態(tài)那樣可以關(guān)閉，控件狀態(tài)是管理控件狀態(tài)信息的更可靠方法。
三、具有一定靈活性。開(kāi)發(fā)人員可以編寫(xiě)程序來(lái)控制如何存儲(chǔ)控件狀態(tài)數(shù)據(jù)和控件狀態(tài)數(shù)據(jù)的存儲(chǔ)位置。
使用控件狀態(tài)的主要缺點(diǎn)是需要一些編程。雖然ASP.NET頁(yè)框架為ASP.NET服務(wù)器控件控件狀態(tài)提供了基礎(chǔ)，但是控件狀態(tài)是一個(gè)自定義的狀態(tài)保持機(jī)制。為了充分利用控件狀態(tài)，開(kāi)發(fā)人員必須編寫(xiě)代碼來(lái)保存和加載控件狀態(tài)。
#p#
ASP.NET服務(wù)器控件控件狀態(tài)典型應(yīng)用
前文已經(jīng)較為詳細(xì)的介紹了ASP.NET服務(wù)器控件控件狀態(tài)的基本概念。本小節(jié)將通過(guò)一個(gè)示例說(shuō)明控件狀態(tài)的應(yīng)用方法，以便加深讀者對(duì)于基本概念的認(rèn)識(shí)。
示例列舉了一個(gè)同時(shí)在控件狀態(tài)和視圖狀態(tài)中保存狀態(tài)的自定義控件IndexButton。在此示例中，IndexButton控件派生自Button類，還定義了一個(gè)IndexControlState屬性，并將該屬性值保存在控件狀態(tài)中。為了進(jìn)行比較，IndexButton還定義了一個(gè)IndexInViewState屬性，該屬性存儲(chǔ)在ViewState字典中。控件實(shí)現(xiàn)具體源代碼如下所示：
- 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;
- //利用控件狀態(tài)實(shí)現(xiàn)屬性
- IndexInControlState [ Bindable(true),
- Category("Behavior"), DefaultValue(0),
- Description("該屬性使用控件狀態(tài)存儲(chǔ).") ]
- public int IndexInControlState {
- get { return _indexInControlState; }
- set { _indexInControlState = value; }
- } //利用視圖狀態(tài)實(shí)現(xiàn)屬性
- IndexInViewState [ Bindable(true),
- Category("Behavior"), DefaultValue(0),
- Description("該屬性使用視圖狀態(tài)存儲(chǔ).") ]
- public int IndexInViewState {
- get {
- object obj = ViewState["IndexInViewState"];
- return (obj == null) ? 0 : (int)obj;
- }
- set {
- ViewState["IndexInViewState"] = value;
- }
- }
- //重寫(xiě)OnInit方法，啟用頁(yè)面控件狀態(tài)
- protected override void OnInit(EventArgs e) {
- base.OnInit(e);
- Page.RegisterRequiresControlState(this);
- }
- //重寫(xiě)SaveControlState方法，保存控件狀態(tài)數(shù)據(jù)
- 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; }
- }
- //重寫(xiě)LoadControlState方法，加載控件狀態(tài)數(shù)據(jù)
- 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); }
- }
- }
- }
- }
- }
如上代碼實(shí)現(xiàn)了一個(gè)繼承自Button基類的IndexButton控件，其中包括屬性IndexControlState和IndexInViewState。根據(jù)代碼實(shí)現(xiàn)可知，IndexInViewState屬性利用了視圖狀態(tài)來(lái)存儲(chǔ)值，而Index屬性利用了控件狀態(tài)來(lái)存儲(chǔ)值。前者的實(shí)現(xiàn)非常簡(jiǎn)單，在此不再說(shuō)明。后者的實(shí)現(xiàn)主要通過(guò)完成以下三個(gè)步驟，才使控件參與控件狀態(tài)。
（1）重寫(xiě)OnInit方法并調(diào)用RegisterRequiresControlState方法向頁(yè)面注冊(cè)，以參與控件狀態(tài)。需要注意的是：必須針對(duì)每個(gè)請(qǐng)求完成此任務(wù)。
（2）重寫(xiě)SaveControlState方法，以在控件狀態(tài)中保存數(shù)據(jù)。
（3）重寫(xiě)LoadControlState方法，以從控件狀態(tài)加載數(shù)據(jù)。此方法調(diào)用基類方法，并獲取基類對(duì)控件狀態(tài)的基值。如果_indexInControlState字段不為零，而且基類的控件狀態(tài)也不為空，Pair類便可作為方便的數(shù)據(jù)結(jié)構(gòu)使用，用來(lái)保存和還原由兩部分組成的控件狀態(tài)。
讀者可以回想一下前一篇介紹視圖狀態(tài)文章中的示例。其中同樣也定義了兩個(gè)屬性，一個(gè)是采用視圖狀態(tài)構(gòu)建的TextInViewState屬性，另一個(gè)是使用私有變量實(shí)現(xiàn)的Text屬性。前者TextInViewState屬性與上文示例中的IndexInViewState屬性的實(shí)現(xiàn)方法幾乎完全相同，其無(wú)非是利用ViewState存儲(chǔ)屬性值而已。然而，后者Text屬性與上文示例的IndexInControlState屬性雖然有些類似，例如，二者在實(shí)現(xiàn)過(guò)程中都使用了私有變量，但是，二者的本質(zhì)不同。Text使用的是私有變量，而IndexInControlState使用的是控件狀態(tài)，其關(guān)鍵是通過(guò)OnInit方法啟用了控件狀態(tài)功能，并重寫(xiě)SaveControlState和LoadControlState方法，以便自定義控件狀態(tài)數(shù)據(jù)的保存和加載過(guò)程。建議讀者在閱讀本文的同時(shí)，也能夠注意到本段所述內(nèi)容。這對(duì)于理解視圖狀態(tài)和控件狀態(tài)概念有著重要意義。
下面列舉了為測(cè)試IndexButton控件而創(chuàng)建的Default.aspx頁(yè)面源代碼。
- 〈%@ 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 〉使用視圖狀態(tài)和控件狀態(tài)〈/title 〉
- 〈/head 〉
- 〈body 〉
- 〈form id="form1" runat="server" 〉
- 〈div 〉 請(qǐng)單擊該按鈕:
- 〈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 〉
以上代碼很簡(jiǎn)單。關(guān)鍵是讀者要注意在@ Page指令中設(shè)置了EnableViewState="false"，以便在頁(yè)面禁用視圖狀態(tài)。此時(shí)，頁(yè)面及頁(yè)面內(nèi)的所有控件，包括IndexButton都無(wú)法使用視圖狀態(tài)。那么，當(dāng)運(yùn)行該頁(yè)面時(shí)應(yīng)呈現(xiàn)怎樣的應(yīng)用效果呢？具體頁(yè)面應(yīng)用效果如圖1所示。
圖1
如圖1所示，當(dāng)用戶單擊"IndexButton"按鈕時(shí)，由于頁(yè)面禁用了視圖狀態(tài)，因此，IndexInViewState屬性無(wú)法完成其實(shí)際功能，其屬性值將一直保持為0。然而，頁(yè)面禁用視圖狀態(tài)對(duì)于由控件狀態(tài)實(shí)現(xiàn)的屬性IndexControlState而言，則沒(méi)有絲毫影響。每當(dāng)用戶單擊按鈕一次，那么個(gè)該屬性值增加1。
通過(guò)以上示例，相信讀者已經(jīng)對(duì)視圖狀態(tài)和控件狀態(tài)有了更為深入的認(rèn)識(shí)。然而，可能還是有一個(gè)疑問(wèn)纏繞在心中：視圖狀態(tài)和控件狀態(tài)如此相似，那么該在何種情況下使用視圖狀態(tài)，又在何種情況下使用控件狀態(tài)呢？通常而言，視圖狀態(tài)當(dāng)需要存儲(chǔ)少量回發(fā)到自身的頁(yè)信息時(shí)使用。使用ViewState屬性可提供具有基本安全性的功能。控件狀態(tài)當(dāng)需要在服務(wù)器的往返過(guò)程間存儲(chǔ)少量控件狀態(tài)信息時(shí)使用。關(guān)鍵的一點(diǎn)是：應(yīng)該對(duì)那些在回發(fā)過(guò)程中，對(duì)控件至關(guān)重要的少量關(guān)鍵數(shù)據(jù)使用控件狀態(tài)，而不要將控件狀態(tài)作為視圖狀態(tài)的備用選項(xiàng)使用。
小結(jié)
本文主要介紹了ASP.NET服務(wù)器控件控件狀態(tài)的基本概念，并通過(guò)一個(gè)典型示例說(shuō)明了這種技術(shù)特性的應(yīng)用方法。需要再次提醒的是：僅對(duì)那些在回發(fā)過(guò)程中對(duì)控件至關(guān)重要的少量關(guān)鍵數(shù)據(jù)使用控件狀態(tài)，而不要將控件狀態(tài)作為視圖狀態(tài)的備用選項(xiàng)使用。這是開(kāi)發(fā)人員應(yīng)用視圖狀態(tài)和控件狀態(tài)的關(guān)鍵所在。
【編輯推薦】
