天天看點

ViewState 剖析

ViewState 不是什麼?

1. ViewState 不是用來恢複回發的控件的值。

這個是通過比對 form 中該控件的變量名而自動完成的。這個隻對 Load 事件加載之前建立的控件有效。

2. ViewState 不會自動重新建立任何通過代碼動态建立的控件。

3. 不是用來儲存使用者資訊的。僅僅儲存本頁的控件狀态,而不能在頁面之間傳遞。

ViewState 是什麼?

ViewState 用來跟蹤和儲存控件的狀态資訊。否則這些資訊可能會丢失,原因可能是這些值不随着 form 回發,或者根本就不在 page 的 html 中。

ViewState 中儲存着代碼中改變的控件屬性,通過代碼綁定到控件的任何資料,以及由使用者操作觸發,回發的任何更改。

ViewState 還提供了一個狀态包(StateBag), 這是一個特殊的集合或字典(collection or dictionary), 可以用來儲存,通過一個 key 來恢複任意的對象或者值。

ViewState 的格式

儲存在表單中的 __VIEWSTATE 隐藏字段。是 Base64 編碼過的,而不是加密!

但要加密也是可以的(設定 enableViewStateMac 來使用 machine key 進行 hash)

加密:設定 machineKey 驗證, 但這必須在機器級别設定,需要更多的資源,是以不推薦。

Listing 1: ViewState Machine Hash Disabled
machine.config or web.config: <pages enableViewStateMac='false' />
page level directive:         <%@Page enableViewStateMac='false' %>
page level script code:       Page.EnableViewStateMac = false;
           
Listing 2: ViewState Encryption is Enabled
machine.config: <machineKey validation='3DES' validationKey='*' />
where the validationKey must be the same across a web-farm setup
also requires the enableViewStateMac property setting to be true
           
Listing 3: ViewState Saved in Session State
protected override object LoadPageStateFromPersistenceMedium()
{
return Session["ViewState"];
}
protected override void SavePageStateToPersistenceMedium(object viewState)
{
Session["ViewState"] = viewState;
// Bug requires Hidden Form Field __VIEWSTATE
RegisterHiddenField("__VIEWSTATE", "");
}           
如果要把 ViewState 通過資料庫或其他持久化裝置來維持,則需要采用特定的 LosFormatter 類來序列化,反序列化。(serialize, deserialize)           
Listing 4: ViewState Saved in Custom Store
protected override object LoadPageStateFromPersistenceMedium()
{
LosFormatter format = new LosFormatter();
return format.Deserialize(YourDataStore["ViewState"]);
}
protected override void SavePageStateToPersistenceMedium(object viewState)
{
LosFormatter format = new LosFormatter();
StringWriter writer = new StringWriter();
format.Serialize(writer, viewState);
YourDataStore["ViewState"] = writer.ToString();
}
最後,我們來看一下 ViewState 的内部格式到底是什麼。
每個控件的 ViewState 儲存在一個三元組中(Triplet, System.Web.UI.Triplet).
其 First 對象是:
一個 Pair(System.Web.UI.Pair)
或
Array or Pairs, of ArrayLists of related name-values.
Second 對象:
該控件在控件樹中的索引的 ArrayList
Third 對象:
子控件的類似的三元組的 ArrayList           
Listing 5: ViewState Decode/Parse Example
編碼後的 ViewState:
dDwxMjM0NTY3ODkwO3Q8cDxsPHBycEE7cHJwQjtwcnBDOz47bDx2YWxBO3ZhbEI7dmFsQzs+PjtsPGk8
MD47aTwyPjtpPDM+O2k8NT47PjtsPHQ8cDxsPHBycEE7cHJwQjs+O2w8dmFsQTt2YWxCOz4+Ozs+O3Q8
cDxsPHBycEE7cHJwQjs+O2w8dmFsQTt2YWxCOz4+Ozs+O3Q8cDxsPHBycEE7cHJwQjs+O2w8dmFsQTt2
YWxCOz4+Ozs+O3Q8cDxsPHBycEE7cHJwQjs+O2w8dmFsQTt2YWxCOz4+Ozs+Oz4+Oz4=
解碼後的 ViewState:
t<1234567890;t<p<l<prpA;prpB;prpC;>;l<valA;valB;valC;>>;
l<i<0>;i<2>;i<3>;i<5>;>;l<
t<p<l<prpA;prpB;>;l<valA;valB;>>;;>;
t<p<l<prpA;prpB;>;l<valA;valB;>>;;>;
t<p<l<prpA;prpB;>;l<valA;valB;>>;;>;
t<p<l<prpA;prpB;>;l<valA;valB;>>;;>;>>;>
解析後的 ViewState:
t<1234567890;             頁面級别的三元組是特例
t<p<l<prpA;prpB;prpC;>; Triplet-First:Pair-First:ArrayList
l<valA;valB;valC;>                Pair-Second:ArrayList
>;
l<i<0>;               Triplet-Second:ArrayList:Indices
i<2>;                                        of the
i<3>;                                        Children
i<5>;                                        Controls
>;
l<t<p<l<prpA;prpB;>;  Triplet-Third:ArrayList:Triplets
l<valA;valB;>                           of the
>;                                       Children
;                                          Controls
>;
t<p<l<prpA;prpB;>;  Each Sub-Triplet follows same Pattern
l<valA;valB;>
>;
;                  More Levels Possible if sub-Children
>;
t<p<l<prpA;prpB;>;  Each Sub-Triplet follows same Pattern
l<valA;valB;>
>;
;                  More Levels Possible if sub-Children
>;
t<p<l<prpA;prpB;>;  Each Sub-Triplet follows same Pattern
l<valA;valB;>
>;
;                  More Levels Possible if sub-Children
>;
>
>;                     Closing of Special Page-Level Triplet
>
           
Listing 6: ViewState Decode/Parse Code
1using System;
2using System.Collections;
3using System.ComponentModel;
4using System.Data;
5using System.Drawing;
6using System.Web;
7using System.Web.SessionState;
8using System.Web.UI;
9using System.Web.UI.WebControls;
10using System.Web.UI.HtmlControls;
11using System.IO;
12using System.Text;
13
14namespace MyPlayground
15{
16	/// <summary>
17	/// ShowViewState 的摘要說明。
18	/// </summary>
19	public class ShowViewState : System.Web.UI.Page
20	{
21		private void Page_Load(object sender, System.EventArgs e)
22		{
23			//Trace.Warn("分類名稱", "^_^,這是警告!自動用紅色字顯示");
24			//Trace.Write("這是普通的消息寫入!");
25		}
26		#region Web 窗體設計器生成的代碼   ...
27
28		override protected void OnInit(EventArgs e)
29		{
30			//
31			// CODEGEN: 該調用是 ASP.NET Web 窗體設計器所必需的。
32			//
33			InitializeComponent();
34			base.OnInit(e);
35		}
36
37		/// <summary>
38		/// 設計器支援所需的方法 - 不要使用代碼編輯器修改
39		/// 此方法的内容。
40		/// </summary>
41		private void InitializeComponent()
42		{
43			this.Load += new System.EventHandler(this.Page_Load);
44
45		}
46		#endregion
47
48		protected override void SavePageStateToPersistenceMedium(object viewState)
49		{
50			// 調用基類的方法以便不影響正常的處理
51			base.SavePageStateToPersistenceMedium(viewState);
52			// 讀取 ViewState 并寫到頁面
53			LosFormatter format = new LosFormatter();
54			StringWriter writer = new StringWriter();
55			format.Serialize(writer, viewState);
56			string vsRaw = writer.ToString();
57			Response.Write("ViewState Raw: " + Server.HtmlEncode(vsRaw) + "<hr>");
58			// 解碼 ViewState 并寫到頁面
59			byte[] buffer = Convert.FromBase64String(vsRaw);
60			string vsText = Encoding.ASCII.GetString(buffer);
61			Response.Write("ViewState Text: " + Server.HtmlEncode(vsText) + "<hr>");
62			// 解析 ViewState -- 打開頁面跟蹤(Tracing)
63			ParseViewState(viewState, 0);
64		}
65		private void ParseViewState(object vs, int level)
66		{
67			if (vs == null)
68			{
69				Trace.Warn(level.ToString(), Spaces(level) + "null");
70			}
71			else if (vs.GetType() == typeof(System.Web.UI.Triplet))
72			{
73				Trace.Warn(level.ToString(), Spaces(level) + "Triplet");
74				ParseViewState((Triplet) vs, level);
75			}
76			else if (vs.GetType() == typeof(System.Web.UI.Pair))
77			{
78				Trace.Warn(level.ToString(), Spaces(level) + "Pair");
79				ParseViewState((Pair) vs, level);
80			}
81			else if (vs.GetType() == typeof(System.Collections.ArrayList))
82			{
83				Trace.Warn(level.ToString(), Spaces(level) + "ArrayList");
84				ParseViewState((IEnumerable) vs, level);
85			}
86			else if (vs.GetType().IsArray)
87			{
88				Trace.Warn(level.ToString(), Spaces(level) + "Array");
89				ParseViewState((IEnumerable) vs, level);
90			}
91			else if (vs.GetType() == typeof(System.String))
92			{
93				Trace.Warn(level.ToString(), Spaces(level) + "'" + vs.ToString() + "'");
94			}
95			else if (vs.GetType().IsPrimitive)
96			{
97				Trace.Warn(level.ToString(), Spaces(level) + vs.ToString());
98			}
99			else
100			{
101				Trace.Warn(level.ToString(), Spaces(level) + vs.GetType().ToString());
102			}
103		}
104		private void ParseViewState(Triplet vs, int level)
105		{
106			ParseViewState(vs.First, level + 1);
107			ParseViewState(vs.Second, level + 1);
108			ParseViewState(vs.Third, level + 1);
109		}
110		private void ParseViewState(Pair vs, int level)
111		{
112			ParseViewState(vs.First, level + 1);
113			ParseViewState(vs.Second, level + 1);
114		}
115		private void ParseViewState(IEnumerable vs, int level)
116		{
117			foreach (object item in vs)
118			{
119				ParseViewState(item, level + 1);
120			}
121		}
122
123		// 得到指定數目的空白
124		private string Spaces(int count)
125		{
126			string spaces = ""
127			for (int index = 0; index < count; index++)
128			{
129				spaces += "   "
130			}
131			return spaces;
132		}
133	}
134}