Yii框架RESTful接口怎么排序_Yii框架Sort参数传递方法【方法】

浅辰小哥_3326

浅辰小哥_3326

2026-04-25

354人浏览

原创

yii2 restful 接口排序必须使用逗号分隔的 sort 查询参数,如 -priority,status;仅支持 - 前缀降序,不支持 json、+ 前缀或数组格式;字段名须与模型属性严格一致,并在 sort::attributes 中正确映射数据库字段。

yii框架restful接口怎么排序_yii框架sort参数传递方法【方法】

Yii2 RESTful 接口的排序必须通过 sort 查询参数传递,不能放 body、不能用路径变量、也不能嵌套 JSON 对象。 它是 Yii2 ActiveDataProvider 默认识别的参数名,后端会自动解析成 orderBy 条件 —— 但格式有严格约定,错一个字符就失效。

sort 参数的合法格式是 key1,key2,-key3

Yii2 原生只接受逗号分隔的字段名列表,用 - 前缀表示降序,不带前缀为升序:

  • priority,status → ORDER BY priority ASC, status ASC
  • priority,-status → ORDER BY priority ASC, status DESC
  • -priority,-created_at → ORDER BY priority DESC, created_at DESC

常见错误:sort={"priority":"desc"} 或 sort=[{"priority":"desc"}] 这类 JSON 格式会被直接忽略,ActiveDataProvider 不解析它;sort=+priority,-status 中的 + 也无效,Yii2 不认。

后端必须启用 sort 支持(默认已开,但可能被覆盖)

如果你发现传了 sort 却没生效,检查控制器中 dataProvider 的配置是否显式禁用了排序:

Yii Framework 2.0.51
Yii Framework 2.0.51

Yii Framework 2.0.51 官方 Basic 应用模板,适合旧项目兼容、升级验证和开发测试。

下载
  • 确认没写 'sort' => false 在 ActiveDataProvider 构造参数里
  • 如果自定义了 Sort 对象,要确保 $sort->attributes 包含你要排序的字段,例如:'priority' => ['asc' => 'priority', 'desc' => 'priority DESC']
  • 数据库字段名是蛇形(如 user_name),而模型属性是驼峰(如 userName),则需在 Sort::attributes 中显式映射,否则 sort=userName 会查不到字段

前端请求 URL 示例与注意事项

正确构造 URL 是关键,不要依赖框架自动序列化对象:

  • ✅ 正确:/v1/users?sort=-priority,status
  • ✅ 正确(带分页):/v1/users?sort=-created_at&page=1&per-page=20
  • ❌ 错误:/v1/users?sort={"priority":"desc"}(JSON 字符串不解析)
  • ❌ 错误:/v1/users?sort[]=priority&sort[]=-status(PHP 数组语法,Yii2 不支持)

若用 Axios 或 Fetch,别把 sort 当对象传:params: { sort: '-priority,status' } 就够了,不需要 JSON.stringify。

最容易被忽略的一点:字段名大小写和模型定义必须完全一致。比如模型里定义的是 public $priority,但数据库字段是 priority_level,又没在 Sort::attributes 里做映射,那 sort=priority 就会静默失败 —— 查询不报错,但也不排序。

相关文章

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

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

下载

相关标签:

yii框架 yii

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

相关专题

更多
PHP API接口开发与RESTful实践
PHP API接口开发与RESTful实践

本专题聚焦 PHP在API接口开发中的应用,系统讲解 RESTful 架构设计原则、路由处理、请求参数解析、JSON数据返回、身份验证(Token/JWT)、跨域处理以及接口调试与异常处理。通过实战案例(如用户管理系统、商品信息接口服务),帮助开发者掌握 PHP构建高效、可维护的RESTful API服务能力。

2025.11.26

524

16

sort排序函数用法
sort排序函数用法

sort排序函数的用法:1、对列表进行排序,默认情况下,sort函数按升序排序,因此最终输出的结果是按从小到大的顺序排列的;2、对元组进行排序,默认情况下,sort函数按元素的大小进行排序,因此最终输出的结果是按从小到大的顺序排列的;3、对字典进行排序,由于字典是无序的,因此排序后的结果仍然是原来的字典,使用一个lambda表达式作为key参数的值,用于指定排序的依据。

2023.09.04

1138

7

PHP Yii框架专题
PHP Yii框架专题

本专题专注于PHP主流框架Yii的应用,系统讲解MVC架构、路由机制、数据库操作、表单处理、安全验证与RESTful API 开发等核心内容。通过电商网站、后台管理系统与内容管理平台等实战项目,帮助学员快速掌握Yii框架的开发技巧与实战经验。

2025.09.04

2990

22

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

2026.10.10

100

15

Kratos框架HTTP与gRPC服务开发教程
Kratos框架HTTP与gRPC服务开发教程

本专题围绕Kratos框架双协议服务开发,涵盖HTTP路由与处理器编写、参数获取、gRPC服务实现与客户端调用、metadata上下文传递、encoding编解码注册、统一响应封装、超时控制与流式响应实现方法。

2026.10.10

40

15

Kratos框架Protobuf接口定义与代码生成合集
Kratos框架Protobuf接口定义与代码生成合集

本专题讲解Kratos框架接口定义体系,涵盖proto编写规范、proto add/client/server生成命令、http注解路由、validate校验、OpenAPI文档生成、跨服务proto复用与兼容性设计。

2026.10.10

20

15

C++虚函数怎么定义和调用
C++虚函数怎么定义和调用

C++虚函数是实现运行时多态的重要机制。本专题从virtual关键字的基本用法入手,介绍基类与派生类之间的函数重写、基类指针调用派生类方法,以及动态绑定的执行过程,帮助初学者掌握虚函数的核心语法。

2026.10.10

40

26

C++类与对象的封装方法教程
C++类与对象的封装方法教程

C++封装是面向对象编程的核心特性之一,通过类将数据与操作数据的函数组织在一起,并利用访问权限控制外部访问。本专题介绍类的定义、成员变量、成员函数以及public、private和protected的使用方法,帮助初学者掌握封装的基本原理。

2026.10.10

40

32

C++构造函数定义与调用方法
C++构造函数定义与调用方法

C++构造函数用于初始化类对象,是面向对象编程的重要基础。本专题从构造函数的定义、声明和调用入手,介绍默认构造函数、带参数构造函数、拷贝构造函数及成员初始化列表,帮助初学者掌握对象创建与初始化的基本方法。

2026.10.10

40

16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Yii2.0框架开发实战视频教程
Yii2.0框架开发实战视频教程

共22课时 | 9.3万人学习

Yii Framework 2.0 API 官方文档
Yii Framework 2.0 API 官方文档

共0课时 | 0人学习