ASP.NET MVC v praxi od A do Z, 10. díl – Stránkování

Jak půjde čas, bude se počet večeří v naší databázi zvyšovat. Je jasné, že zobrazit všech 500 naplánovaných večeří na jedné stránce není zrovna vhodné, proto dnes implementujeme stránkování.

Na konci dnešního dílu bude seznam večeří rozdělený na stránky vždy po deseti záznamech.

Rozhraní IQueryable<T>

Toto rozhraní bylo uvedeno společně s LINQ v .NET 3.5 a pro nás jeho nejdůležitější vlastností je, že podporuje tzv. „deferred execution“ (odložené vykonání). Z českého překladu není moc dobře pochopitelné, co to vlastně znamená. Znamená to, že dotaz se databázi nepošle, dokud se nepokusíme k vráceným datům přistoupit nebo dokud na ně nezavoláme metodu ToList. Možná se to teď nezdá, ale díky této vlastnosti dokážeme implementovat stránkování neuvěřitelně snadno.

Podíváme se na současnou podobu metody Index v DinnersControlleru:

// GET: /Dinners/
public ActionResult Index()
{
    var dinners = dinnerRepository.FindUpcomingDinners().ToList();
    return View(dinners);
}

Je opravdu důležité si uvědomit, že samotné volání metody FindUpcomigDinners nic nevrátí, musíme zavolat ještě metodu ToList! Pokud bychom třeba chtěli přeskočit prvních deset nalezených večeří a vrátit až dvacet dalších, stačí jen jednoduchá úprava metody Index:

// GET: /Dinners/
public ActionResult Index()
{
    var upcomingDinners = dinnerRepository.FindUpcomingDinners();
    var paginatedDinners = upcomingDinners.Skip(10).Take(20).ToList();

    return View(paginatedDinners);
}

Teď už vás možná napadá, jak budeme řešit stránkování – číslo stránky předáme jako parametr v URL, uvnitř metody Index vypočítáme, kolik večeří se má přeskočit, a pak jednoduše vybereme deset dalších večeří a ty vypíšeme na stránku.

Parametr „page“ v URL

Ukážeme si dva různé způsoby, jak předat číslo stránky, kterou chceme zobrazit.

Použití querystringu

Jednodušší je použití querystringu, který umožní URL ve tvaru „/Dinners?page=2“:

// GET: /Dinners/
public ActionResult Index(int? page)
{
    const int pageSize = 10;

    var upcomingDinners = dinnerRepository.FindUpcomingDinners();
    var paginatedDinners = upcomingDinners.Skip((page ?? 0) * pageSize).Take(pageSize).ToList();

    return View(paginatedDinners);
}

Povšimněte si nullable parametru „page“, který metoda Index teď přijímá. Jeho hodnota se automaticky vezme z querystringu v URL. Pokud tam žádná hodnota nebude, předá se null, a tím pádem se zobrazí první stránka (respektive nultá, viz níže).

U proměnné paginedDinners používáme zvláštní operátor ??, který zkontroluje, jestli je proměnná vlevo od něj null, a pokud ano, uloží do ní nulu. Výsledek pak násobíme deseti, abychom věděli, kolik záznamů se má přeskočit.

Použití routování

Druhou možností je nadefinovat nové routovací pravidlo, můžeme pak použít URL ve tvaru „/Dinners/Page/2“.

Pro napsání nového pravidla musíme otevřít soubor Global.asax a napsat nové volání metody routes.MapRoute:

public static void RegisterRoutes(RouteCollection routes)
{
    routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

    routes.MapRoute(
        "UpcomingDinners",                                      // Route name
        "Dinners/Page/{page}",                                  // URL with parameters
        new {controller = "Dinners", action = "Index"}          // Parameter defaults
    );

    routes.MapRoute(
        "Default",                                              // Route name
        "{controller}/{action}/{id}",                           // URL with parameters
        new { controller = "Home", action = "Index", id = "" }  // Parameter defaults
    );

}

Ještě musíme upravit metodu Index, ta ale bude naprosto stejná, jako kdybychom používali querystring.

Osobně raději využívám druhý způsob, ale je to na vás. Teď to funguje tak, že pokud zadáme URL „/Dinners“, zobrazí se první (nultá) stránka a pokud zadáme „Dinners/Page/1“, zobrazí se stránka druhá:

Navigace

Nechat uživatele, aby ručně upravoval URL pro přechod na další stránky, není zrovna dobrý způsob jak na to, takže vytvoříme navigační šipky.

Jako první věc budeme potřebovat vědět celkový počet večeří a kolik stránek dohromady tvoří. Pak spočítáme, jestli je aktuálně zobrazovaná stránka na začátku, na konci nebo někde uvnitř seznamu večeří a podle toho zobrazíme příslušné šipky. Mohli bychom celou logiku napsat přímo v metodě Index nebo to uděláme čistěji – napíšeme si pomocnou třídu.

Níže uvidíte zdrojový kód třídy PaginatedList, která je odvozená od generické verze kolekce List. Třídu umístíme do adresáře Controllers.

using System;
using System.Collections.Generic;
using System.Linq;

namespace NerdDinner.Controllers
{
    public class PaginatedList<T> : List<T>
    {
        public int PageIndex { get; private set; }
        public int PageSize { get; private set; }
        public int TotalCount { get; private set; }
        public int TotalPages { get; private set; }

        public PaginatedList(IQueryable<T> source, int pageIndex, int pageSize)
        {
            PageIndex = pageIndex;
            PageSize = pageSize;
            TotalCount = source.Count();
            TotalPages = (int)Math.Ceiling(TotalCount / (double)PageSize);

            this.AddRange(source.Skip(PageIndex * PageSize).Take(PageSize));
        }

        public bool HasPreviousPage
        {
            get
            {
                return (PageIndex > 0);
            }
        }

        public bool HasNextPage
        {
            get
            {
                return (PageIndex + 1 < TotalPages);
            }
        }
    }
}

Celou třídu tvoří šest vlastností a konstruktor, který čtyřem z nich přiřazuje hodnoty. Vlastnosti HasPreviousPage a HasNext indikují, jestli existuje nějaká stránka před aktuální stránkou nebo po ní.

Kód výše způsobí vykonání celkem dvou SQL dotazů – jeden z nich vrátí celkový počet Dinner objektů (nevrací to žádné objekty, skutečně jen počet, jako kdybychom zavolali přímo na databázi „SELECT COUNT“) a druhý dotaz získá řádky pro naplnění stránky.

Upravíme metodu DinnersController.Index tak, aby využívala naší novou třídu:

// GET: /Dinners/
// GET: /Dinners/Page/2
public ActionResult Index(int? page)
{
    const int pageSize = 10;

    var upcomingDinners = dinnerRepository.FindUpcomingDinners();
    var paginatedDinners = new PaginatedList<Dinner>(upcomingDinners, page ?? 0, pageSize);

    return View(paginatedDinners);
}

Na závěr musíme provést pár úprav i v šabloně Index - musíme upravit direktivu Page a pak ještě přidat pár podmínek pro zobrazení navigačních šipek:

<%@ Page Title="" Language="C#" MasterPageFile="~/Views/Shared/Site.Master" Inherits="System.Web.Mvc.ViewPage<NerdDinner.Controllers.PaginatedList<NerdDinner.Models.Dinner>>" %>

<asp:Content ID="Content1" ContentPlaceHolderID="TitleContent" runat="server">
    Chystané večeře
</asp:Content>
<asp:Content ID="Main" ContentPlaceHolderID="MainContent" runat="server">
    <h2>
        Chystané večeře</h2>
    <ul>
        <% foreach (var dinner in Model)
           { %>
        <li>
            <%= Html.ActionLink(dinner.Title, "Details", new { id=dinner.DinnerID }) %>
            dne
            <%=Html.Encode(dinner.EventDate.ToShortDateString())%>
            @
            <%=Html.Encode(dinner.EventDate.ToShortTimeString())%>
        </li>
        <% } %>
    </ul>
    <% if (Model.HasPreviousPage)
       { %>
    <%= Html.RouteLink("<<<", "UpcomingDinners", new { page = (Model.PageIndex - 1) }) %>
    <% } %>
    <% if (Model.HasNextPage)
       {  %>
    <%= Html.RouteLink(">>>", "UpcomingDinners", new { page = (Model.PageIndex + 1) }) %>
    <% } %>
</asp:Content>

Pro vytvoření odkazů používáme metodu Html.RouteLink, které předáváme text, který se má zobrazit jako odkaz, název routovacího pravidla a nakonec číslo stránky, na kterou chceme přejít.

A je to! Můžete si to sami zkusit, vše by mělo fungovat.

V příštím díle nás čeká klíčová věc – autentizace a autorizace.