TP6接口排序分页功能的实现

云婷酱_7199

云婷酱_7199

2026-08-18

213人浏览

原创

ThinkPHP6 实现接口排序分页需结合 order() 与 paginate(),校验 sort/order 参数防 SQL 注入,支持单/多字段排序,推荐封装 PageService 统一处理,并注意索引优化与空值处理。

tp6接口排序分页功能的实现

ThinkPHP6 中实现接口的排序和分页,核心是结合查询条件、order() 方法与 paginate() 方法,同时注意参数校验与安全性。

一、基础分页 + 排序(GET 参数驱动)

通常前端通过 page、limit、sort、order 等参数控制分页与排序。例如:

  • sort=id:按 id 字段排序
  • order=desc:降序(默认可设为 asc)
  • page=2&limit=10:第 2 页,每页 10 条

后端示例(控制器中):

$sort = $this->request->get('sort', 'id');
$order = strtolower($this->request->get('order', 'asc'));
$limit = (int) $this->request->get('limit', 15);
$page = (int) $this->request->get('page', 1);

// 白名单校验字段与排序方向,防 SQL 注入
$allowFields = ['id', 'name', 'create_time', 'status'];
$allowOrders = ['asc', 'desc'];

if (!in_array($sort, $allowFields) || !in_array($order, $allowOrders)) {
    return json(['code' => 400, 'msg' => '非法排序参数']);
}

$list = User::where('status', 1)
    ->order($sort, $order)
    ->paginate([
        'list_rows' => $limit,
        'page'      => $page,
    ]);

return json(['code' => 200, 'data' => $list->items(), 'total' => $list->total()]);

二、支持多字段排序(如 sort=name,create_time&order=asc,desc)

当需按多个字段排序时,可解析逗号分隔的字符串:

Unreal Images
Unreal Images

Unreal Images是一款提供免费 AI 生成图片、照片、艺术图和插画的图库网站。

下载
$sorts = array_filter(array_map('trim', explode(',', $this->request->get('sort', 'id'))));
$orders = array_filter(array_map('trim', explode(',', $this->request->get('order', 'asc'))));

// 对齐字段与排序方式,不足补默认值
$orders = array_pad($orders, count($sorts), 'asc');

foreach (array_combine($sorts, $orders) as $field => $dir) {
    if (in_array($field, $allowFields) && in_array(strtolower($dir), $allowOrders)) {
        $query->order($field, strtolower($dir));
    }
}

三、统一封装分页查询服务(推荐复用)

把分页+排序逻辑抽成公共方法,提升可维护性:

  • 新建 app/common/service/PageService.php
  • 提供静态方法 buildQuery,接收 Query 对象、请求参数、允许字段
  • 自动处理字段白名单、空值跳过、默认排序等

调用示例:

$query = User::where('deleted_at', null);
PageService::buildQuery($query, $this->request, ['id','name','score'], 'id');
$data = $query->paginate(['list_rows' => 10]);

四、注意事项与优化点

  • 必须校验排序字段:禁止直接拼接用户输入到 order(),否则引发 SQL 注入
  • 索引优化:对常用排序字段(尤其是联合排序)添加数据库索引,避免 filesort
  • 空值处理:如需将 NULL 值排在最后,可用 orderRaw("isnull(`field`) asc, `field` desc")
  • 隐藏敏感字段:返回前用 hidden 或 visible 控制模型字段输出

相关文章

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

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

下载

相关标签:

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

相关专题

更多
硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

2023.10.19

3208

3

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

2025.10.17

5289

12

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2025.12.29

3869

9

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

2026.01.19

486

15

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

2026.11.05

0

12

DBeaver安全防护教程大全
DBeaver安全防护教程大全

DBeaver安全防护专题,围绕数据库连接安全、账号密码保护和访问权限管理展开,整理SSL/TLS加密连接、SSH隧道、数据库凭据保存及证书验证等配置方法,同时介绍敏感信息保护、远程连接风险和高权限账号使用等注意事项,帮助用户提高数据库日常管理的安全性。

2026.11.05

0

12

DBeaver连接创建与配置教程
DBeaver连接创建与配置教程

本专题聚焦DBeaver数据库连接配置与管理,覆盖从新建连接、选择数据库类型到填写连接参数和验证连接的完整流程。针对MySQL、PostgreSQL、SQL Server等常见数据库,整理相应的连接设置方法,并提供驱动缺失、认证失败和连接异常等问题的排查方向。

2026.11.04

0

16

XORM框架结构体映射与表结构同步
XORM框架结构体映射与表结构同步

本专题围绕XORM框架的结构体映射展开,说明表名与字段的命名策略、xorm标签常用属性、主键自增与时间字段自动填充,并演示Sync2自动建表、增量字段升级、索引声明与反向生成结构体的完整流程。

2026.11.04

0

15

XORM框架安装配置与数据库连接
XORM框架安装配置与数据库连接

本专题聚焦XORM框架的配置与连接环节,拆解MySQL、PostgreSQL、SQLite、SQL Server的DSN写法与驱动选择,讲清连接池参数、多数据源拆分、读写分离与超时重连的处理方式,并补充容器与兼容数据库的适配经验。

2026.11.04

0

15

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习