.NET 6開發(fā)TodoList應用之實現(xiàn)查詢分頁
需求
查詢中有個非常常見的需求就是后端分頁,實現(xiàn)的方式也不算復雜,所以我們本文僅僅演示一個后端查詢分頁的例子。
目標
實現(xiàn)分頁查詢返回。
原理與思路
對于分頁查詢而言,我們需要在請求中獲取當前請求的是第幾頁,每頁請求多少項數(shù)據(jù)。在返回值中需要告訴前端,當前這一頁的所有數(shù)據(jù)項列表,總共的數(shù)據(jù)項有多少。為此我們可以定義一個包裝類型,供系統(tǒng)中所有需要提供后端分頁查詢返回值使用。
除了最基本的實現(xiàn)方式之外,我們可能還需要實現(xiàn)關于分頁數(shù)據(jù)結構的AutoMapper轉(zhuǎn)換映射,避免手動重復實現(xiàn)。
實現(xiàn)
定義分頁結果數(shù)據(jù)結構
我們在Application/Common/Models
中定義一個類,表示分頁結果。
PaginatedList.cs
using Microsoft.EntityFrameworkCore; namespace TodoList.Application.Common.Models; public class PaginatedList<T> { public List<T> Items { get; } public int PageNumber { get; } public int TotalPages { get; } public int TotalCount { get; } public PaginatedList(List<T> 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 < TotalPages; // 分頁結果構建輔助方法 public static async Task<PaginatedList<T>> CreateAsync(IQueryable<T> 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<T>(items, count, pageNumber, pageSize); } }
添加對于分頁結果的Mapping Profile
在Application/Common/Mappings
中新增一個類用于實現(xiàn)關于分頁結果的擴展方法:
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<PaginatedList<TDestination>> PaginatedListAsync<TDestination>(this IQueryable<TDestination> queryable, int pageNumber, int pageSize) { return PaginatedList<TDestination>.CreateAsync(queryable, pageNumber, pageSize); } public static Task<List<TDestination>> ProjectToListAsync<TDestination>(this IQueryable queryable, IConfigurationProvider configuration) { return queryable.ProjectTo<TDestination>(configuration).ToListAsync(); } }
創(chuàng)建分頁查詢請求
為了演示分頁查詢的應用,我們新增一個允許分頁查詢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<PaginatedList<TodoItemDto>> { public Guid ListId { get; set; } public int PageNumber { get; set; } = 1; public int PageSize { get; set; } = 10; } public class GetTodoItemsWithPaginationQueryHandler : IRequestHandler<GetTodoItemsWithPaginationQuery, PaginatedList<TodoItemDto>> { private readonly IRepository<TodoItem> _repository; private readonly IMapper _mapper; public GetTodoItemsWithPaginationQueryHandler(IRepository<TodoItem> repository, IMapper mapper) { _repository = repository; _mapper = mapper; } public async Task<PaginatedList<TodoItemDto>> Handle(GetTodoItemsWithPaginationQuery request, CancellationToken cancellationToken) { return await _repository .GetAsQueryable(x => x.ListId == request.ListId) .OrderBy(x => x.Title) .ProjectTo<TodoItemDto>(_mapper.ConfigurationProvider) .PaginatedListAsync(request.PageNumber, request.PageSize); } }
創(chuàng)建查詢Controller
TodoItemController.cs
// 對于查詢來說,一般參數(shù)是來自查詢字符串的,所以這里用[FromQuery] [HttpGet] public async Task<ApiResponse<PaginatedList<TodoItemDto>>> GetTodoItemsWithPagination([FromQuery] GetTodoItemsWithPaginationQuery query) { return ApiResponse<PaginatedList<TodoItemDto>>.Success(await _mediator.Send(query)); }
驗證
啟動Api
項目,執(zhí)行創(chuàng)建TodoList
的請求:
請求
響應
總結
對于后端排序的需求來說,實現(xiàn)起來并不復雜,但是在這個分頁的過程中,要注意一定要以某個不會輕易變動的字段來作為排序的鍵,否則會在多次請求后續(xù)頁的過程中出現(xiàn)因為字段變動導致排序結果變動進而引發(fā)分頁結果的前后不一致的情況。
到此這篇關于.NET 6開發(fā)TodoList應用之實現(xiàn)查詢分頁的文章就介紹到這了。希望對大家的學習有所幫助,也希望大家多多支持腳本之家。
- .NET 6開發(fā)TodoList應用之實現(xiàn)ActionFilter
- .NET 6開發(fā)TodoList應用之實現(xiàn)接口請求驗證
- .NET?6開發(fā)TodoList應用之實現(xiàn)DELETE請求與HTTP請求冪等性
- .NET 6開發(fā)TodoList應用之實現(xiàn)PUT請求
- .NET 6開發(fā)TodoList應用之實現(xiàn)全局異常處理
- .NET 6開發(fā)TodoList應用之使用AutoMapper實現(xiàn)GET請求
- .NET?6開發(fā)TodoList應用之實現(xiàn)Repository模式
- .NET?6開發(fā)TodoList應用之使用MediatR實現(xiàn)POST請求
- .NET 6開發(fā)TodoList應用引入數(shù)據(jù)存儲
- .NET?6開發(fā)TodoList應用引入第三方日志庫
- .NET 6開發(fā)TodoList應用實現(xiàn)結構搭建
- .NET?6開發(fā)TodoList應用實現(xiàn)系列背景
- 使用.NET?6開發(fā)TodoList應用之引入數(shù)據(jù)存儲的思路詳解
- 使用.NET?6開發(fā)TodoList應用之領域?qū)嶓w創(chuàng)建原理和思路
- .NET?6開發(fā)TodoList應用之請求日志組件HttpLogging介紹
相關文章
使用.net?core?自帶DI框架實現(xiàn)延遲加載功能
在某些情況,我們希望能延遲一個依賴的初始化。如果使用的是autofac,我們可以通過注入Lazy來實現(xiàn),這篇文章主要介紹了使用.net?core?自帶DI框架實現(xiàn)延遲加載,需要的朋友可以參考下2023-02-02.Net使用SuperSocket框架實現(xiàn)WebSocket后端
這篇文章介紹了.Net使用SuperSocket框架實現(xiàn)WebSocket后端,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2022-01-01通過剪貼板實現(xiàn)將DataGridView中的數(shù)據(jù)導出到Excel
這篇文章主要介紹了如何通過剪貼板實現(xiàn)將DataGridView中的數(shù)據(jù)導出到Excel,需要的朋友可以參考下2014-05-05