ABP入門系列之分頁功能的實作方法介紹

本節主要講解如何使用ABP進行後台分頁，並順帶講解了ABP後台分頁邏輯的實作方式。同時也示範如何使用X.PagedList進行前端分頁

完成了任務清單的增刪改查，咱們來講一講必不可少的分頁功能。

首先很慶幸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 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 }))

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

最终效果如图：

总结

总结

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

以上是ABP入門系列之分頁功能的實作方法介紹的詳細內容。更多資訊請關注PHP中文網其他相關文章！