C#怎么实现WebAPI分页返回 C#如何实现WebAPI接口的分页查询和返回总数据量【框架】

梦芳大大_4361

梦芳大大_4361

2026-03-27

621人浏览

原创

分页响应必须在JSON体中包含TotalCount字段,推荐使用泛型PagedResponse类封装;需用CountAsync()单独查总数,避免Skip().Take()遗漏;应封装PagingOptions统一校验;大数据量时优先游标分页。

c#怎么实现webapi分页返回 c#如何实现webapi接口的分页查询和返回总数据量【框架】

分页返回必须带 TotalCount 字段,不能只靠响应头或额外接口

WebAPI 分页的常见误区是把总条数藏在 Content-Range 响应头里,或者要求前端再发一次 GET /api/items/count。这两种方式在真实项目中都容易出问题:前者前端解析成本高、不统一;后者增加请求次数、并发时数据可能不一致。C# WebAPI(尤其 ASP.NET Core)推荐直接在 JSON 响应体里返回结构化分页对象。

正确做法是定义一个泛型分页响应类,比如:

public class PagedResponse<t>
{
    public List<t> Items { get; set; } = new();
    public int TotalCount { get; set; }
    public int PageNumber { get; set; }
    public int PageSize { get; set; }
}</t></t>

后端 Controller 返回这个类型,前端拿到的就是开箱即用的 TotalCount 和当前页数据,不需要拼接逻辑。

IQueryable.Skip().Take() 是基础,但必须配合 CountAsync() 才能拿到总数

很多人以为 Skip().Take() 能自动算总数,其实不能——它只生成 LIMIT/OFFSET SQL,不触发 COUNT 查询。漏掉总数统计会导致 TotalCount 为 0 或硬编码值,分页控件直接失效。

实操建议:

  • 用 await query.CountAsync() 单独查总数,不要用 query.ToList().Count,后者会把全量数据拉到内存
  • 总数查询和分页查询尽量复用同一个 IQueryable 基础(比如过滤条件一致),否则前后数据口径不一致
  • 如果查询本身含复杂 Join 或 GroupBy,Count() 可能比主查询还慢,这时要考虑缓存总数或改用游标分页

示例片段:

var totalCount = await context.Orders.CountAsync(x => x.Status == "Active");<br>var items = await context.Orders<br>    .Where(x => x.Status == "Active")<br>    .Skip((pageNumber - 1) * pageSize)<br>    .Take(pageSize)<br>    .ToListAsync();

ASP.NET Core 中避免手动解析 page 和 pageSize 查询参数

手写 [FromQuery] int page = 1, [FromQuery] int pageSize = 20 看似简单,但容易忽略边界校验和默认值一致性。更麻烦的是,不同接口重复写这套逻辑,后期改分页规则(比如全局限制 pageSize ≤ 100)就得逐个改。

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载

推荐方案:

  • 封装一个 PagingOptions 模型,加 [ModelBinder] 或使用 AddMvcOptions(x => x.ModelBinderProviders.Insert(0, new PagingModelBinderProvider()))
  • 在模型里做默认值和范围约束:[Range(1, 100)] public int PageSize { get; set; } = 20;
  • Controller 方法签名直接接收 PagingOptions paging,干净且可复用

这样连错误响应都统一:当传入 pageSize=500,框架自动返回 400 并带验证失败信息,不用自己 if (pageSize > 100) throw...。

EF Core 分页性能陷阱:OFFSET 越大越慢,10 万行后 Skip(10000) 可能卡住

SQL Server/PostgreSQL 的 OFFSET 在大数据量下本质是“跳过前 N 行再取”,不是随机访问。Skip 值越大,数据库扫描越多,甚至可能放弃索引走全表扫描。

应对策略取决于场景:

  • 如果只是管理后台、数据量稳定在 10 万以内,Skip()/Take() 足够,加好 CreatedTime 等排序字段的索引就行
  • 如果是用户高频翻页的列表(比如商品、订单),且总量超 50 万,优先考虑游标分页(WHERE id > @lastId ORDER BY id LIMIT 20),用 id 或时间戳做游标
  • 不要为了“支持任意跳页”强行保留 OFFSET 分页——用户几乎不会翻到第 200 页,真有需求就用搜索或筛选替代

游标分页在 C# 里实现很简单:参数从 page 改成 cursor(比如上一页最后一条的 Id),查询语句变成 .Where(x => x.Id > cursor).Take(pageSize)。

真正难的不是代码怎么写,而是说服产品接受“只能下一页/上一页”,以及处理游标值重复、删除导致断层这些边界情况。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

c#

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
c#是什么意思
c#是什么意思

C#是一种通用的面向对象编程语言,它在.NET框架上运行,可用于开发各种类型的应用程序。本专题为大家提供c#相关的各种文章、以及下载和课程。

2023.08.08

1132

5

什么是c#
什么是c#

C#(读作C Sharp)是一种现代的、通用的、面向对象的编程语言。它由微软公司开发,于2000年首次发布,主要用于开发Windows桌面应用程序、Web应用程序、移动应用程序以及游戏开发等领域。C#是一种类型安全和托管的编程语言,它结合了C++的强大性能和C语言的简单易学特点,并引入了许多新的特性和概念,如委托、属性、泛型和异步编程等,以提高开发效率和代码可维护性。

2023.08.31

3331

3

C#中base关键字的用法
C#中base关键字的用法

在C#中,base关键字用于访问当前类的基类成员,这包括基类的字段、属性、方法、构造函数、索引器以及事件。想了解更多C#的相关内容,可以阅读本专题下面的文章。

2024.03.13

945

8

C#Task用法
C#Task用法

Task在C#中是用于表示异步操作的对象,它位于System.Threading.Tasks命名空间中。想了解更多C#中各种用法的相关内容,可以阅读本专题下面的文章。

2024.03.14

2655

11

C# 并发与异步编程
C# 并发与异步编程

本专题系统讲解 C# 异步编程与并发控制,重点介绍 async 和 await 关键字、Task 类、线程池管理、并发数据结构、死锁与线程安全问题。通过多个实战项目,帮助学习者掌握 如何在 C# 中编写高效的异步代码,提升应用的并发性能与响应速度。

2026.02.03

352

18

C# 多线程与异步编程
C# 多线程与异步编程

本专题深入讲解 C# 中多线程与异步编程的核心概念与实战技巧,包括线程池管理、Task 类的使用、async/await 异步编程模式、并发控制与线程同步、死锁与竞态条件的解决方案。通过实际项目,帮助开发者掌握 如何在 C# 中构建高并发、低延迟的异步系统,提升应用性能和响应速度。

2026.02.06

429

20

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

2026.03.11

631

24

C# Unity游戏开发与ECS架构实践
C# Unity游戏开发与ECS架构实践

本专题聚焦 C# 在 Unity 游戏开发中的应用,系统讲解 ECS(Entity-Component-System)架构设计、游戏对象管理、性能优化与内存控制策略。通过实际游戏案例,帮助开发者构建高性能、结构清晰的游戏系统,提高游戏开发效率与运行性能。

2026.04.13

329

20

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习