Cómo desarrollar un filtro de búsqueda por texto en ASP.NET MVC

Toda aplicación Web basada en la recuperación de información desde una base de datos, requiere de al menos un 'sistema de búsqueda' que permita al usuario acceder a los contenidos en los que está interesado. Como complemento al Post Cómo desarrollar un sistema de paginación en ASP.NET MVC, en este caso veremos cómo desarrollar un 'filtro de búsqueda' por texto y cómo integrarlo a un formulario de consulta de registros con paginación en ASP.NET MVC.

Para desarrollar este ejemplo, utilizaremos la estructura ya creada en el Post Cómo desarrollar un sistema de paginación en ASP.NET MVC, e iremos añadiendo al código las nuevas funcionalidades para integrar el 'filtro de búsqueda' por texto.

El modelo de datos

El modelo de datos sigue siendo el mismo (la tabla 'Customers' de la base de datos de pruebas Northwind). También utilizaremos Entity Framework como medio de acceso a la base de datos.

La Clase de paginación

Añadiremos a la 'clase de paginación' PaginadorGenerico<T>, una nueva propiedad public string BusquedaActual { get; set; } para poder mantener el estado de la búsqueda mientras nos movemos por las páginas de resultados.

    public class PaginadorGenerico<T> where T:class
    {
        public int PaginaActual { get; set; }
        public int RegistrosPorPagina { get; set; }
        public int TotalRegistros { get; set; }
        public int TotalPaginas { get; set; }
        public string BusquedaActual { get; set; }
        public IEnumerable<T> Resultado { get; set; }
    }

El Controlador

En la Acción por defecto Index del Controlador, añadiremos un nuevo parámetro de entrada string buscar donde recibiremos el 'texto de búsqueda' para filtrar los resultados Index(string buscar, int pagina = 1). También implementaremos el nuevo código para el 'filtro de búsqueda':

    public class CustomersController : Controller
    {
        private readonly int _RegistrosPorPagina = 10;

        private AppDbContext _DbContext;        
        private List<Customer> _Customers;
        private PaginadorGenerico<Customer> _PaginadorCustomers;

        // GET: Customers
        public ActionResult Index(string buscar, int pagina = 1)
        {
            int _TotalRegistros = 0;
            int _TotalPaginas = 0;

            // FILTRO DE BÚSQUEDA
            using (_DbContext = new AppDbContext())
            {
                // Recuperamos el 'DbSet' completo
                _Customers = _DbContext.Customers.ToList();

                // Filtramos el resultado por el 'texto de búqueda'
                if (!string.IsNullOrEmpty(buscar))
                {                    
                    foreach (var item in buscar.Split(new char[] { ' ' },
                             StringSplitOptions.RemoveEmptyEntries))
                    {
                        _Customers = _Customers.Where(x => x.ContactName.Contains(item) ||
                                                      x.CompanyName.Contains(item) ||
                                                      x.Email.Contains(item))
                                                      .ToList();
                    }
                }                
            }
            
            // SISTEMA DE PAGINACIÓN
            using (_DbContext = new AppDbContext())
            {
                // Número total de registros de la tabla Customers
                _TotalRegistros = _Customers.Count();
                // Obtenemos la 'página de registros' de la tabla Customers
                _Customers = _Customers.OrderBy(x => x.ContactName)
                                                 .Skip((pagina - 1) * _RegistrosPorPagina)
                                                 .Take(_RegistrosPorPagina)
                                                 .ToList();
                // Número total de páginas de la tabla Customers
                _TotalPaginas = (int)Math.Ceiling((double)_TotalRegistros / _RegistrosPorPagina);

                // Instanciamos la 'Clase de paginación' y asignamos los nuevos valores
                _PaginadorCustomers = new PaginadorGenerico<Customer>()
                {
                    RegistrosPorPagina = _RegistrosPorPagina,
                    TotalRegistros = _TotalRegistros,
                    TotalPaginas = _TotalPaginas,
                    PaginaActual = pagina,
                    BusquedaActual = buscar,
                    Resultado = _Customers
                };
            }
            
            // Enviamos a la Vista la 'Clase de paginación'
            return View(_PaginadorCustomers);
        }
     }

La Vista

En la Vista Index.cshtml añadiremos el código para el 'filtro de búsqueda' (caja de texto y botón), y actualizamos el 'paginador de registros' para que envíe al a Controlador el 'texto de búsqueda' como parámetro buscar = Model.BusquedaActual.

@model PaginadorGenerico<Customer>
@{
    ViewBag.Title = "Customers";
    Layout = "~/Views/Shared/_Layout.cshtml";
}

@*CÓDIGO PARA EL FILTRO DE BÚSQUEDA*@
<div class="text-right form-inline">
    <form method="get" action=@Url.Action("Index", "Customers" )>
        <div class="form-group">
            @Html.TextBox("buscar", null, new { placeholder = "texto de búsqueda",
                                    @class = "form-control" })
        </div>
        <button class="btn btn-default" type="submit">Buscar</button>
    </form>
</div>

<br />
@*CÓDIGO PARA LA TABLA DE DATOS*@
<table class="table table-bordered">
    <thead>
        <tr>
            <th>
                Contact Name
            </th>
            <th>
                Company Name
            </th>
            <th>
                Email
            </th>
        </tr>
    </thead>
    @foreach (var item in Model.Resultado)
    {
        <tbody>
            <tr>
                <td>
                    @Html.DisplayFor(modelItem => item.ContactName)
                </td>
                <td>
                    @Html.DisplayFor(modelItem => item.CompanyName)
                </td>
                <td>
                    @Html.DisplayFor(modelItem => item.Email)
                </td>
            </tr>
        </tbody>
    }
</table>

@*CÓDIGO PARA EL PAGINADOR DE REGISTROS*@
@if (Model.Resultado.Count() > 0)
{
    <span>
        <strong>@Model.TotalRegistros</strong> registros encontrados
    </span>
    <span>&nbsp;|&nbsp;</span>
    <span>
        Página <strong>@(Model.PaginaActual)</strong> de
        <strong>@Model.TotalPaginas</strong>
    </span>
    <span>&nbsp;|&nbsp;</span>
}
else
{
    <span>No hay resultados para esta búsqueda</span>
    <span>&nbsp;|&nbsp;</span>
}

@if (Model.PaginaActual > 1)
{
    @Html.ActionLink("<<", "Index", new { pagina = 1, buscar = Model.BusquedaActual },
                        new { @class = "btn btn-sm btn-default" })
    <span></span>
    @Html.ActionLink("Anterior", "Index", new { pagina = Model.PaginaActual - 1,
                                                buscar = Model.BusquedaActual },
                                          new { @class = "btn btn-sm btn-default" })
}
else
{
    @Html.ActionLink("<<", "Index", new { pagina = 1,
                                          buscar = Model.BusquedaActual },
                                    new { @class = "btn btn-sm btn-default disabled" })
    <span></span>
    @Html.ActionLink("Anterior", "Index", new { pagina = 1,
                                                buscar = Model.BusquedaActual },
                                          new { @class = "btn btn-sm btn-default disabled" })
}

<span></span>

@if (Model.PaginaActual < Model.TotalPaginas)
{
    @Html.ActionLink("Siguiente", "Index", new { pagina = Model.PaginaActual + 1,
                                                 buscar = Model.BusquedaActual },
                                           new { @class = "btn btn-sm btn-default" })
    <span></span>
    @Html.ActionLink(">>", "Index", new { pagina = Model.TotalPaginas,
                                          buscar = Model.BusquedaActual },
                                    new { @class = "btn btn-sm btn-default" })
}
else
{
    @Html.ActionLink("Siguiente", "Index", new { pagina = Model.TotalPaginas - 1,
                                                 buscar = Model.BusquedaActual },
                                           new { @class = "btn btn-sm btn-default disabled" })
    <span></span>
    @Html.ActionLink(">>", "Index", new { pagina = Model.TotalPaginas,
                                          buscar = Model.BusquedaActual },
                                    new { @class = "btn btn-sm btn-default disabled" })
}