1. 程式人生 > >ABP入門系列(7)——分頁實現

ABP入門系列(7)——分頁實現

完成了任務清單的增刪改查,咱們來講一講必不可少的的分頁功能。
首先很慶幸ABP已經幫我們封裝了分頁實現,實在是貼心啊。
來來來,這一節咱們就來捋一捋如何使用ABP的進行分頁吧。

一、分頁請求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資料夾下,具體路徑如下圖。

二、如何使用分頁DTO

拿我們的任務清單舉例,我們修改下建立的GetTaskInputDto,讓它繼承自PagedSortedAndFilteredInputDto,這樣GetTaskInputDto就擁有了進行分頁排序過濾需要用到的屬性。

public class GetTasksInput : PagedSortedAndFilteredInputDto
{
    public TaskState? State { get; set; }

    public int? AssignedPersonId { get; set; }
}

三、返回分頁結果DTO

Abp已經為我們定義了泛型的PagedResultDto用來包裝返回的分頁結果。其中主要包括兩個屬性,int TotalCount儲存總個數,IReadOnlyList<T> Items儲存返回的分頁結果集。

四、應用服務層分頁邏輯實現

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中用過的方法WhereIfPageBy,是的,這是ABP提供的擴充套件方法,感興趣的可以看下原始碼QueryableExtensions的具體實現,其實實現的很簡單,但我們平時在使用linq時卻未必能想得到。

在這裡提幾個問題:

  1. 請問在這段程式碼中共進行了幾次查詢?
  2. 程式碼中使用的是什麼分頁技術?(真分頁?假分頁?)

五、使用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="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="#">
                    @*<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進行前端分頁。

相關推薦

ABP入門系列7——實現

完成了任務清單的增刪改查,咱們來講一講必不可少的的分頁功能。 首先很慶幸ABP已經幫我們封裝了分頁實現,實在是貼心啊。 來來來,這一節咱們就來捋一捋如何使用ABP的進行分頁吧。 一、分頁請求DTO定義 資料傳輸物件(Data Transfer Objects)用於應用層和展現層的資料傳輸。 展現層傳入資料

ABP入門系列5——展現層實現增刪改查

這一章節將通過完善Controller、View、ViewModel,來實現展現層的增刪改查。最終實現效果如下圖: 一、定義Controller ABP對ASP.NET MVC Controllers進行了整合,通過引入Abp.Web.Mvc名稱空間,建立Controller繼承自AbpControlle

arcgis jsapi介面入門系列7:滑鼠在地圖畫線

初始化,每個map執行一次就行 drawPolylineInit: function () { //畫幾何物件初始化 //新建一個圖形圖層用於存放畫圖過程中的圖形 let layer = new t

Django rest framework7----

目錄 第一種分頁  PageNumberPagination 基本使用 (1)urls.py urlpatterns = [ re_path('(?P<version>[v1|v2]+)/page1/', Pager1View.as_view(),) #分頁1 ]

ABP入門系列12——如何升級Abp並除錯原始碼

1. 升級Abp 本系列教程是基於Abp V1.0版本,現在Abp版本已經升級至V1.4.2(截至至文章釋出時間),其中新增了New Feature,並對Abp做了相應的Enhancements,以及Bug fixs。現在我們就把它升級至最新版本,那如何升級呢? 下面就請按我的步驟來將Abp由V1.0升級

ABP入門系列16——通過webapi與系統進行互動

1. 引言 上一節我們講解了如何建立微信公眾號模組,這一節我們就繼續跟進,來講一講公眾號模組如何與系統進行互動。 微信公眾號模組作為一個獨立的web模組部署,要想與現有的【任務清單】進行互動,我們要想明白以下幾個問題: 如何進行互動? ABP模板專案中預設建立了webapi專案,其動態webapi技術允

ABP入門系列14——應用BootstrapTable表格外掛

1. 引言 之前的文章ABP入門系列(7)——分頁實現講解了如何進行分頁展示,但其分頁展示僅適用於前臺web分頁,在後臺管理系統中並不適用。後臺管理系統中的資料展示一般都是使用一些表格外掛來完成的。這一節我們就使用BootstrapTable進行舉例說明。 2. BootstrapTable 基於 B

ABP入門系列6——定義導航選單

完成了增刪改查以及頁面展示,這一節我們來為任務清單新增【導航選單】。 在以往的專案中,大家可能會手動在layout頁面中新增一個a標籤來新增導航選單,這也是一種方式,但是如果要針對不同使用者不同許可權決定是否顯示某個選單,那麼直接在layout頁面中去控制就不方便了。 不過,ABP已經為大家考慮了這一點,集

ABP入門系列8——Json格式化

講完了分頁功能,這一節我們先不急著實現新的功能。來簡要介紹下Abp中Json的用法。為什麼要在這一節講呢?當然是做鋪墊啊,後面的系列文章會經常和Json這個東西打交道。 一、Json是幹什麼的 JSON(JavaScript Object Notation) 是一種輕量級的資料交換格式。 易於人閱讀和編寫

ABP入門系列19——使用領域事件

1.引言 最近剛學習了下DDD中領域事件的理論知識,總的來說領域事件主要有兩個作用,一是解耦,二是使用領域事件進行事務的拆分,通過引入事件儲存,來實現資料的最終一致性。若想了解DDD中領域事件的概念,可參考DDD理論學習系列(9)-- 領域事件。 Abp中使用事件匯流排來實現領域事件,而關於事件匯流排的

ABP入門系列9——許可權管理

完成了簡單的增刪改查和分頁功能,是不是覺得少了點什麼? 是的,少了許可權管理。既然涉及到了許可權,那我們就細化下任務清單的功能點: 登入的使用者才能檢視任務清單 使用者可以無限建立任務並分配給自己,但只能對自己建立的任務進行查詢、修改 管理員可以建立任務並分配給他人 管理員具有刪除任務的許可權 從以上

ABP入門系列18—— 使用領域服務

1.引言 自上次更新有一個多月了,發現越往下寫,越不知如何去寫。特別是當遇到DDD中一些概念術語的時候,尤其迷惑。如果只是簡單的去介紹如何去使用ABP,我只需參照官方文件,實現到任務清單Demo中去就可以了,不勞神不費力。但是,這樣就等於一知半解。 知之為知之,不知為不知,是知也。知其然知其所以然,方能舉

ABP入門系列2——領域層建立實體

這一節我們主要和領域層打交道。首先我們要對ABP的體系結構以及從模板建立的解決方案進行一一對應。網上有程式碼生成器去簡化我們這一步的任務,但是不建議初學者去使用。 一、首先來看看ABP體系結構 領域層就是業務層,是一個專案的核心,所有業務規則都應該在領域層實現。 實體(Entity): 實體代表業務領域的

ABP入門系列4——建立應用服務

一、解釋下應用服務層 應用服務用於將領域(業務)邏輯暴露給展現層。展現層通過傳入DTO(資料傳輸物件)引數來呼叫應用服務,而應用服務通過領域物件來執行相應的業務邏輯並且將DTO返回給展現層。因此,展現層和領域層將被完全隔離開來。 以下幾點,在建立應用服務時需要注意: 在ABP中,一個應用服務需要實現IAp

ABP入門系列11——編寫單元測試

1. 前言 In computer programming, unit testing is a software testing method by which individual units of source code, sets of one or more computer program

ABP入門系列15——建立微信公眾號模組

1. 引言 現在的網際網路已不在僅僅侷限於網頁應用,IOS、Android、平板、智慧家居等平臺正如火如荼的迅速發展,移動應用的需求也空前旺盛。所有的網際網路公司都不想錯過這一次移動浪潮,佈局移動市場分一份移動紅利。 的確,智慧手機作為我們日常生活已必不可少的一部分,通過手機app能夠獲得更好的體驗,比如

ABP入門系列3——領域層定義倉儲並實現

一、先來介紹下倉儲 倉儲(Repository): 倉儲用來操作資料庫進行資料存取。倉儲介面在領域層定義,而倉儲的實現類應該寫在基礎設施層。 在ABP中,倉儲類要實現IRepository介面,介面定義了常用的增刪改查以及聚合方法,其中包括同步及非同步方法。主要包括以下方法: ABP針對不同的ORM框架對

ABP入門系列1——通過模板建立MAP版本專案

一、從官網建立模板專案 依次按下圖選擇: 輸入驗證碼開始下載 下載提示: 二、啟動專案 使用VS2015開啟專案,還原Nuget包: 設定以Web結尾的專案,設定為啟動專案: 開啟Web.config,修改連線字串。(因為我本地裝的sqlserver是例項是.sqlexpress,所以需要

ABP入門系列13——Redis快取用起來

1. 引言 建立任務時我們需要指定分配給誰,Demo中我們使用一個下拉列表用來顯示當前系統的所有使用者,以供使用者選擇。我們每建立一個任務時都要去資料庫取一次使用者列表,然後繫結到使用者下拉列表顯示。如果就單單對一個demo來說,這樣實現也無可厚非,但是在正式專案中,顯然是不合理的,浪費程式效能,有待優化

ABP入門系列17——使用ABP整合的郵件系統傳送郵件

ABP中對郵件的封裝主要整合在Abp.Net.Mail和Abp.Net.Mail.Smtp名稱空間下,相應原始碼在此。 #一、Abp整合的郵件模組是如何實現的 分析可以看出主要由以下幾個核心類組成: EmailSettingNames:靜態常量類,主要定義了傳送郵件需要的相關引數:Port、Host、Us