asp.net mvc 自定义Pager实现分页
Intro
一个WEB应用程序中经常会用到数据分页，本文将实现一个简单通用的分页组件，包含一个 PagerModel (用来保存页码信息)，一个 HtmlHelper 的 Pager 扩展方法和一个 PagedListModel<T> 分页数据模型。
pager效果图如下：
PagerModel 分页模型
1 /// <summary> 2 /// PagerModel 分页模型 3 </summary> 4 public class PagerModel 5 { 6 int PageIndex { get; set; } 7 8 int PageSize { 9 10 int PageCount { private 11 12 int TotalCount { 13 14 public PagerModel(int totalCount) 15 { 16 PageIndex = 1; 17 PageSize = 1018 TotalCount = totalCount; 19 PageCount = Convert.ToInt32(Math.Ceiling(TotalCount * 1.0 / PageSize)); 20 } 21 22 int pageSize,23 24 PageIndex = 25 PageSize = pageSize; 26 TotalCount =27 PageCount = Convert.ToInt32(Math.Ceiling(TotalCount * 28 29 30 int pageIndex,1)">31 32 PageIndex = pageIndex; 33 PageSize =34 TotalCount =35 PageCount = Convert.ToInt32(Math.Ceiling(TotalCount * 36 37 }
/// <summary> /// PagerModel 分页模型 /// </summary> public class PagerModel { public int PageIndex { get; set; } public int PageSize { get; set; } public int PageCount { get; private set; } public int TotalCount { get; set; } public PagerModel(int totalCount) { PageIndex = 1; PageSize = 10; TotalCount = totalCount; PageCount = Convert.ToInt32(Math.Ceiling(TotalCount * 1.0 / PageSize)); } public PagerModel(int pageSize,int totalCount) { PageIndex = 1; PageSize = pageSize; TotalCount = totalCount; PageCount = Convert.ToInt32(Math.Ceiling(TotalCount * 1.0 / PageSize)); } public PagerModel(int pageIndex,int pageSize,int totalCount) { PageIndex = pageIndex; PageSize = pageSize; TotalCount = totalCount; PageCount = Convert.ToInt32(Math.Ceiling(TotalCount * 1.0 / PageSize)); } }
Pager扩展方法
Pager扩展方法 可根据自己的需求进行定制话实现，Pager扩展方法需要一个PagerModel类型的参数来生成页码，我这里是用的bootstrap的样式来做的分页，整个系统用的是同一个样式的分页所以把样式直接写死在代码里了。
Pager这里的代码重构做的不是太好：
- 样式直接写死，前端不好维护
PagerHelper 分页帮助类 static PagerHelper static MvcHtmlString Pager(this HtmlHelper helper,PagerModel pager) 7 8 StringBuilder sbHtmlText = new StringBuilder(); 9 sbHtmlText.Append("<div style=\"text-align:center\"><nav><ul class=\"pagination\">"); 10 if (pager.PageIndex <= ) 11 { 12 sbHtmlText.Append(<li class=\"disabled\"><a href=\"javascript:void()\" aria-label=\"PrevIoUs\"><span aria-hidden=\"true\">«</span></a></li>13 } 14 else 16 sbHtmlText.AppendFormat(<li><a href=\"javascript:loadData(1)\" aria-label=\"1\"><span aria-hidden=\"true\">«</span></a></li>",pager.PageIndex - 17 sbHtmlText.AppendFormat(<li><a href=\"javascript:loadData({0})\">{0}</a></li>18 19 sbHtmlText.AppendFormat(<li class=\"active\"><a href=\"javascript:void()\">{0}<span class=\"sr-only\">(current)</span></a></li>,pager.PageIndex); 20 if (pager.PageIndex >= pager.PageCount) 21 22 sbHtmlText.Append(<li class=\"disabled\"><a href=\"javascript:void()\" aria-label=\"Next\"><span aria-hidden=\"true\">»</span></a></li>24 25 26 sbHtmlText.AppendFormat(27 sbHtmlText.AppendFormat(<li><a href=\"javascript:loadData({0})\" aria-label=\"Next\"><span aria-hidden=\"true\">»</span></a></li>29 sbHtmlText.Append(</ul></nav>30 sbHtmlText.AppendFormat(<div><span>每页有<strong>{0}</strong>条数据，一共有<strong>{1}</strong>页，总计<strong>{2}</strong>条数据</span></div></div>31 return MvcHtmlString.Create(sbHtmlText.ToString()); 32 33 34 this HtmlHelper helper,PagerModel pager,Func<int,1)">string> onPageChange) 35 36 StringBuilder sbHtmlText = 37 sbHtmlText.Append(38 39 40 sbHtmlText.Append(41 42 43 44 sbHtmlText.AppendFormat(<li><a href=\"{0}\" aria-label=\"PrevIoUs\"><span aria-hidden=\"true\">«</span></a></li>)); 45 sbHtmlText.AppendFormat(<li><a href=\"{0}\">{1}</a></li>1),1)">46 47 sbHtmlText.AppendFormat(48 49 50 sbHtmlText.Append(51 52 53 54 sbHtmlText.AppendFormat(55 sbHtmlText.AppendFormat(<li><a href=\"{0}\" aria-label=\"Next\"><span aria-hidden=\"true\">»</span></a></li>56 57 sbHtmlText.Append(58 sbHtmlText.AppendFormat(59 60 61 }
/// <summary> /// PagerHelper 分页帮助类 /// </summary> public static class PagerHelper { public static MvcHtmlString Pager(this HtmlHelper helper,PagerModel pager) { StringBuilder sbHtmlText = new StringBuilder(); sbHtmlText.Append("<div style=\"text-align:center\"><nav><ul class=\"pagination\">"); if (pager.PageIndex <= 1) { sbHtmlText.Append("<li class=\"disabled\"><a href=\"javascript:void()\" aria-label=\"PrevIoUs\"><span aria-hidden=\"true\">«</span></a></li>"); } else { sbHtmlText.AppendFormat("<li><a href=\"javascript:loadData({0})\" aria-label=\"PrevIoUs\"><span aria-hidden=\"true\">«</span></a></li>",pager.PageIndex - 1); sbHtmlText.AppendFormat("<li><a href=\"javascript:loadData({0})\">{0}</a></li>",pager.PageIndex - 1); } sbHtmlText.AppendFormat("<li class=\"active\"><a href=\"javascript:void()\">{0}<span class=\"sr-only\">(current)</span></a></li>",pager.PageIndex); if (pager.PageIndex >= pager.PageCount) { sbHtmlText.Append("<li class=\"disabled\"><a href=\"javascript:void()\" aria-label=\"Next\"><span aria-hidden=\"true\">»</span></a></li>"); } else { sbHtmlText.AppendFormat("<li><a href=\"javascript:loadData({0})\">{0}</a></li>",pager.PageIndex + 1); sbHtmlText.AppendFormat("<li><a href=\"javascript:loadData({0})\" aria-label=\"Next\"><span aria-hidden=\"true\">»</span></a></li>",pager.PageIndex + 1); } sbHtmlText.Append("</ul></nav>"); sbHtmlText.AppendFormat("<div><span>每页有<strong>{0}</strong>条数据，一共有<strong>{1}</strong>页，总计<strong>{2}</strong>条数据</span></div></div>",pager.TotalCount); return MvcHtmlString.Create(sbHtmlText.ToString()); } }
public static MvcHtmlString Pager(this HtmlHelper helper,Func<int,string> onPageChange) { StringBuilder sbHtmlText = new StringBuilder(); sbHtmlText.Append("<div style=\"text-align:center\"><nav><ul class=\"pagination\">"); if (pager.PageIndex <= 1) { sbHtmlText.Append("<li class=\"disabled\"><a href=\"javascript:void()\" aria-label=\"PrevIoUs\"><span aria-hidden=\"true\">«</span></a></li>"); } else { sbHtmlText.AppendFormat("<li><a href=\"{0}\" aria-label=\"PrevIoUs\"><span aria-hidden=\"true\">«</span></a></li>",onPageChange(pager.PageIndex - 1)); sbHtmlText.AppendFormat("<li><a href=\"{0}\">{1}</a></li>",onPageChange(pager.PageIndex - 1),pager.PageIndex - 1); } sbHtmlText.AppendFormat("<li class=\"active\"><a href=\"javascript:void()\">{0}<span class=\"sr-only\">(current)</span></a></li>",pager.PageIndex); if (pager.PageIndex >= pager.PageCount) { sbHtmlText.Append("<li class=\"disabled\"><a href=\"javascript:void()\" aria-label=\"Next\"><span aria-hidden=\"true\">»</span></a></li>"); } else { sbHtmlText.AppendFormat("<li><a href=\"{0}\">{1}</a></li>",onPageChange(pager.PageIndex+1),pager.PageIndex + 1); sbHtmlText.AppendFormat("<li><a href=\"{0}\" aria-label=\"Next\"><span aria-hidden=\"true\">»</span></a></li>",onPageChange(pager.PageIndex + 1)); } sbHtmlText.Append("</ul></nav>"); sbHtmlText.AppendFormat("<div><span>每页有<strong>{0}</strong>条数据，一共有<strong>{1}</strong>页，总计<strong>{2}</strong>条数据</span></div></div>",pager.TotalCount); return MvcHtmlString.Create(sbHtmlText.ToString()); }
关于样式修改维护的问题，找到一种解决方案，可以将分页代码的样式封装在一个分部视图partial，在需要分页的页面视图，引用这个分部视图并且将分页模型信息 PagerModel 传递给这个分部视图
PagedListModel 分页数据模型
PagedListModel 用来封装返回到视图 View 的数据和 分页模型 PagerModel，实现代码如下
数据分页模型 4 <typeparam name="T">数据类型</typeparam> 5 class PagedListModel<T> where T : class,1)">() 6 7 public List<T> Data { 8 9 public PagerModel Pager { 10 }
public class PagedListModel<T> where T : class,new() { public List<T> Data { get; set; } public PagerModel Pager { get; set; } }
控制器数据处理
控制器处理代码如下：
search 是一个包含了 PageIndex 和 PageSize 的请求参数
1 int rowsCount = 0 2 try 3 4 List<Models.BlockEntity> blockList = BusinessHelper.BlockEntityHelper.GetPagedList(search.PageIndex,search.PageSize,1)">out rowsCount,whereLambda,b => b.BlockTime,1)">false 5 PagerModel pager = PagerModel(search.PageIndex,rowsCount); 6 PagedListModel<Models.BlockEntity> dataList = new PagedListModel<Models.BlockEntity>() { Pager = pager,Data = blockList }; 7 View(dataList); 8 9 catch (Exception ex) 10 logger.Error(ex); 12 throw13 }
int rowsCount = 0; try { List<Models.BlockEntity> blockList = new Business.BLLBlockEntity().GetPagedList(search.PageIndex,out rowsCount,false);//记录日志 PagerModel pager = new PagerModel(search.PageIndex,rowsCount);//定义Pager Model PagedListModel<Models.BlockEntity> dataList = new PagedListModel<Models.BlockEntity>() { Pager = pager,Data = blockList };//定义返回到 View 的 PagedListModel return View(dataList); } catch (Exception ex) { logger.Error(ex);//记录日志 throw; }
页面处理
首先在页面顶部声明 model 模型
@model PagedListModel<Models.BlockEntity>
在页面上遍历数据
@foreach (Models.BlockEntity item in Model.Data)
在需要添加分页信息的地方使用 HtmlHelper 的 Pager 扩展方法
@Html.Pager(Model.Pager)
View代码示例
1 @model PagedListModel<Models.BlockEntity> 2 table ="table table-hover" 3 thead 4 tr 5 th>黑名单类型</ 6 >黑名单内容 7 >拉入黑名单时间 8 >状态>操作11 12 tbody @foreach (Models.BlockEntity item in Model.Data) 14 string className = "bg-success"; 16 if (!item.IsActive) 17 className = "bg-danger"; 19 20 tr ="@className"21 td22 @item.BlockType.TypeName 23 24 @item.BlockValue 26 27 @item.BlockTime 29 30 @if (item.IsActive) { 33 span>启用34 } else { 37 >禁用38 39 40 42 43 button type="button" class='btn btn-warning' onclick="UpdateStatus('@item.BlockId','@item.BlockValue',-1,this)"button44 45 47 48 49 ="btn btn-danger" onclick="DeleteEntity('@item.BlockId',1)">>删除50 51 52 53 54 table55 @Html.Pager(Model.Pager)
