巧用ViewState属性【附示例代码】

【示例代码下载】当我们在页面中使用ViewState ，通常是用一个属性表示，例如：

1. private int ViewState_UserID 
2. { 
3.     get { return (int) ViewState["UserId"]; } 
4.     set { ViewState["UserId"] = value; } 
5. } 

写这样一组代码感觉比较麻烦,如果能像下面这样简单地使用就好了。

1. [ViewStateProperty("UserID")] 
2. protected int ViewState_UserID { get; set;} 

或者

1. [ViewStateProperty] 
2. protected int ViewState_UserID { get; set;} 

这里介绍一种超级简单的方式去实现：使用Attribute。

第一步：创建BasePage 类，它继承System.Web.UI.Page。这里使用了Reflection和LINQ。

1. using System.Reflection; 
2. using System.Linq; 
3. public class BasePage : System.Web.UI.Page 

第二步：在BasePage中使用一个内部类ViewStateProperty ，这个类继承Attribute 。用Attribute的目的是描述页面中哪个属性是viewstate属性。用这个属性来标识viewstate属性，因此它应该BasePage内部。 

1. [AttributeUsage(AttributeTargets.Property)] 
2. public class ViewStateProperty : Attribute 
3. { 
4.     public string ViewStateName { get; private set; } 
5.  
6.     internal ViewStateProperty(){ 
7.         this.ViewStateName = string.Empty; 
8.     } 
9.  
10.     public ViewStateProperty(string in_ViewStateName){ 
11.         this.ViewStateName = in_ViewStateName; 
12.     } 
13. } 

[AttributeUsage(AttributeTargets.Property)]意味着这个attribute 只对property类型可用。在public ViewStateProperty(string in_ViewStateName)中初始化ViewState 的名称。默认情况下，ViewState 的名字为空。如果你想在设置attribute的时候初始化ViewState的名字时，要将默认构造函数设置为私有的。

第三步：在BasePage中，创建一个ViewStateProperties变量来存储有ViewStateProperty标签的属性，在BasePage默认构造函数中初始化它们：

1. private PropertyInfo ViewStateProperties; 
2. protected BasePage()  
3. { 
4.     this.ViewStateProperties = GetType().GetProperties( 
5.       BindingFlags.NonPublic | BindingFlags.Instance).Where( 
6.       p => p.GetCustomAttributes(typeof(ViewStateProperty), true).Length > 0).ToArray(); 
7. } 

GetType().GetProperties(BindingFlags.NonPublic | BindingFlags.Instance)通过反射获得所有的public 和protected属性 。Where(p=>p.GetCustomAttributes(typeof(ViewStateProperty), true).Length > 0)用来过滤有ViewStateProperty修饰的属性。

第四步： 在BasePage中重载LoadViewState 和SaveViewState方法

1. protected override void LoadViewState(object savedState) 
2. { 
3.     base.LoadViewState(savedState); 
4.     foreach (PropertyInfo property in ViewStateProperties) 
5.     { 
6.         ViewStateProperty attributes = (ViewStateProperty) 
7.           property.GetCustomAttributes(typeof(ViewStateProperty), false); 
8.         var LocalName = (string.Empty == attributes[0].ViewStateName) ?  
9.            property.Name : attributes[0].ViewStateName; 
10.         if (ViewState[LocalName] != null) 
11.             property.SetValue(this, ViewState[LocalName], null); 
12.     } 
13. } 
14.  
15. protected override object SaveViewState() 
16. { 
17.     foreach (PropertyInfo property in ViewStateProperties) 
18.     { 
19.         ViewStateProperty attributes = (ViewStateProperty) 
20.           property.GetCustomAttributes(typeof(ViewStateProperty), false); 
21.         var LocalName = (string.Empty == attributes[0].ViewStateName)?  
22.           property.Name:attributes[0].ViewStateName; 
23.         ViewState[LocalName] = property.GetValue(this, null); 
24.     } 
25.     return base.SaveViewState(); 
26. } 

目的是根据name设置viewstate值，这个name设置在ViewStateProperty标签上，加载ViewState的值，并赋值给有ViewStateProperty修饰的属性

使用它：

1. [ViewStateProperty("UserID")] 
2. protected int ViewState_UserID { get; set;} 

或者：

1. [ViewStateProperty] 
2. protected int ViewState_UserID { get; set;} 

在第一个，设置一个名为UserID的ViewState，第二个，您设置名为ViewState_UserID的ViewState。

注意：要实现这样的属性，您不能将它们设置为私有的，因为 GetType().GetProperties(BindingFlags.NonPublic | BindingFlags.Instance) 不能返回private 属性，设置为protected足以满足我们的需要。