去掉DataGrid的ViewState中的无用数据

一、             DataGrid控件中的ViewState

   在Asp.Net中，我们使用最多的恐怕就是DataGrid列表控件了。这个控件的功能的却非常强大，也非常好用。它不但可以实现任意的格式化选择，而且还可以动态进行分页、排序、添加按钮、动态编辑等功能。可以说，DataGrid控件已经实现了我们需要的大部分功能。

   遗憾的是，上面说的很多非常实用的功能，大部分需要ViewState的支持，就是说DataGrid控件需要通过ViewState来保存控件的状态的，如果我们关闭了ViewState，即在HTML代码中使用了EnableViewState="False"属性，那么，上面的所有有用的功能我们将无法使用。

   而ViewState的缺点也是很大的，就是DataGrid会把所有的数据源中的数据存放到ViewState中。DataGrid是一个列表控件，它存放在ViewState中的数据包括了列表中所有单元格（Cell）中的数据，更加可恨的是，即时我们打开了分页功能，它也要把所有的没有显示出的数据源中的数据放到ViewState里面，如果不在数据库端控制数据量大小的话，DataGrid控件实际上是把数据库表中所有数据统统都存放在ViewState中。直接后果就是Asp.Net生成发送到客户端的源Html代码异常庞大。

   大家知道，Asp.Net中，ViewState实际上是一个名称/值对的字典，为了正确在各种编码的网页中保存，将ViewState序列化后又进行了Base64编码。这将更加加大ViewState的数据量。

   我试验了一下，一个包括5000条记录的数据库，如果不在数据库端控制数据量的话，直接使用Select * From TableName这样的Sql语句绑定数据的话，一个Asp.Net动态网页（仅有一个DataGrid控件的测试页）的ViewState有60k之多。而这样一个网页放到公共Web网站，缓慢的网页下载速度将会使大部分人望而却步，使用56k猫上网的人就更不要提了，根本无法访问这样的网页，等待的时间将不可忍受。

   所以大部分有Asp.Net开发经验的开发者，如果不使用DataGrid的高级功能的话，一般是把EnableViewState="False"属性给加入的，还有就是使用自己的分页控件，不使用DataGrid提供的分页功能，这将取消DataGrid的ViewState，大大减少最终生成的Html的代码量。

 

二、DataGrid中必须使用ViewState的一些功能

   不错，很多情况下我们仅需要DataGrid的显示列表数据的功能，或者使用自己的分页功能，这种情况下可以使用EnableViewState="False"属性，但是如果我们需要使用DataGrid的动态编辑、按钮列，或者要访问DataGrid的索引项时，我们必须把DataGrid的ViewState打开，这将不可避免的出现ViewState数据量过大的现象，但是我们没有办法。

   我大略统计了一下DataGrid中需要使用ViewState的一些功能属性，它们都必须使用ViewState，而这些属性我们很多情况下都必须使用：

DataGrid.CurrentPageIndex                     DataGrid分页的页索引

DataGrid.DataKeys                             取每个记录的键值

DataGrid.EditItemIndex                        编辑项的索引

DataGrid.Items                                DataGrid中行的集合

DataGrid.PageCount                            DataGrid分页的总页数

 

而在使用DataGrid内置事件时，传递事件参数的DataGridItemEventArgs、DataGridCommandEventArgs、DataGridSortCommandEventArgs、DataGridPageChangedEventArgs类更加要使用DataGrid的ViewState，否则它们将无法工作。

   这里我给一个简单的示例，在DataGrid中加入一个CheckBox列，这使当页面回发的时候我可以获取DataGrid的键值。但是如果关闭ViewState的话，此功能无法使用。

 

 

Html：

<Asp:DataGrid ID=”myDataGrid” Runat=”Server” DataKeyField=”ID” AutoGenerateColumns=”False”>

    <Columns>

       <asp:TemplateColumn>

           <ItemTemplate>

              <Asp:CheckBox ID=”myBox” Runat=”Server” />

           </ ItemTemplate>

       </ asp:TemplateColumn>

    </Columns>

</Asp:DataGrid>

<br /><br />

<Asp:Button ID=”bntSubmit” Runat=”Server” Text=”OK” />

 

Code：

private void btnSubmit_Click(object sender, System.EventArgs e)

{

    CheckBox cb;

    string str;

    for(int i=0;i<myDataGrid.tems.Count;i++)

    {

       cb = (CheckBox)myDataGrid.Items[i].Cells[2].FindControl("myBox");

       if(cb.Checked)

           str += myDataGrid.DataKeys[myDataGrid.Items[i].ItemIndex].ToString();

    }

    // 此时str变量就是DataGrid中选中行的数据库键值。

}

 

上面的代码使用很成功，不过如果在DataGrid中使用了EnableViewState=”False”属性，那么上面的代码根本无法起作用。

 

三、去掉ViewState中DataGrid的无用数据

   终于说到正题了，我这篇文章说的就是怎样去掉ViewState中的无用数据，而保留有用的数据。文章写到这里，我们可以很明显的看出来，DataGrid保存在ViewState中的数据分为两个部分，一部分是保存索引用的，就是DataKeys和DataItems这样的属性使用的数据，我们把它称之为索引数据。还有一部分是DataGrid中数据源的内容，我们称之为列表数据。

  我们如果把实际上无用的列表数据从ViewState中去除，这样可以大大减小页面ViewState的数据大小，使用DataGrid时ViewState数据量太大的根本原因就是列表数据存放在ViewState中。

  我在微软的.Net Framework SDK文档中没有找到关闭列表数据ViewState的任何内容，就是说微软没有给出DataGrid运行时的任何调用顺序和内部的工作机制。没办法，我使用了一个工具来获得DataGrid的内部工作流程，发现它在数据绑定初始化的时候，生成了一个叫DataGridTable的控件对象，这个对象是继承System.Web.UI.WebControls.Table控件的。而且这个对象是最先加入（使用Controls.Add()方法）DataGrid中的。而且ViewState中的DataGrid列表数据也是这个控件加入到DataGrid中的。实际上，ViewState中的DataGrid的单元格中的数据实际上是System.Web.UI.WebControls.Table控件的SaveViewState()方法给加进去的。这些数据很多情况下是不需要的。

   好，原因找到了，解决问题就好办了，因为微软已经给出了控制DataGrid中子控件的方法。我们既然知道DataGridTable控件是DataGrid中最先生成的控件，那么我们通过DataGrid.Controls属性就可以直接获取DataGrid中子控件的引用，获得引用后就可以控制子控件了。解决方法就是在数据绑定的时候，设置DataGrid中DataGridTable控件的EnableViewState属性为False就可以了。

代码如下：

首先必须重写DataGrid.ItemDataBound或DataGrid.ItemCreated事件，我们用它们来控制在向客户端写html之前DataGrid的动作。这两个事件任选其一，都可以实现效果。我们使用ItemDataBound事件来写例子，DataGrid示例ID为myDataGrid。

[C#]

首先在页面初始化中的InitializeComponent()方法内加入事件的委托：

private void InitializeComponent()

{

    this.myDataGrid.ItemDataBound +=

new DataGridItemEventHandler(this.myDataGrid_ItemDataBound);

}

然后在myDataGrid_ItemDataBound方法内加入控制代码：

private void myDataGrid_ItemDataBound(object sender, DataGridItemEventArgs e)

{

    myDataGrid.Controls[0].EnableViewState = false;

}

 

[VB.Net]

Private Sub myDataGrid_ItemDataBound(sender As Object,e As DataGridItemEventArgs) _

Handles myDataGrid.ItemDataBound

 

    myDataGrid.Contols.Item(0).EnableViewState = False

 

End Sub

 

好了，使用DataGrid时，把上面的代码加入，将减小使用DataGrid时ViewState的90%的数据量。而且，DataGrid中许多使用ViewState的功能丝毫不少，岂不是两全其美？

 

注意：

1.上面说的法子有一种情况下不能使用，就是使用DataGrid的内部分页功能时，重写DataGrid.PageIndexChanged事件时，调用DataGridPageChangedEventArgs时，必须把所有的ViewState打开，包括列表数据，关闭任何的ViewState，都将导致DataGridPageChangedEventArgs的索引丢失，无法分页。

不过这个缺点很好解决，很多人已经写了自定义的分页控件，这些控件是不需要DataGrid的任何数据的。可以提供非常完美的分页功能。

2. （重要）我春节的这几天对上面说的办法进行了详细的测试，发现上面的办法确实有效，可以大大的减少aspx页面的ViewState的数据量，但是这个办法在使用上有一个注意的地方，否则会出现数据无法显示的毛病。

我一直在奇怪，微软写DataGrid为什么要加入一个DataGridTable类，而且还要把所有的数据库数据存放在ViewState中。经过测试我才发现，这是因为有了System.Web.UI.Page.IsPostBack属性的缘故。我们经常喜欢利用Page.IsPostBack属性检测页面是否是第一次运行，如下代码：

private void Page_Load(object sender, System.EventArgs e)

{

    if(!Page.IsPostBack)

    {

       // 页面第一次运行,执行数据绑定

       SqlConnection conn = new SqlConnection(“...”);

       SqlCommand comm = new SqlCommand(“...”,conn);

       ...

       ...

       myDataGrid.DataBind() // 数据绑定

    }

}

当然，网页执行第一次时，DataGrid的内容正常显示，而使用了上面的去除ViewState方法后，页面如果回发处理，DataGrid的内容将会消失。我才明白DataGrid内DataGridTable把数据存放在ViewState内的用意。微软的设计是非常严谨的，他们的用意就是当使用Page.IsPostBack属性时，仅访问一次数据库就可以永久保持DataGrid的数据（在不离开此页面的情况下），数据存放的地点就是页面的ViewState中。这样页面回发后，DataGrid就可以从ViewState中重新生成DataGrid的显示内容，无需访问数据库。所以说微软以牺牲客户下载的速度（ViewState数据量）来保证服务器的资源，大家都知道频繁访问数据库对服务器的资源消耗很大。

所以，使用上面减少DataGrid的ViewState数据的法子是可行的，但是必须使所有的页面回发处理都必须进行数据绑定，否则DataGrid无法获得数据库内容，也无法获得ViewState中保存的数据，那么回发后DataGrid将无法显示任何内容。

总结，使用上面减少ViewState的办法可以大大加快客户端的下载显示速度，但是频繁的数据库访问将加大服务器的压力；使用ViewState可以减轻服务器的压力，但是又加大了客户端的下载时间，它们是互相矛盾的。所以开发者要根据实际情况选择是否使用DataGrid.Controls[0].EnableViewState=false;的法子，如何选择，大家请自己斟酌。

 

 

作者Blog： http://blog.csdn.net/TomMax/