.NET 6开发TodoList应用之实现查询分页

这篇文章介绍了.NET 6开发TodoList应用之实现查询分页，文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下

需求

查询中有个非常常见的需求就是后端分页，实现的方式也不算复杂，所以我们本文仅仅演示一个后端查询分页的例子。

目标

实现分页查询返回。

原理与思路

对于分页查询而言，我们需要在请求中获取当前请求的是第几页，每页请求多少项数据。在返回值中需要告诉前端，当前这一页的所有数据项列表，总共的数据项有多少。为此我们可以定义一个包装类型，供系统中所有需要提供后端分页查询返回值使用。

除了最基本的实现方式之外，我们可能还需要实现关于分页数据结构的AutoMapper转换映射，避免手动重复实现。

实现

定义分页结果数据结构

我们在Application/Common/Models中定义一个类，表示分页结果。

PaginatedList.cs

using Microsoft.EntityFrameworkCore; namespace TodoList.Application.Common.Models; public class PaginatedList { public List Items { get; } public int PageNumber { get; } public int TotalPages { get; } public int TotalCount { get; } public PaginatedList(List items, int count, int pageNumber, int pageSize) { PageNumber = pageNumber; TotalPages = (int)Math.Ceiling(count / (double)pageSize); TotalCount = count; Items = items; } // 增加属性表示是否有前一页 public bool HasPreviousPage => PageNumber > 1; // 增加属性表示是否有后一页 public bool HasNextPage => PageNumber > CreateAsync(IQueryable source, int pageNumber, int pageSize) { var count = await source.CountAsync(); // 注意我们给的请求中pageNumber是从1开始的 var items = await source.Skip((pageNumber - 1) * pageSize).Take(pageSize).ToListAsync(); return new PaginatedList(items, count, pageNumber, pageSize); } }

添加对于分页结果的Mapping Profile

在Application/Common/Mappings中新增一个类用于实现关于分页结果的扩展方法：

MappingExtensions.cs

using AutoMapper; using AutoMapper.QueryableExtensions; using Microsoft.EntityFrameworkCore; using TodoList.Application.Common.Models; namespace TodoList.Application.Common.Mappings; public static class MappingExtensions { public static Task> PaginatedListAsync(this IQueryable queryable, int pageNumber, int pageSize) { return PaginatedList.CreateAsync(queryable, pageNumber, pageSize); } public static Task> ProjectToListAsync(this IQueryable queryable, IConfigurationProvider configuration) { return queryable.ProjectTo(configuration).ToListAsync(); } }

创建分页查询请求

为了演示分页查询的应用，我们新增一个允许分页查询TodoItem的Query：

GetTodoItemsWithPaginationQuery.cs

using System.Linq; using AutoMapper; using AutoMapper.QueryableExtensions; using MediatR; using TodoList.Application.Common.Interfaces; using TodoList.Application.Common.Mappings; using TodoList.Application.Common.Models; using TodoList.Application.TodoItems.Specs; using TodoList.Domain.Entities; namespace TodoList.Application.TodoItems.Queries.GetTodoItems; public class GetTodoItemsWithPaginationQuery : IRequest> { public Guid ListId { get; set; } public int PageNumber { get; set; } = 1; public int PageSize { get; set; } = 10; } public class GetTodoItemsWithPaginationQueryHandler : IRequestHandler> { private readonly IRepository _repository; private readonly IMapper _mapper; public GetTodoItemsWithPaginationQueryHandler(IRepository repository, IMapper mapper) { _repository = repository; _mapper = mapper; } public async Task> Handle(GetTodoItemsWithPaginationQuery request, CancellationToken cancellationToken) { return await _repository .GetAsQueryable(x => x.ListId == request.ListId) .OrderBy(x => x.Title) .ProjectTo(_mapper.ConfigurationProvider) .PaginatedListAsync(request.PageNumber, request.PageSize); } }

创建查询Controller

TodoItemController.cs

// 对于查询来说，一般参数是来自查询字符串的，所以这里用[FromQuery] [HttpGet] public async Task>> GetTodoItemsWithPagination([FromQuery] GetTodoItemsWithPaginationQuery query) { return ApiResponse>.Success(await _mediator.Send(query)); }