MS SQL Server 2005 通用分页存储过程

相信写过跟DB相关程序的人都会涉及的数据分页问题。从本质上来看，大概有两种方式：1）直接取记录集，分页显示所需数据 2）在数据库中分页，返回部分数据，优劣显而易见。

在sql server数据库中直接用在程序中嵌入sql语句也能达到很好的分页效果，但是效率、方便使用上不如存储过程。效率就不用多说了，取最大页码就是不是嵌入sql一次就能搞定的。

一年前在ms sql server 2000下写过一个分页存储过程，效果很好，至少至今还在被用户使用。今年开始接触2005版本，在t-sql上2005相对2000改进不少，觉得有必要改进我的分页存储过程了。

在一个月前写了这个存储过程，代码相对2000版本简化了很多：

2007-07-12 22:11:00 update

-- =============================================
-- Author:  黄剑平
-- Create date: 2007-5-11
-- Description: SQL 2005 版本 通用分页存储过程
-- BLOG:  http://www.fnsword.com/
-- =============================================
Create PROCEDURE [dbo].[Pagination]
@Page int = 1,      -- 当前页码
@PageSize int = 10,     -- 每页记录条数(页面大小)
@Table nvarchar(500),    -- 表名或视图名，甚至可以是嵌套SQL：(Select * From Tab Where ID>1000) Tab
@Field nvarchar(200) = '*',   -- 返回记录集字段名，","隔开，默认是"*"
@OrderBy nvarchar(100) = 'ID ASC', -- 排序规则
@Filter nvarchar(500),    -- 过滤条件
@MaxPage smallint output,   -- 执行结果 -1 error, 0 false, maxpage true
@TotalRow int output,    -- 记录总数 /* 2007-07-12 22:11:00 update */
@Descript varchar(100) output  -- 结果描述
AS
BEGIN
Set ROWCOUNT @PageSize;

Set @Descript = 'successful';
-------------------参数检测----------------
IF LEN(RTRIM(LTRIM(@Table))) !> 0
Begin
  Set @MaxPage = 0;
  Set @Descript = 'table name is empty';
  Return;
End

IF LEN(RTRIM(LTRIM(@OrderBy))) !> 0
Begin
  Set @MaxPage = 0;
  Set @Descript = 'order is empty';
  Return;
End

IF ISNULL(@PageSize,0) <= 0
Begin
  Set @MaxPage = 0;
  Set @Descript = 'page size error';
  Return;
End

IF ISNULL(@Page,0) <= 0
Begin
  Set @MaxPage = 0;
  Set @Descript = 'page error';
  Return;
End
-------------------检测结束----------------

Begin Try
  -- 整合SQL
  Declare @SQL nvarchar(4000), @Portion nvarchar(4000);

  Set @Portion = ' ROW_NUMBER() OVER (ORDER BY ' + @OrderBy + ') AS ROWNUM FROM ' + @Table;

  Set @Portion = @Portion + (CASE WHEN LEN(@Filter) >= 1 THEN (' Where ' + @Filter + ') AS tab') ELSE (') AS tab') END);

  Set @SQL = 'Select TOP(' + CAST(@PageSize AS nvarchar(8)) + ') ' + @Field + ' FROM (Select ' + @Field + ',' + @Portion;

  Set @SQL = @SQL + ' Where tab.ROWNUM > ' + CAST((@Page-1)*@PageSize AS nvarchar(8));

  -- 执行SQL, 取当前页记录集
  Execute(@SQL);
  --------------------------------------------------------------------

  -- 整合SQL
  Set @SQL = 'Set @Rows = (Select MAX(ROWNUM) FROM (Select' + @Portion + ')';

  -- 执行SQL, 取最大页码
  Execute sp_executesql @SQL, N'@Rows int output', @TotalRow output;
  Set @MaxPage = (CASE WHEN (@TotalRow % @PageSize)<>0 THEN (@TotalRow / @PageSize + 1) ELSE (@TotalRow / @PageSize) END);
End Try
Begin Catch
  -- 捕捉错误
  Set @MaxPage = -1;
  Set @Descript = 'error line: ' + CAST(ERROR_LINE() AS varchar(8)) + ', error number: ' + CAST(ERROR_NUMBER() AS varchar(8)) + ', error message: ' + ERROR_MESSAGE();
  Return;
End Catch;

-- 执行成功
Return;
END