Yii2的RESTful怎么自定义动作_mapAction添加额外接口【避坑】

酷瑶吖_4234

酷瑶吖_4234

2026-03-21

1007人浏览

原创

在 actions() 返回数组中添加自定义动作需以小写键名配 ['class' => 'app\controllers\mycustomaction'] 格式,且自定义类必须继承 yii\rest\action 并重写 run();同时需在 behaviors() 中配置 verbfilter,并确保控制器继承 yii\rest\controller、开启美化 url、类路径与命名空间一致。

yii2的restful怎么自定义动作_mapaction添加额外接口【避坑】

Yii2 REST Controller 里 actions() 返回的数组怎么加自定义动作

直接在 actions() 方法返回的数组里加键值对就行,键是动作名(URL 路径段),值是动作配置。但注意:这个配置不是直接写类名或闭包,而是得用 Yii2 REST 动作工厂能识别的格式。

  • 最常用的是 ['class' => 'yii\rest\CreateAction'] 这种标准写法,但自定义动作必须指向你自己的 Action 类,比如 ['class' => 'app\controllers\MyCustomAction']
  • 如果想用匿名函数(不推荐),得包装成 ['class' => 'yii\base\InlineAction', 'actionMethod' => 'myCustomMethod'],然后在 Controller 里定义 public function myCustomMethod($id = null) { ... }
  • 别漏掉 'class' 键——只写字符串(如 'app\controllers\MyCustomAction')会被当成 action ID 处理,报 Unknown property: yii\rest\Controller::myCustomAction

为什么继承 yii\rest\Action 比写 InlineAction 更可靠

REST Controller 默认用 yii\rest\Action 做基类,它自动处理了内容协商、HTTP 状态码、序列化、beforeAction/afterAction 钩子等。InlineAction 不具备这些能力,容易导致返回 JSON 失败、状态码始终是 200、OPTIONS 请求没响应等问题。

  • 自定义 Action 类必须继承 yii\rest\Action,不能只继承 yii\base\Action
  • 记得重写 run() 方法,而不是 runWithParams() —— 后者是老版本兼容接口,REST 组件不调用它
  • 如果要支持 PUT/PATCH,别忘了在 behaviors() 里显式声明 'verbFilter' => ['class' => 'yii\filters\VerbFilter', 'actions' => ['my-custom' => ['put', 'patch']]]

my-custom 这种动作名在 URL 中怎么访问,和标准 CRUD 动作冲突吗

不会冲突。Yii2 REST 路由默认只把 index、view、create、update、delete 映射到对应 HTTP 方法;其他动作名一律走 GET /users/my-custom 或 POST /users/my-custom 这种形式,完全由你控制动词绑定。

Yii Framework 2.0.51
Yii Framework 2.0.51

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

下载
  • URL 路径就是 http://api.example.com/users/my-custom(假设控制器是 UsersController)
  • 如果希望支持 /users/123/my-custom,动作类里要手动从 $this->request->get('id') 或 $this->request->getBodyParam('id') 取参数,REST 基类不自动注入
  • 别在 actions() 里把 my-custom 写成 myCustom——键名必须全小写,否则路由匹配失败,返回 404

调试时发现动作根本没执行?先查这三个地方

常见“写了动作但请求 404 或进错方法”的原因,基本就卡在这三处。

  • 控制器类没正确继承 yii\rest\Controller(比如误继承了 yii\web\Controller),会导致整个 actions() 机制失效
  • urlManager 配置里没启用 'enablePrettyUrl' => true 和 'showScriptName' => false,导致路由解析不到自定义动作段
  • 动作类文件没被自动加载——检查命名空间是否和 app/controllers/ 目录结构一致,比如 app\controllers\MyCustomAction 必须放在 @app/controllers/MyCustomAction.php

自定义动作真正麻烦的不是写法,而是它游离在标准 REST 生命周期之外:序列化规则、数据验证、事务边界、缓存头,都得自己补全。很多人加完动作发现返回数据没转 JSON、没带 Content-Type: application/json,其实就是忘了在 run() 里调 $this->controller->serializeData() 或手动设置响应格式。

相关文章

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

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

下载

相关标签:

yii

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

相关专题

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

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

2025.11.26

544

16

json数据格式
json数据格式

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

2023.08.07

2155

5

json是什么
json是什么

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

2023.08.23

3302

1

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

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

2023.10.13

1116

3

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

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

2025.09.10

3799

7

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

2024.03.01

1698

6

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.03

1758

5

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

2744

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Yii Framework 2.0 API 官方文档
Yii Framework 2.0 API 官方文档

共0课时 | 0人学习

Yii2.0框架开发实战视频教程
Yii2.0框架开发实战视频教程

共22课时 | 9.3万人学习