Фильтрация GridView на ASP.NET AJAX: UpdatePanel, параметры и задержка ввода

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

Таблица заказов на тысячу строк без фильтра бесполезна. Добавляем над GridView поле поиска и списки, которые обновляют таблицу через ASP.NET AJAX без мигания всей страницы.

Главное. Фильтр GridView на ASP.NET AJAX собирается из UpdatePanel, параметризованного источника данных и пары обработчиков. Важные детали: сброс страницы при смене фильтра, отложенный запуск при вводе и фильтры вне обновляемой панели.

Что мы строим

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

В Web Forms это проще всего сделать через UpdatePanel из ASP.NET AJAX Extensions. Страница по-прежнему выполняет обычный постбэк на сервере, но браузер отправляет его асинхронно и заменяет только содержимое панели. Серверный код почти не отличается от неаяксового варианта, и это главный плюс подхода для сопровождения старых проектов.

Разметка: панель, фильтры и таблица

Фильтры и GridView кладём в одну UpdatePanel. У элементов фильтра включаем AutoPostBack, чтобы изменение значения сразу вызывало постбэк. ScriptManager на странице должен быть ровно один, обычно он живёт в мастер-странице.

Данные берёт SqlDataSource с параметрами, связанными с контролами через ControlParameter. Свойство ConvertEmptyStringToNull = False нужно, чтобы пустое поле поиска передавалось как пустая строка, а не как NULL: так проще писать условие в запросе.

Orders.aspxASPX
<asp:UpdatePanel ID="upOrders" runat="server">
  <ContentTemplate>
    <asp:TextBox ID="txtCustomer" runat="server" AutoPostBack="true" />
    <asp:DropDownList ID="ddlStatus" runat="server" AutoPostBack="true">
      <asp:ListItem Value="" Text="Все статусы" />
      <asp:ListItem Value="New" Text="Новые" />
      <asp:ListItem Value="Paid" Text="Оплаченные" />
    </asp:DropDownList>

    <asp:GridView ID="gvOrders" runat="server" DataSourceID="sdsOrders"
        AllowPaging="true" PageSize="25" AllowSorting="true"
        EmptyDataText="Ничего не найдено" />
  </ContentTemplate>
</asp:UpdatePanel>

<asp:SqlDataSource ID="sdsOrders" runat="server"
    ConnectionString="<%$ ConnectionStrings:Shop %>"
    CancelSelectOnNullParameter="false"
    SelectCommand="SELECT OrderId, Customer, Status, Total, CreatedAt FROM Orders
      WHERE (@cust = '' OR Customer LIKE '%' + @cust + '%')
        AND (@status = '' OR Status = @status)">
  <SelectParameters>
    <asp:ControlParameter Name="cust" ControlID="txtCustomer"
        PropertyName="Text" ConvertEmptyStringToNull="false" />
    <asp:ControlParameter Name="status" ControlID="ddlStatus"
        PropertyName="SelectedValue" ConvertEmptyStringToNull="false" />
  </SelectParameters>
</asp:SqlDataSource>
Не собирайте условие склейкой строки с текстом из TextBox. Параметры защищают от SQL-инъекций и избавляют от проблем с апострофами в именах вроде O'Brien.

Сброс страницы при смене фильтра

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

Правило простое: любое изменение фильтра возвращает таблицу на первую страницу. Подписываемся на события TextChanged и SelectedIndexChanged и сбрасываем PageIndex. SqlDataSource сам заметит изменение параметров и перезапросит данные.

Orders.aspx.vbVB.NET
Partial Class Orders
    Inherits System.Web.UI.Page

    ' Любая смена фильтра возвращает на первую страницу
    Protected Sub Filter_Changed(ByVal sender As Object, ByVal e As EventArgs) _
        Handles txtCustomer.TextChanged, ddlStatus.SelectedIndexChanged
        gvOrders.PageIndex = 0
    End Sub

    ' Показываем число найденных строк
    Protected Sub sdsOrders_Selected(ByVal sender As Object, _
        ByVal e As SqlDataSourceStatusEventArgs) Handles sdsOrders.Selected
        If e.Exception Is Nothing Then
            lblCount.Text = String.Format("Найдено: {0}", e.AffectedRows)
        End If
    End Sub
End Class

Поиск по мере ввода с задержкой

TextBox с AutoPostBack отправляет постбэк только при потере фокуса или нажатии Enter. Пользователи же ожидают, что таблица начнёт фильтроваться, пока они печатают. Если повесить постбэк на каждое нажатие клавиши, при вводе слова из восьми букв уйдёт восемь запросов, и ответы могут прийти не по порядку.

Правильный приём называется отложенным запуском: на каждое нажатие перезапускаем таймер на 400-500 мс, и постбэк уходит, только когда пользователь сделал паузу. Вызов __doPostBack с UniqueID текстового поля выполняет тот же асинхронный постбэк, что и AutoPostBack, поэтому серверный обработчик не меняется.

filter.jsJavaScript
// Отложенный постбэк: запрос уходит после паузы во вводе
var filterTimer = null;

function delayedFilter(input) {
  if (filterTimer) clearTimeout(filterTimer);
  filterTimer = setTimeout(function () {
    var prm = Sys.WebForms.PageRequestManager.getInstance();
    if (prm.get_isInAsyncPostBack()) prm.abortPostBack(); // старый запрос не нужен
    __doPostBack(input.name, '');
  }, 450);
}

// В разметке: <asp:TextBox ... onkeyup="delayedFilter(this)" />

Потеря фокуса и курсора после обновления

Когда текстовое поле лежит внутри UpdatePanel, после асинхронного ответа оно пересоздаётся, и фокус пропадает. Пользователь печатает дальше, а символы никуда не попадают. Есть два решения.

Первое: вынести фильтры из панели, оставив внутри только GridView, а для панели указать AsyncPostBackTrigger на события фильтров. Тогда поле не перерисовывается и фокус остаётся на месте. Это самый надёжный вариант. Второе: вернуть фокус после ответа через событие endRequest у PageRequestManager и поставить курсор в конец текста.

  • UpdateMode=«Conditional» у панели с таблицей, чтобы она не обновлялась от чужих постбэков;
  • AsyncPostBackTrigger с ControlID поля поиска и EventName=«TextChanged»;
  • UpdateProgress с небольшой задержкой DisplayAfter, чтобы индикатор не мигал на быстрых ответах.

Производительность фильтра

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

Условие LIKE '%текст%' не использует индекс, и на миллионе строк каждый запрос будет сканировать таблицу. Если поиск идёт по началу имени, используйте LIKE 'текст%', тогда индекс по Customer сработает. Для поиска по любой части слова в SQL Server есть полнотекстовый индекс и предикат CONTAINS.

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

Сегодня такой экран делают на клиенте: в Blazor компонент QuickGrid с ItemsProvider получает фильтр и страницу и запрашивает данные у API, а поле поиска связано через @bind:after с отложенным вызовом. В классическом JavaScript то же реализуют через fetch с AbortController и debounce, а на сервере отдают JSON с постраничной выборкой.

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

Почему таблица пустая после изменения фильтра?

Скорее всего, GridView осталась на странице, которой после фильтрации больше нет. Сбрасывайте PageIndex в ноль в обработчике изменения любого фильтра.

SqlDataSource ничего не возвращает при пустом поле поиска. Почему?

По умолчанию пустая строка превращается в NULL, а при NULL-параметре выборка отменяется. Установите ConvertEmptyStringToNull = False у параметра и CancelSelectOnNullParameter = False у источника.

Можно ли фильтровать без запроса к базе?

Можно держать данные в кэше и применять DataView.RowFilter, но для больших таблиц выгоднее отдавать фильтрацию базе с нормальными индексами.

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