Пагинация GridView: от AllowPaging до выборки страницы в SQL

РазделGridViewУровеньСредний Чтение8 минОпубликовано ТегиASP.NETGridViewSQL Server

Тысяча строк в одной таблице грузится долго и читается плохо. Разбираем встроенную пагинацию GridView, её скрытую цену и способ отдавать из базы только нужную страницу.

Главное. AllowPaging плюс обработчик PageIndexChanging включают пагинацию за пять минут, но тянут из базы все строки. Для больших таблиц выбирайте страницу в SQL через OFFSET FETCH и сообщайте гриду общее число записей.

Зачем делить данные на страницы

Когда в GridView попадает несколько тысяч строк, страница весит мегабайты: HTML таблицы, а сверху ещё ViewState с копией тех же данных. На медленном канале пользователь ждёт, браузер тормозит при прокрутке, а найти нужную запись глазами всё равно невозможно. Постраничный вывод решает это просто: показываем фиксированную порцию строк и навигацию по номерам страниц.

У GridView пагинация встроенная, и включить её можно буквально двумя изменениями. Но у встроенного режима есть особенность, о которой полезно знать заранее: он режет на страницы уже загруженные данные. Об этом подробнее ниже.

Включаем AllowPaging

Свойство AllowPaging="true" включает разбивку, PageSize задаёт число строк на странице (по умолчанию 10). Внизу таблицы появляется строка пейджера с номерами страниц. Её внешний вид настраивается через PagerSettings: режим Numeric, NextPrevious, NumericFirstLast или NextPreviousFirstLast, количество видимых номеров, подписи кнопок. Позицию задаёт Position: снизу, сверху или в обоих местах.

Для оформления у пейджера есть отдельный PagerStyle с CssClass. Текущая страница выводится как span, остальные как ссылки, так что выделить активный номер в CSS легко.

Fonts.aspxASPX
<asp:GridView ID="GridView1" runat="server" CssClass="grid"
    AllowPaging="true" PageSize="20" AutoGenerateColumns="true">
  <PagerSettings Mode="NumericFirstLast" PageButtonCount="7"
      FirstPageText="« Первая" LastPageText="Последняя »"
      Position="Bottom" />
  <PagerStyle CssClass="pager" />
</asp:GridView>

Обработчик PageIndexChanging

Если запустить страницу только с AllowPaging и ручной привязкой данных, при клике на номер страницы получим исключение: событие PageIndexChanging не обработано. Как и в случае сортировки, GridView переключает страницы сам только при работе через контрол источника данных. При ручной привязке смену страницы выполняем мы.

В обработчике нужно сделать две вещи: записать в PageIndex номер новой страницы из e.NewPageIndex и снова привязать данные. Если забыть второй шаг, после постбэка грид окажется пустым или покажет старую страницу. В некоторых примерах привязку переносят в событие PageIndexChanged, которое срабатывает следом. Разницы по результату нет, но держать всё в одном обработчике проще для чтения.

Fonts.aspx.vbVB.NET
Protected Sub Page_Load(sender As Object, e As EventArgs) Handles Me.Load
    If Not IsPostBack Then BindGrid()
End Sub

Protected Sub GridView1_PageIndexChanging(sender As Object,
        e As GridViewPageEventArgs) Handles GridView1.PageIndexChanging
    GridView1.PageIndex = e.NewPageIndex
    BindGrid()
End Sub

Private Sub BindGrid()
    ' Для демонстрации: список шрифтов системы, без базы данных
    GridView1.DataSource = System.Drawing.FontFamily.Families
    GridView1.DataBind()
End Sub
PageIndex задавайте до DataBind. Если на первой загрузке указать номер больше реального числа страниц, GridView молча покажет последнюю.

Скрытая цена встроенной пагинации

Встроенный режим работает так: вы отдаёте гриду весь набор данных, а он выбирает из него нужные двадцать строк. Получается, что для показа одной страницы из базы читаются все записи. На тысяче строк это незаметно. На ста тысячах каждый клик по номеру страницы превращается в тяжёлый запрос и перекачку мегабайтов по сети между сервером приложения и SQL Server.

Первое облегчение даёт кеш. Положите DataTable в Cache с коротким временем жизни или с зависимостью от изменения данных, и при листании база не будет дёргаться вовсе. Для небольших справочников и отчётов, которые обновляются редко, этого достаточно. Второе: отключите ViewState у грида (EnableViewState="false"), если на странице нет редактирования. Данные всё равно перепривязываются на каждый постбэк, а размер страницы заметно уменьшится.

Настоящая выборка страницы в SQL

Для больших таблиц правильный путь: просить у базы только нужную страницу. Начиная с SQL Server 2012 для этого есть OFFSET и FETCH NEXT, в более старых версиях используют ROW_NUMBER() в подзапросе. Порядок сортировки обязателен, без ORDER BY страницы будут перемешиваться.

Остаётся сказать GridView, сколько всего записей, чтобы он нарисовал правильный пейджер. При ручной привязке для этого в .NET 4.5 появились свойства AllowCustomPaging и VirtualItemCount. В более ранних версиях ту же задачу решал ObjectDataSource с параметрами EnablePaging, SelectCountMethod и стартовой строкой.

Orders.aspx.vbVB.NET
Private Sub BindGrid()
    Const sql = "SELECT OrderID, CustomerID, OrderDate FROM Orders " &
                "ORDER BY OrderID OFFSET @skip ROWS FETCH NEXT @take ROWS ONLY; " &
                "SELECT COUNT(*) FROM Orders;"
    Dim page As New DataTable()
    Dim total As Integer

    Using cn As New SqlConnection(ConnString), cmd As New SqlCommand(sql, cn)
        cmd.Parameters.Add("@skip", SqlDbType.Int).Value =
            GridView1.PageIndex * GridView1.PageSize
        cmd.Parameters.Add("@take", SqlDbType.Int).Value = GridView1.PageSize
        cn.Open()
        Using rd = cmd.ExecuteReader()
            page.Load(rd)            ' первый набор: строки страницы
            rd.Read()                ' второй набор: общее число
            total = rd.GetInt32(0)
        End Using
    End Using

    GridView1.AllowCustomPaging = True   ' .NET 4.5+
    GridView1.VirtualItemCount = total
    GridView1.DataSource = page
    GridView1.DataBind()
End Sub
DataTable.Load после чтения первого набора сам переводит ридер к следующему, поэтому сразу вызываем Read для строки с COUNT.

Удобство для пользователя

Пейджер легко сделать неудобным, поэтому несколько практических советов. Показывайте, где находится пользователь: строка «Записи 41-60 из 1 253» над таблицей снимает половину вопросов. Не выводите сто номеров подряд, PageButtonCount в пределах 5-10 и режим NumericFirstLast читаются гораздо лучше. После смены сортировки или фильтра сбрасывайте PageIndex на ноль. Ссылки пейджера должны быть достаточно крупными для пальца на планшете и заметными при фокусе с клавиатуры.

Как это делают сегодня

В Blazor QuickGrid пагинацию даёт компонент Paginator в паре с PaginationState, а при источнике IQueryable из EF Core в SQL уходят только нужные строки через Skip и Take. Для огромных наборов всё чаще используют keyset-пагинацию (WHERE Id > @lastId) вместо OFFSET: она не замедляется на дальних страницах. В REST API параметры страницы и общее число записей обычно отдают в ответе или заголовках.

Вопросы и ответы

Почему после клика по номеру страницы грид пустой?

В обработчике PageIndexChanging не вызвана повторная привязка данных. Установите PageIndex и сразу вызовите метод, который задаёт DataSource и делает DataBind.

Можно ли включить пагинацию для SqlDataReader?

Встроенная пагинация требует источника с поддержкой ICollection, ридер для неё не подходит. Загрузите данные в DataTable или выбирайте страницу прямо в SQL.

Как скрыть пейджер, если страница всего одна?

Ничего делать не нужно: GridView сам не выводит строку пейджера, когда записей меньше PageSize.

Читайте также