ABP入门系列之分页功能的实现

完成了任务清单的增删改查，咱们来讲一讲必不可少的的分页功能。

首先很庆幸abp已经帮我们封装了分页实现，实在是贴心啊。

来来来，这一节咱们就来捋一捋如何使用abp的进行分页吧。

1. 分页请求dto定义

数据传输对象(data transfer objects)用于应用层和展现层的数据传输。

展现层传入数据传输对象(dto)调用一个应用服务方法，接着应用服务通过领域对象执行一些特定的业务逻辑并且返回dto给展现层。这样展现层和领域层被完全分离开了。在具有良好分层的应用程序中，展现层不会直接使用领域对象(仓库，实体)。

我们在展现层有分页请求时，一般需要指定两个参数，一个用来标志第几页、一个是每页行数（一般有配置文件配置）。

因为分页是一个很常用的功能，所以，展现层我们有分页请求时，最好有相应的dto来封装这两个参数。

在abp源码中并没有为我们封装这样公用的类，但是在abpzero项目中，定义了相应的分页dto。

对应的类图如下：

分页排序过滤相应dto类图

从中可以看到主要包括以下四个公共dto定义：

1. pagedinputdto：分页请求dto
2. pagedandsortedinputdto：分页排序dto
3. pagedsortedandfilteredinputdto：分页排序过滤dto
4. pagedandfilteredinputdto：分页过滤dto

是不是很实用，我们的分页一般是和过滤排序混合使用的。

其中主要定义了以下几个主要属性：

• maxresultcount：每页行数，可以从定义的配置中读取。
• skipcount：跳转数量，一般计算公式为skipcount=page*maxresultcount（页数*行数）。
• filter：过滤字符串
• sorting：排序方式

具体的实现就不详述了，相信仔细看类图，就能自己动手实现。abpzero把这些公共dto定义在了应用服务层的dto文件夹下，具体路径如下图。

2. 如何使用分页dto

拿我们的任务清单举例，我们修改下创建的gettaskinputdto，让它继承自pagedsortedandfilteredinputdto，这样gettaskinputdto就拥有了进行分页排序过滤需要用到的属性。

public class gettasksinput : pagedsortedandfilteredinputdto
{
 public taskstate? state { get; set; }
 public int? assignedpersonid { get; set; }
}

3. 返回分页结果dto

abp已经为我们定义了泛型的pagedresultdto用来包装返回的分页结果。其中主要包括两个属性，int totalcount保存总个数，ireadonlylist<t> items保存返回的分页结果集。

4. 应用服务层分页逻辑实现

1、 在itaskappservice中定义接口

pagedresultdto<taskdto> getpagedtasks(gettasksinput input);

2、 在taskappservice中实现接口：

public pagedresultdto<taskdto> getpagedtasks(gettasksinput input)
{
 //初步过滤
 var query = _taskrepository.getall().include(t => t.assignedperson)
  .whereif(input.state.hasvalue, t => t.state == input.state.value)
  .whereif(!input.filter.isnullorempty(), t => t.title.contains(input.filter))
  .whereif(input.assignedpersonid.hasvalue, t => t.assignedpersonid == input.assignedpersonid.value);
 //排序
 query = !string.isnullorempty(input.sorting) ? query.orderby(input.sorting) : query.orderbydescending(t => t.creationtime);
 //获取总数
 var taskscount = query.count();
 //默认的分页方式
 //var tasklist = query.skip(input.skipcount).take(input.maxresultcount).tolist();
 //abp提供了扩展方法pageby分页方式
 var tasklist = query.pageby(input).tolist();
 return new pagedresultdto<taskdto>(taskscount,tasklist.mapto<list<taskdto>>());
}

分页的实现很简单，先进行过滤，排序，再进行分页，最后使用pagedresultdto封装分页结果。

细心的你也许发现了两个未曾在linq中用过的方法whereif和pageby，是的，这是abp提供的扩展方法，感兴趣的可以看下源码queryableextensions的具体实现，其实实现的很简单，但我们平时在使用linq时却未必能想得到。

在这里提几个问题：

请问在这段代码*进行了几次查询？

代码中使用的是什么分页技术？（真分页？假分页？）

5. 使用x.pagedlist进行前端分页

在asp.net mvc中进行前端分页有一系列开源实现，在我的demo中使用的是开源的x.pagedlist分页。想了解具体源码，请参考x.pagedlist github。

1、请自行在web项目中安装x.pagedlist.mvc nuget程序包

x.pagedlist.mvc nuget程序包

2、在controller中使用x.pagedlist提供的方法构造分页结果供前端使用

因为我们在应用服务层已经手动实现了分页逻辑，所以按照x.pagedlist官网示例，我们需要自行构造staticpagedlist作为返回结果。

 public actionresult pagedlist(int? page)
 {
  //每页行数
  var pagesize = 5;
  var pagenumber = page ?? 1;//第几页
  var filter = new gettasksinput
  {
   skipcount = (pagenumber - 1) * pagesize,//忽略个数
   maxresultcount = pagesize
  };
  var result = _taskappservice.getpagedtasks(filter);
  //已经在应用服务层手动完成了分页逻辑，所以需手动构造分页结果
  var onepageoftasks = new staticpagedlist<taskdto>(result.items, pagenumber, pagesize, result.totalcount);
  //将分页结果放入viewbag供view使用
  viewbag.onepageoftasks = onepageoftasks;
  return view();
}

从代码中可以看到我们构造完x.pagedlist提供的分页结果后放入了viewbag中，供视图使用。

3、view中添加分页控件

pagedlist视图的代码如下：

@using x.pagedlist.mvc;
@using abp.web.mvc.extensions
@using x.pagedlist; 
<link href="~/content/pagedlist.css" rel="external nofollow" rel="stylesheet" />
<ul class="list-group">
 @foreach (var task in viewbag.onepageoftasks)
 {
  <li class="list-group-item">
   <div class="btn-group pull-right">
    <button type="button" class="btn btn-info">edit</button>
    <button type="button" class="btn btn-success">delete</button>
   </div>
   <div class="media">
    <a class="media-left" href="#" rel="external nofollow" >
     @*<i class="fa @model.gettasklable(task) fa-3x"></i>*@
    </a>
    <div class="media-body">
     <h4 class="media-heading">@task.title</h4>
     <span class="text-muted">@task.creationtime.tostring("yyyy-mm-dd hh:mm:ss")</span>
    </div>
   </div>
  </li>
 }
</ul>
@html.pagedlistpager((ipagedlist)viewbag.onepageoftasks, page => url.action("pagedlist", new { page }))

其中最后一句代码是用来生成分页控件。

最终效果如图：

总结

总结

本节主要讲解了如何使用abp进行后台分页，并顺带讲解了abp后台分页逻辑的实现方式。同时也演示了如何使用x.pagedlist进行前端分页。