创建用于ASP.NET的分页控件

　　从程序员的角度来看，Microsoft SQL Server? 查询的最大缺陷之一就是返回的行数通常比应用程序的用户界面实际可以容纳的行数要多得多。这种尴尬情形经常将开发人员陷于困境。开发人员是应该创建一个非常长的页面，让用户花时间去滚动浏览，还是应该通过设置一个手动分页机制来更好地解决这个问题？

　　哪种解决方案更好，在很大程度上取决于要检索的数据的特性。由多个项目（如搜索结果）组成的较长列表，最好通过各页大小相等、每页相对较短的多个页面显示。由单个项目（如文章的文本）组成的较长列表，如果整个插入在一个页面中，使用起来会更方便。最后得出的分析结果是，应该根据应用程序的总体用途来做决定。那么，Microsoft ASP.NET 是如何解决数据分页问题的呢？

　　ASP.NET 提供了功能强大的数据绑定控件，以便将查询结果格式化为 HTML 标记。但是，这些数据绑定控件中只有一种控件（即 DataGrid 控件）本来就支持分页。其他控件（如 DataList、Repeater 或 CheckBoxList）则不支持分页。这些控件及其他列表控件不支持分页，不是因为它们在结构上不支持分页，而是因为它们与 DataGrid 不同，不包含任何处理分页的特定代码。但是，处理分页的代码是相当样板化的，可以添加到所有这些控件中。

　　Scott Mitchell 在最近的一篇题目为“Creating a Pageable, Sortable DataGrid”的文章中，介绍了DataGrid分页。该文还引用了Web 上的其他有用信息，为您提供了有关网格分页基础知识和其他信息。如果想查看如何使 DataList 控件可以进行分页的示例，可以查看此文章（英文）。该文演示了如何创建一个自定义的 DataList 控件，该控件具有当前索引和页面大小属性，并可以启动页面更改事件。

　　同样的代码也可以用于满足其他列表控件（如 ListBox 和 CheckBoxList）的分页需要。不过，向各个控件添加分页功能实际上并不是一种非常好的做法，因为，如上所述，分页代码是相当样板化的。因此，对于聪明的程序员来说，有什么方法比使用一种新的通用分页程序控件来实现所有这些控件的分页功能更好的呢？

　　本文中将建立一个分页程序控件，它将使合作者列表控件能够对 SQL Server 的查询结果进行分页。该控件名为 SqlPager，它支持两种类型的合作者控件 - 列表控件和基础数据列表控件。

　　SqlPager控件的显著特点

　　SqlPager控件是一个 ASP.NET复合控件，包含一个单行表格。该行又包含两个单元格 - 导航条和页面描述符。该控件的用户界面呈条形，理想情况下，其宽度与合作者控件的宽度相同。导航条部分提供了可单击的元素，以便在页面之间移动；页面描述符部分为用户提供了有关当前显示的页面的一些反馈信息。


图 1：Visual Studio .NET 网页设计器中显示的 SqlPager 控件

　　与 DataGrid 控件的嵌入式分页程序一样，SqlPager 控件具有两种导航模式，即下一页/上一页和数字页面。此外，其特殊属性 PagerStyle 使您能够选择更方便的样式。该控件与列表控件协同工作。您可以通过 ControlToPaginate 字符串属性为分页程序指定一个这样的合作者控件。

SqlPager1.ControlToPaginate = "ListBox1";  

　　一般情况下，分页程序首先获取 SQL Server 的查询结果，准备一个适当的记录页面，然后通过合作者控件的 DataSource 属性显示该页面。当用户单击以查看新页面时，分页程序将检索请求的数据并再次通过合作者控件来显示数据。分页机制对于列表控件是完全透明的。列表控件的数据源是通过编程方式进行更新的，任何时候都只包含适合当前页面的记录。

　　控件的分页引擎具有多个 public 属性，如 CurrentPageIndex、ItemsPerPage 和 PageCount，通过这些属性来获取并设置当前页面的索引、每个页面的大小以及要显示的页面的总数。分页程序管理数据检索和分页所需的任何逻辑。

　　SelectCommand 属性设置获取数据所用的命令文本。ConnectionString 属性定义数据库的名称和位置以及连接凭据。执行查询时采用的方式取决于 PagingMode 属性的值。该属性的可能值为与其同名的 PagingMode 枚举的值 - Cached 和 NonCached。如果选择 Cached 选项，则将使用数据适配器和 DataTable 对象检索整个结果集。可以选择将结果集放置在 ASP.NET 的 Cache 对象中，该结果集可以重复使用直到过期。如果选择 NonCached 选项，则查询只检索适合当前页面的记录。这时，ASP.NET 的 Cache 中不放置任何数据。NonCached 模式与 DataGrid 控件的自定义分页模式几乎相同。

　　下表列出 SqlPager 控件的全部编程接口。

　　表 1：SqlPager 控件的编程接口

名称 类型 说明
CacheDuration 属性 指示数据在 ASP.NET 的缓存中保留的秒数。只用于 Cached 模式。默认值为60。
ConnectionString 属性 用来访问所选择的 SQL Server 数据库的连接字符串。  
ControlToPaginate 属性 同一个 .aspx 页面中的控件 ID，它将显示分页程序检索的记录页面。这是合作者控件。  
CurrentPageIndex 属性 获取并设置基于 0 的页面索引。
ItemsPerPage 属性 获取并设置每页要显示的记录数量。默认值为每页显示 10 个项目。
PagerStyle 属性 该值指示分页程序用户界面的样式。它可以为 PagerStyle 枚举值：NextPrev 和 NumericPages 之一。在 NextPrev 模式中，将显示 VCR 式的按钮，来转到第一页、上一页、下一页和最后一页。而在 NumericPages 模式中，将显示一个下拉列表，列出所有可用页面的索引。
PagingMode 属性 该值指示检索数据的方式。它可以为 PagingMode 枚举值：Cached 和 NonCached 之一。如果为 Cached，则将使用数据适配器，且整个结果集将临时放置在 ASP.NET 缓存中。如果为 NonCached，则只检索当前页面中的记录。在这种情况下，不进行缓存。  
SelectCommand 属性  用来进行查询的命令文本。最好为 SELECT-FROM-WHERE 形式。不支持 ORDER BY 子句。排序是通过 SortField 属性另外指定的。  
SortField 属性 用来排序的字段的名称。此字段用于为查询提供动态的 ORDER BY 子句。排序是由 SQL Server 执行的。
ClearCache 方法 删除存储在 ASP.NET 缓存中的任何数据。  
PageIndexChanged  事件 默认事件，当分页程序移动到另一个页面时发生。事件的数据结构为 PageChangedEventArgs 类，包含旧页面和新页面的索引。  
      
      

　　由于 SqlPager 控件继承了 WebControl，因此它也具有很多与 UI 相关的属性来管理字体、边框和颜色。
　　生成 SqlPager 控件

　　将作为复合控件来生成 SqlPager 控件并让其继承 WebControl 类。复合控件是 ASP.NET 服务器控件所特有的，它是由一个或多个服务器控件组成。

public class SqlPager : WebControl, INamingContainer
{ ... }

　　除非生成完全自定义的控件或扩展现有的控件，否则，创建新控件时，大多数时间实际上是在生成复合控件。要创建 SqlPager，组合一个 Table 控件，并根据分页程序的样式，组合几个 LinkButton 控件或者一个 DropDownList 控件。

　　生成复合控件时，需要注意几条原则。首先，需要覆盖 CreateChildControls protected 方法。CreateChildControls 方法是从 Control 继承来的，当服务器控件为了显示而要创建子控件时或在返回后，将调用此方法。

protected override void CreateChildControls()
{
　// 清除现有的子控件及其 ViewState
　Controls.Clear();
　ClearChildViewState();

　// 生成控件树
　BuildControlHierarchy();
}

　　覆盖此方法时，需要执行几项重要的操作。创建并初始化任何所需的子控件实例并将它们添加到父控件的 Controls 集合中。但是，生成新控件树之前，应该删除任何现有的子控件并清除子控件可能留下的任何 ViewState 信息。

　　复合组件还需要实现 INamingContainer 接口，以便 ASP.NET 运行时可以为其创建一个新的命名范围。这就确保了复合控件中的所有控件都具有唯一的名称。这还将确保能够自动处理子控件的返回数据。

　　对于 SqlPager 控件来说，成为命名容器非常重要。事实上，SqlPager 包含一些 LinkButton 控件，并且需要获取并处理其单击事件以便导航页面。正如 ASP.NET 页面中的任何其他控件一样，LinkButton 也被赋予了一个 ID，用于标识处理返回事件的控件。

　　处理返回事件时，ASP.NET 运行时试图查找事件的目标 ID 与主窗体的任何直接子控件之间是否存在匹配关系。LinkButton 是分页程序的子控件，因此不能运行其服务器端的代码。这是否意味着只有窗体的直接子控件才能启动并处理服务器事件？当然不是，只要您使用命名容器。

　　通过使 SqlPager 控件实现 INamingContainer 接口，可以将嵌入式链接按钮的实际 ID 从“First”更改为“SqlPager1:First”。当用户单击以查看新页面时，返回事件将 SqlPager1:First 作为目标控件。实际上，运行时用来识别目标控件的算法比上面介绍的要复杂一些。运行时将事件目标控件的名称看作是用冒号分隔开的字符串。实际上，这种匹配是在窗体的子控件和用冒号分隔开的字符串（如 SqlPager1:First）的第一个标记之间进行的。由于分页程序是窗体的子控件，因此匹配时会成功，分页程序获取单击事件。如果您认为这种解释不够充分或者令人费解，只要下载 SqlPager 控件的源代码，删除 INamingContainer 标记接口并进行重新编译即可。您将看到分页程序能够返回，但不能内部处理单击事件。

　　INamingContainer 接口是一个不具备方法的标记接口，其实现只需在类声明中指定名称即可，无需进行任何其他操作。

　　复合控件的另一个重要方面是，它们通常不需要自定义逻辑来进行显示。复合控件的显示遵循其组成控件的显示。生成复合控件时，通常无需覆盖 Render 方法。

　　控件的 SqlPager 树由一个包含两个单元格的单行表格组成。该表格继承了分页程序的大部分可视设置，如前景颜色和背景颜色、边框、字体信息和宽度等。第一个单元格包含导航条，其结构取决于 PagerStyle 属性的值。如果分页程序的样式为 NextPrev，则导航条将由四个 VCR 式的按钮组成。否则，它将由一个下拉列表组成。

private void BuildControlHierarchy()
{
　// 生成环境表格（一行，两个单元格）
　Table t = new Table();
　t.Font.Name = this.Font.Name;
　t.Font.Size = this.Font.Size;
　t.BorderStyle = this.BorderStyle;
　t.BorderWidth = this.BorderWidth;
　t.BorderColor = this.BorderColor;
　t.Width = this.Width;
　t.Height = this.Height;
　t.BackColor = this.BackColor;
　t.ForeColor = this.ForeColor;

　// 生成表格中的行
　TableRow row = new TableRow();
　t.Rows.Add(row);

　// 生成带有导航条的单元格
　TableCell cellNavBar = new TableCell();
　if (PagerStyle == this.PagerStyle.NextPrev)
　　BuildNextPrevUI(cellNavBar);
　else
　　BuildNumericPagesUI(cellNavBar);
　　row.Cells.Add(cellNavBar);

　// 生成带有页面索引的单元格
　TableCell cellPageDesc = new TableCell();
　cellPageDesc.HorizontalAlign = HorizontalAlign.Right;
　BuildCurrentPage(cellPageDesc);
　row.Cells.Add(cellPageDesc);

　// 将表格添加到控件树
　this.Controls.Add(t);
}  

　　将各个控件添加到正确的 Controls 集合对于分页程序的正确显示极其重要。最外层的表格必须添加到分页程序的 Controls 集合中。链接按钮和下拉列表必须添加到相应表格单元格的 Controls 集合中。

　　下面给出了用来生成链接按钮导航条的代码。每个按钮都显示有一个 Webdings 字符，可以根据需要禁用，并被绑定到内部的 Click 事件处理程序。

private void BuildNextPrevUI(TableCell cell)
{
　bool isValidPage = ((CurrentPageIndex ＞=0) &&
(CurrentPageIndex ＜= TotalPages-1));
　bool canMoveBack = (CurrentPageIndex＞0);
　bool canMoveForward = (CurrentPageIndex＜TotalPages-1);

　// 显示 ＜＜ 按钮
　LinkButton first = new LinkButton();
　first.ID = "First";
　first.Click += new EventHandler(first_Click);
　first.Font.Name = "webdings";
　first.Font.Size = FontUnit.Medium;
　first.ForeColor = ForeColor;
　first.ToolTip = "第一页";
　first.Text = "7";
　first.Enabled = isValidPage && canMoveBack;
　cell.Controls.Add(first);
:
}

　　分页程序的另一种样式（在下拉列表中列出数字页面）的生成方法如下所示：

private void BuildNumericPagesUI(TableCell cell)
{
　// 显示一个下拉列表
　DropDownList pageList = new DropDownList();
　pageList.ID = "PageList";
　pageList.AutoPostBack = true;
　pageList.SelectedIndexChanged += new EventHandler(PageList_Click);
　pageList.Font.Name = this.Font.Name;
　pageList.Font.Size = Font.Size;
　pageList.ForeColor = ForeColor;

　if (TotalPages ＜=0 || CurrentPageIndex == -1)
　{
　　pageList.Items.Add("No pages");
　　pageList.Enabled = false;
　　pageList.SelectedIndex = 0;
　}
　else // 填充列表
　{
　　for(int i=1; i＜=TotalPages; i++)
　　{
　　　ListItem item = new ListItem(i.ToString(), (i-1).ToString());
　　　pageList.Items.Add(item);
　　}
　　pageList.SelectedIndex = CurrentPageIndex;
　}
}

　　所有事件处理程序（Click 和 SelectedIndexChanged）最终都会更改当前显示的页面。这两种方法都会调用一个公用的 private 方法 GoToPage。

private void first_Click(object sender, EventArgs e)
{
　GoToPage(0);
}
private void PageList_Click(object sender, EventArgs e)
{
　DropDownList pageList = (DropDownList) sender;
　int pageIndex = Convert.ToInt32(pageList.SelectedItem.Value);
　GoToPage(pageIndex);
}
private void GoToPage(int pageIndex)
{
　// 准备事件数据
　PageChangedEventArgs e = new PageChangedEventArgs();
　e.OldPageIndex = CurrentPageIndex;
　e.NewPageIndex = pageIndex;

　// 更新当前的索引
　CurrentPageIndex = pageIndex;

　// 启动页面更改事件
　OnPageIndexChanged(e);

　// 绑定新数据
　DataBind();
}

　　其他导航按钮的处理程序与 first_Click 的区别仅在于它们传递给 GoToPage 方法的页码不同。GoToPage 方法负责处理 PageIndexChanged 事件，并负责启动数据绑定过程。它准备事件数据（旧页面和新页面索引）并触发事件。GoToPage 被定义为 private，但是可以使用 CurrentPageIndex 属性通过编程的方式更改显示的页面。

public int CurrentPageIndex
{
　get {return Convert.ToInt32(ViewState["CurrentPageIndex"]);}
　set {ViewState["CurrentPageIndex"] = value;}
}


　　与表 1 中所列的所有属性一样，CurrentPageIndex 属性的实现方法也相当简单。它将其内容保存到 ViewState 中并从中进行还原。在数据绑定过程中，会验证和使用页面索引。