0

0

Yii2的Url规则怎么匹配RESTful_extraPatterns配置自定义动作【方法】

看不見的法師

看不見的法師

发布时间:2026-03-17 01:17:35

|

463人浏览过

|

来源于php中文网

原创

RESTful extraPatterns 不生效的主因是路由顺序或配置错误:规则需排在基础规则后、使用 yii\rest\UrlRule 类、键名格式为“METHOD action”(大小写敏感、空格不可少)、pattern 要含占位符才支持带 ID 动作,且控制器须继承 yii\rest\ActiveController。

yii2的url规则怎么匹配restful_extrapatterns配置自定义动作【方法】

RESTful_extraPatterns 里自定义动作不生效?先看路由是否被前置规则拦截

Yii2 的 UrlRule 在启用 enablePrettyUrl 后,会按数组顺序逐条匹配;一旦某条规则命中,后续规则(包括你写的 extraPatterns)就完全不会执行。常见现象是:GET /users/123/export 返回 404,但 POST /users/123/export 却能进控制器 —— 实际上是被默认的 ['GET' => 'view'] 规则提前吃掉了 export 当作 ID 解析。

  • 确保你的 extraPatterns 所在的规则排在 RESTful 基础规则(如 'pattern' => 'users')之后,且没有更宽泛的通配规则(比如 'pattern' => '<controller:>/<action:>'</action:></controller:>)挡在前面
  • yii\rest\UrlRule::class 而非普通 UrlRule,否则 extraPatterns 字段直接被忽略
  • 调试时临时加 'suffix' => '.json' 或固定后缀,避免和 ID 冲突(例如 'export.json'

extraPatterns 的键名必须是 HTTP 方法 + 空格 + 动作名,不能带斜杠

很多人写成 'GET export' => 'export' 是对的,但写成 'GET /export''get export' 就失效。Yii2 内部用 preg_match('/^([A-Z]+)\s+(.+)$/') 解析键,大小写敏感、空格不可省略、路径前缀不参与匹配 —— 它只管“方法 + 动作名”这个组合是否与当前请求一致。

  • 合法键: 'POST activate''DELETE deactivate''GET index-export'
  • 非法键: 'post activate'(小写)、'POST/activate'(缺空格)、'GET /export'(多了 /
  • 动作名(右边值)对应控制器里的 public 方法名,如 actionExport(),注意驼峰转短横线规则: actionIndexExport()'index-export'

自定义动作的 URL 路径由 pattern 和 extraPatterns 共同决定,不是拼接出来的

比如你配置了 'pattern' => 'users''extraPatterns' => ['POST activate' => 'activate'],那最终可访问的是 POST /users/activate,不是 /users/123/activate。要支持带 ID 的自定义动作,pattern 必须显式包含参数占位符。

  • 想匹配 POST /users/123/activate:pattern 得写成 'pattern' => 'users/<id:>'</id:>,extraPatterns 键仍为 'POST activate'
  • 想同时支持无 ID 和带 ID 的同一动作?不行 —— Yii2 不允许一个 UrlRule 同时覆盖两种结构;得拆成两条规则,或改用 'tokens' => ['{id}' => '<id:>']</id:> 配合更灵活的 pattern
  • 注意 tokens 中的 {id} 必须和 pattern 中出现的占位符一致,否则参数不会注入到 action 参数里

控制器里接收额外参数时,别依赖 $_GET 或 $_POST,要用 action 方法签名

Yii2 的 RESTful 路由会把 pattern 中的 token(如 <id:></id:>)和 query string 自动绑定到 action 方法参数,前提是方法签名明确声明。如果只写 public function actionActivate(),那 /users/123/activate?format=csv 里的 format 就拿不到,$id 也为空。

  • 正确写法:public function actionActivate($id, $format = 'json') { ... },其中 $id 来自 URL 路径,$format 来自 query string
  • 如果参数名和 token 名不一致(比如 token 是 <uid:></uid:>),就得用 @param 注解或在 UrlRule 里配 'params' => ['id' => 'uid']
  • body 提交的 JSON 数据不会自动绑定,仍需手动调用 Yii::$app->request->getBodyParams() 或用 Model::load()

最常被忽略的一点:extraPatterns 生效的前提是整个 UrlRule 的 controller 配置指向了正确的控制器类,且该控制器继承自 yii\rest\ActiveController(或至少实现了 actions() 方法返回含 class 的配置)。否则即使 URL 匹配成功,也会因找不到对应 action 而抛出 Invalid Route 错误。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

180

2025.11.26

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

458

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

549

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

337

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

83

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1071

2023.08.02

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

889

2023.07.31

python中的format是什么意思
python中的format是什么意思

python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

466

2024.06.27

chatgpt使用指南
chatgpt使用指南

本专题整合了chatgpt使用教程、新手使用说明等等相关内容,阅读专题下面的文章了解更多详细内容。

0

2026.03.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号