開發自訂伺服器控制項時,正確管理子控制項的 **ViewState (視圖狀態)** 與 **ControlState (控制項狀態)** 是避免狀態污染、記憶體洩漏、異常行為的關鍵。System.Web.UI.Control 基類提供了一組 `ClearChild*` 系列方法,本文逐一剖析其內部實作、適用場景與最佳實踐。
| 方法 | 清理範圍 | 內部實作關鍵點 | 典型使用時機 |
|---|---|---|---|
ClearChildViewState() | 僅清除子控制項的 ViewState | 將 _occasionalFields.ControlsViewState 設為 null | DataBind 重建子控制項樹前、動態控制項結構變更時 |
ClearChildControlState() | 僅清除子控制項的 ControlState | 設定旗標 0x40000,呼叫 Page.RegisterRequiresClearChildControlState(this) | 實作 IPostBackDataHandler、需重置控制項狀態的自訂控制項 |
ClearChildState() | 同時清除 ViewState + ControlState | 依序呼叫上述兩方法 | 完整重建控制項樹 (如 GridView 換頁、排序) |
HasChildViewState (屬性) | 檢測是否有子控制項 ViewState | 檢查 ControlsViewState != null && Count > 0 | 優化:僅在有狀態時才清理,避免不必要分配 |
IsChildControlStateCleared (屬性) | 檢測子控制項 ControlState 是否已清除 | 檢查旗標 0x40000 | 內部框架判斷是否需重新註冊清理 |
public override void DataBind()
{
base.OnDataBinding(EventArgs.Empty);
// 1. 清除現有子控制項集合
Controls.Clear();
// 2. 清除子控制項 ViewState (關鍵!否則舊狀態會套用到新控制項)
ClearChildViewState();
// 3. 重新啟動 ViewState 追蹤 (從此刻開始記錄變更)
TrackViewState();
// 4. 重建控制項階層
CreateControlHierarchy(true); // true 表示使用資料來源
// 5. 標記子控制項已建立,避免 CreateChildControls 再次執行
ChildControlsCreated = true;
}
protected void ClearChildViewState()
{
if (this._occasionalFields != null)
{
// ControlsViewState 是 IDictionary,Key 為控制項 ID,Value 為該控制項的 StateBag
this._occasionalFields.ControlsViewState = null;
}
}
解讀:直接捨棄整個子控制項 ViewState 字典。下一次 SaveViewState 時,子控制項會被視為「新建立」,不會載入舊狀態。
protected void ClearChildControlState()
{
// ControlState >= Initialized 表示控制項已進入初始化階段,可能已註冊 ControlState
if (this.ControlState >= ControlState.Initialized)
{
// 設定內部旗標,標記「子控制項 ControlState 需清除」
this.flags.Set(0x40000);
if (this.Page != null)
{
// 向頁面註冊:在 SaveControlState 階段需清除子控制項狀態
this.Page.RegisterRequiresClearChildControlState(this);
}
}
}
關鍵差異:ControlState 不像 ViewState 可直接清空字典,它是由頁面在 SaveControlState 階段統一收集。RegisterRequiresClearChildControlState 讓頁面知道「這個父控制項要求清除子控制項的 ControlState」,頁面會在適當時機跳過收集該分支的 ControlState。
Page.RegisterRequiresControlState(control):控制項宣告「我有 ControlState 需持久化」,頁面會在 SaveControlState 時呼叫 control.SaveControlState()。Page.RegisterRequiresClearChildControlState(parent):內部方法,不可直接呼叫,只能透過 ClearChildControlState() 間接觸發。| 特性 | ViewState | ControlState |
|---|---|---|
| 可被開發者關閉 | ✅ (EnableViewState="false") | ❌ 永不關閉 |
| 用途 | UI 狀態 (展開/摺疊、排序欄位、分頁索引) | 核心功能必需狀態 (資料鍵、分頁總數、編輯索引) |
| 儲存時機 | SaveViewState 階段 | SaveControlState 階段 (早於 ViewState) |
protected override object SaveControlState()
{
// 基類狀態 + 自訂狀態打包為 Pair/Triplet 或自訂類別
return new Pair(base.SaveControlState(), new { CurrentPageIndex = _pageIndex, SortExpression = _sortExpr });
}
protected override void LoadControlState(object savedState)
{
var pair = (Pair)savedState;
base.LoadControlState(pair.First);
var state = (dynamic)pair.Second;
_pageIndex = state.CurrentPageIndex;
_sortExpr = state.SortExpression;
}
Page.RegisterRequiresControlState(this) → LoadControlState 永不被調用。this._occasionalFields.ControlsViewState 即時檢視 ViewState 字典內容。Control 基類的狀態清理方法看似簡單,實則精準對應 ASP.NET 頁面生命週期的狀態持久化管線。理解 ClearChildViewState (字典歸零) 與 ClearChildControlState (旗標 + 頁面註冊) 的機制差異,並在 DataBind/動態重建關鍵節點正確呼叫,是編寫健壯自訂伺服器控制項的核心功力。