ABP入门系列之分页功用的完成要领引见【C#.Net教程】,abp分页,abp入门系列

本节重要解说了怎样运用ABP举行背景分页，并顺带解说了ABP背景分页逻辑的完成体式格局。同时也演示了怎样运用X.PagedList举行前端分页

完成了使命清单的增编削查，我们来说一讲必不可少的的分页功用。

起首很光荣ABP已帮我们封装了分页完成，实在是知心啊。

来来来，这一节我们就来捋一捋怎样运用ABP的举行分页吧。

1. 分页要求DTO定义

数据传输对象(Data Transfer Objects)用于应用层和展示层的数据传输。

展示层传入数据传输对象(DTO)挪用一个应用服务要领，接着应用服务经由过程范畴对象实行一些特定的营业逻辑而且返回DTO给展示层。如许展示层和范畴层被完整星散开了。在具有优越分层的应用程序中，展示层不会直接运用范畴对象(堆栈，实体)。

我们在展示层有分页要求时，平常须要指定两个参数，一个用来标志第几页、一个是每页行数（平常有设置文件设置）。

由于分页是一个很经常使用的功用，所以，展示层我们有分页要求时，最好有响应的DTO来封装这两个参数。

在ABP源码中并没有为我们封装如许公用的类，但是在ABPZero项目中，定义了响应的分页Dto。

对应的类图以下：

分页排序过滤响应Dto类图

从中能够看到重要包含以下四个大众DTO定义：

PagedInputDto：分页要求Dto
PagedAndSortedInputDto：分页排序Dto
PagedSortedAndFilteredInputDto：分页排序过滤Dto
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">
   <p class="btn-group pull-right">
    <button type="button" class="btn btn-info">Edit</button>
    <button type="button" class="btn btn-success">Delete</button>
   </p>
   <p class="media">
    <a class="media-left" href="#" rel="external nofollow" >
     @*<i class="fa @Model.GetTaskLable(task) fa-3x"></i>*@
    </a>
    <p class="media-body">
     <h4 class="media-heading">@task.Title</h4>
     <span class="text-muted">@task.CreationTime.ToString("yyyy-MM-dd HH:mm:ss")</span>
    </p>
   </p>
  </li>
 }
</ul>
@Html.PagedListPager((IPagedList)ViewBag.OnePageOfTasks, page => Url.Action("PagedList", new { page }))

个中末了一句代码是用来生成分页控件。

终究结果如图：

总结