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

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 的配置是否显式禁用了排序:
- 确认没写
'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 就会静默失败 —— 查询不报错,但也不排序。











