學習ASP.NET Core Razor 編程系列十九——分頁

通過前面的教程學習，你可以實現一個簡單的書籍管理系統。在本教程將向書籍索引頁中添加分頁功能。 ...

學習ASP.NET Core Razor 編程系列目錄

學習ASP.NET Core Razor 編程系列一

學習ASP.NET Core Razor 編程系列二——添加一個實體

學習ASP.NET Core Razor 編程系列三——創建數據表及創建項目基本頁面

學習ASP.NET Core Razor 編程系列四——Asp.Net Core Razor列表模板頁面

學習ASP.NET Core Razor 編程系列五——Asp.Net Core Razor新建模板頁面

學習ASP.NET Core Razor 編程系列六——資料庫初始化

學習ASP.NET Core Razor 編程系列七——修改列表頁面

學習ASP.NET Core Razor 編程系列八——併發處理

學習ASP.NET Core Razor 編程系列九——增加查詢功能

學習ASP.NET Core Razor 編程系列十——添加新欄位

學習ASP.NET Core Razor 編程系列十一——把新欄位更新到資料庫

學習ASP.NET Core Razor 編程系列十二——在頁面中增加校驗

學習ASP.NET Core Razor 編程系列十三——文件上傳功能（一）

學習ASP.NET Core Razor 編程系列十四——文件上傳功能（二）

學習ASP.NET Core Razor 編程系列十五——文件上傳功能（三）

學習ASP.NET Core Razor 編程系列十六——排序

學習ASP.NET Core Razor 編程系列十七——分組

學習ASP.NET Core Razor 編程系列十八——併發解決方案

通過前面的教程學習，你可以實現一個簡單的書籍管理系統。在本教程將向書籍索引頁中添加分頁功能。

一、向書籍列表頁添加分頁功能

為了向書籍列表頁添加分頁功能，你需要安裝X.PagedList.Core.Mvc

首先，我們需要安裝分頁組件包，在Visual Studio 2017中點擊【項目】-【管理NuGet程式包】，打開NuGet包管理器窗體。

其次，在NuGet包管理器窗體中，選擇“瀏覽”標簽，然後搜索X.PagedList，如下圖所示。點擊“安裝”按鈕安裝X.PagedList.Core.Mvc的最新版本（本文中安裝的版本為7.5.0）。

第三， Nuget會下載X.PagedList.Mvc.Core包，並會彈出一個“更改”對話框，點擊“確定”按鈕。

第四，在把PagedList.Mvc安裝完成之後，PagedList包也被安裝上了。如下圖。

把PagedList.Mvc安裝完成之後，第一件事就是對OnGetAsync方法做更多的修改並將分頁按鈕添加到Index視圖中。如下圖所示添加了分頁按鈕的書籍列表頁。

二、向書籍列表後臺代碼添加分頁功能

在Pages/Books/Index.cshtml.cs中，用以下代碼替換。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.RazorPages;
using Microsoft.EntityFrameworkCore;
using RazorMvcBooks.Models;
using Microsoft.AspNetCore.Mvc.Rendering;
using X.PagedList; 

namespace RazorMvcBooks.Pages.Books
{
    public class IndexModel : PageModel
    {
        private readonly RazorMvcBooks.Models.BookContext _context; 

        public IndexModel(RazorMvcBooks.Models.BookContext context)
        {
            _context = context;
        }
 

        public List<Book> Books;
        public SelectList Publishs;
        public string Publish { get; set; }
        public string NameSort { get; set; }
        public string DateSort { get; set; }
        public string CurrentFilter { get; set; }
        public string CurrentSort { get; set; } 

        public X.PagedList.IPagedList<Book> Book { get;set; } 

        public async Task OnGetAsync(string publish, string searchString,string sortOrder,int? pageIndex)
        {

            ViewData["CurrentSort"] = sortOrder;
            Publish = publish;
            int pageSize = 5;
            ViewData["SearchString"] = searchString;
            var page = pageIndex ?? 1; 

            //查詢
            IQueryable<string> PublishingQuery = from m in _context.Book
                                             orderby m.Publishing
                                             select m.Publishing;
 
            var books = from m in _context.Book
                         select m;
 

            if (!String.IsNullOrEmpty(searchString))
            {
                books = books.Where(s => s.Name.Contains(searchString));
            } 

            if (!String.IsNullOrEmpty(publish))
            {
                books = books.Where(x => x.Publishing == publish);
            }
            Publishs = new SelectList(await PublishingQuery.Distinct().ToListAsync()); 

            //排序
            NameSort = String.IsNullOrEmpty(sortOrder) ? "name_desc" : "";
            DateSort = sortOrder == "Date" ? "date_desc" : "Date"; 

            ViewData["NameSortParm"] = NameSort;
            ViewData["DateSortParm"] = DateSort; 
 

            switch (sortOrder)
            {

                case "name_desc":
                    books = books.OrderByDescending(s => s.Name);
                    break;

                case "Date":
                    books = books.OrderBy(s => s.ReleaseDate);
                    break;

                case "date_desc":
                    books = books.OrderByDescending(s => s.ReleaseDate);

                    break;

                default:
                    books = books.OrderBy(s => s.Name);
                    break;

            }

            Book = await books.AsNoTracking().ToPagedListAsync(page, pageSize);
            //將分頁結果放入ViewData供View使用
            ViewData["books"] = Book; 

        }
    }
}

代碼中將總頁數參數、當前的排序順序參數和當前的篩選器參數添加到方法簽名中。

public async Task OnGetAsync(string publish, string searchString,string sortOrder,int? pageIndex)

第一次顯示頁面，或如果用戶未單擊分頁或排序鏈接，則所有參數都為null。如果單擊分頁鏈接，頁面變數將包含要顯示的頁碼。

名為 CurrentSort 的ViewData元素提供了當前已排序的試圖，因為這必須包含在分頁鏈接中以保持排序順序在分頁時相同。

名為 searchString的ViewData元素提供了當前已篩選的視圖。為了在分頁過程中維護篩選規則以及在頁面重新顯示的時候把篩選值恢復到文本框中，該值一定要被包含進分頁鏈接里

如果分頁期間更改搜索字元串，顯示的頁會被重置為 1，因為新的篩選器可能會導致顯示不同的數據。在文本框中輸入了值以及按下提交按鈕搜索字元串就會改變。在這種情況下，searchString參數不為 null。

在OnGetAsync方法的結尾，ToPagedListAsync方法將書籍查詢結果轉換為支持分頁的集合類型，集合中包含了剛好能放進單頁的書籍實體。然後將這個單頁大小的書籍集合傳遞給視圖。

Book = await books.AsNoTracking().ToPagedListAsync(page, pageSize);

代碼中的ToPagedListAsync方法獲得頁面數和當前頁碼，並對IQueryable執行語句。當IQueryable調用ToPagedListAsync時，該方法將返回只包含在請求頁里的書籍列表。屬性HasPreviousPage和HasNextPage可用來啟用或禁用Previous和Next分頁按鈕。

Book屬性我們變更為

public X.PagedList.IPagedList<Book> Book { get;set; }

三、向書籍列表視圖添加分頁鏈接

在Pages/Books/Index.cshtml中，用以下代碼替換現有代碼。高亮代碼為更改的代碼。

@page
@model RazorMvcBooks.Pages.Books.IndexModel
@using X.PagedList.Mvc.Core;
@using X.PagedList.Mvc.Common;
@using X.PagedList;
<!--// 7.6及以上版本需要引入Common命名空間，以支持PagedListRenderOptions .7.5以下的版本則不需要。--> 

@{
    ViewData["Title"] = "Index";
} 

<h2>Index</h2> 
<p>
    <a asp-page="Create">Create New</a>
</p>

<form>
    <p>
        <select asp-for="Publish" asp-items="Model.Publishs">
            <option value="">All</option>
        </select>
        書籍名稱
        <input type="text" name="SearchString">
        <input type="submit" value="查詢" />
    </p>
</form> 

<table class="table">
    <thead>
        <tr>
            <th>
                <a asp-page="./Index" asp-route-sortOrder="@Model.NameSort">
                    @Html.DisplayNameFor(model => model.Book[0].Name)
                </a> 

            </th>
            <th>
                <a asp-page="./Index" asp-route-sortOrder="@Model.DateSort">
                    @Html.DisplayNameFor(model => model.Book[0].ReleaseDate)
                </a>

            </th>
            <th>
                @Html.DisplayNameFor(model => model.Book[0].Author)
            </th>
            <th>
                @Html.DisplayNameFor(model => model.Book[0].Price)
            </th>
            <th>
                @Html.DisplayNameFor(model => model.Book[0].Publishing)
            </th>
            <th></th>
        </tr>
    </thead>
    <tbody>
        @foreach (var item in Model.Book)
        {
            <tr>
                <td>
                    @Html.DisplayFor(modelItem => item.Name)
                </td>
                <td>
                    @Html.DisplayFor(modelItem => item.ReleaseDate)
                </td>
                <td>
                    @Html.DisplayFor(modelItem => item.Author)
                </td>
                <td>
                    @Html.DisplayFor(modelItem => item.Price)
                </td>
                <td>
                    @Html.DisplayFor(modelItem => item.Publishing)
                </td>
                <td>
                    <a asp-page="./Edit" asp-route-id="@item.ID">Edit</a> |
                    <a asp-page="./Details" asp-route-id="@item.ID">Details</a> |
                    <a asp-page="./Delete" asp-route-id="@item.ID">Delete</a>
                </td>
            </tr>
        }

    </tbody>
    <tfoot>
        <tr>
            <td class="text-muted" colspan="4">
                每頁 @Model.Book.PageSize 條記錄，本頁有 @Model.Book.Count 條記錄,共有 @Model.Book.TotalItemCount 條記錄。
               第 @(Model.Book.PageCount < Model.Book.PageNumber ? 0 : Model.Book.PageNumber) 頁，共 @Model.Book.PageCount 頁。
                @*這個條件表達式的目的是防止出現 記錄為0的情況，會出現 總頁數為0，而當前是第1頁的情況。*@

            </td>
        </tr>
    </tfoot>
</table> 

@{

    var prevDisabled = !Model.Book.HasPreviousPage ? "disabled" : "";
    var nextDisabled = !Model.Book.HasNextPage ? "disabled" : "";
} 

<a asp-action="./Index"
 asp-route-publish="@Model.Publish"
   asp-route-sortOrder="@ViewData["CurrentSort"]"
   asp-route-pageIndex="@(Model.Book.PageNumber - 1)"
   asp-route-searchString="@ViewData["SearchString"]"
   class="btn btn-default @prevDisabled">
    上一頁
</a>

<a asp-action="./Index"
 asp-route-publish="@Model.Publish"
   asp-route-sortOrder="@ViewData["CurrentSort"]"
   asp-route-pageIndex="@(Model.Book.PageNumber + 1)"
   asp-route-searchString="@ViewData["SearchString"]"
   class="btn btn-default @nextDisabled">
    下一頁
</a>

其中通過標記幫助程式顯示分頁按鈕：

<a asp-action="./Index"
 asp-route-publish="@Model.Publish"
   asp-route-sortOrder="@ViewData["CurrentSort"]"
   asp-route-pageIndex="@(Model.Book.PageNumber - 1)"
   asp-route-searchString="@ViewData["SearchString"]"
   class="btn btn-default @prevDisabled">
    上一頁
</a>

我們在Visual Studio 2017中按F5運行應用，併在瀏覽器中瀏覽書籍列表頁。如下圖。

在瀏覽器中單擊以確保分頁工作原理的不同的排序順序中的分頁鏈接。然後輸入搜索字元串，然後重試以驗證分頁還適用正確使用排序和篩選的分頁。

四、向書籍列表視圖添加分頁鏈接

雖然上面我們實現了分頁功能，但是一般分頁，需要有頁面顯示，如下圖。

如何實現上圖中的分頁樣式呢？在Pages/Books/Index.cshtml中把書籍列表視圖中“</table>”後面的代碼，用以下代碼替換，就可以實現。

@Html.PagedListPager(Model.Book, pageIndex => Url.Action("Index", new { pageIndex, sortOrder = ViewData["CurrentSort"], 
searchString = ViewData["SearchString"], pageSize = ViewData["PageSize"] }),
 new PagedListRenderOptions { LinkToFirstPageFormat = "首頁", LinkToNextPageFormat = "下一頁", LinkToPreviousPageFormat = "上一頁",
 LinkToLastPageFormat = "末頁", MaximumPageNumbersToDisplay = 5, DisplayItemSliceAndTotal = false })

我們在Visual Studio 2017中按F5運行應用，併在瀏覽器中瀏覽書籍列表頁。使用滑鼠單擊頁碼“4”，我們可以驗證分頁功能的正確使用。如下圖。