Yii框架RESTful接口怎么自定义Action_Yii框架重写actions方法【详解】

阿枫姑娘_3822

阿枫姑娘_3822

2026-05-03

600人浏览

原创

直接在控制器写 actionindex() 不够用,因其难以维护分页、过滤、权限校验等逻辑;应通过 actions() 方法配置自定义 action 类,严格遵循命名空间、继承 yii\base\action、实现 run() 方法,并与 activecontroller 生命周期协同。

yii框架restful接口怎么自定义action_yii框架重写actions方法【详解】

为什么直接在控制器里写 actionIndex() 不够用

当你需要为 RESTful 接口提供分页、过滤、权限校验或统一响应格式时,actionIndex() 这类内联方法会快速变得臃肿。比如你要给 GET /api/posts 加上 page 和 per-page 参数处理,还要兼容 expand=user 关联加载,逻辑一多,控制器就难维护、难测试、难复用。

这时候必须把动作逻辑抽离——不是为了“高大上”,而是因为 Yii 的 actions() 方法天然支持参数注入、统一中间件(如 authenticator)、以及与 ActiveController 生命周期无缝对接。

actions() 返回数组里怎么配自定义 Action 类

关键不是“怎么写类”,而是“怎么让控制器认出它并传参”。常见错误是只写类名,漏掉配置项或命名空间不匹配。

  • 类必须继承 yii\base\Action,且必须实现 run() 方法(哪怕空着也会报错)
  • 在 actions() 数组中,键是 action ID(如 'list'),值是配置数组,不是字符串类名(除非是简单无参场景)
  • 配置数组里 'class' 是必需的,其他字段(如 'modelClass'、'checkAccess')会被自动赋值给 Action 实例属性
  • 路径和命名空间必须严格对应文件物理位置,例如 'class' => 'app\actions\PostListAction' 要求文件在 @app/actions/PostListAction.php

示例配置:

Yii Framework 2.0.51
Yii Framework 2.0.51

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

下载
public function actions()
{
    return [
        'list' => [
            'class' => 'app\actions\PostListAction',
            'modelClass' => Post::class,
            'pageSize' => 20,
            'defaultSort' => ['created_at' => SORT_DESC],
        ],
    ];
}

自定义 Action 里怎么拿到请求参数和当前控制器

$this->controller 是你访问控制器上下文的唯一入口,但容易忽略两点:一是它可能为 null(极少见,但单元测试时可能),二是它的 id、route、module 都可直接用;请求参数则不能靠 Yii::$app->request->get() 硬取,而应利用 run() 方法签名自动绑定。

  • run() 方法参数名会自动映射 GET/POST 键名,比如 run($page = 1, $per_page = 10) 会接收 ?page=2&per_page=5
  • 若需原始 request 对象,用 $this->controller->request(比全局 Yii::$app->request 更安全,避免 mock 困难)
  • 权限检查不要写死在 run() 里,应复用 ActiveController::checkAccess(),通过配置 'checkAccess' => [$this, 'checkAccess'] 注入
  • 返回数据统一走 return $this->controller->asJson(...),别直接 echo 或 exit

和 ActiveController 配合时最容易踩的坑

很多人以为重写了 actions() 就能绕过 ActiveController 的默认行为,其实不然——index、view 等默认 action 仍受其 behaviors() 控制。如果你在 actions() 里覆盖了 'index',但没同步处理 authenticator 或 rateLimiter,接口就可能跳过鉴权或限流。

  • 务必调用 parent::actions() 再 unset 或覆盖,否则丢失默认配置(比如 Cors 行为)
  • 如果禁用某个默认 action(如删掉 'delete'),记得在 behaviors() 里也移除对应行为,否则 405 错误会误导前端
  • ActiveController 默认对 index 和 view 自动加 Content-Range 头,你的自定义 Action 若返回分页数据,得手动设置 Range 响应头,否则前端无法正确解析
  • 调试时看日志别只盯 run(),要查 beforeAction() 是否被 ActiveController 的行为拦截了

真正麻烦的从来不是写一个 run(),而是让这个 run() 在整个 REST 生命周期里不被框架其他部分悄悄覆盖或忽略。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

10084

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

5981

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2075

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3748

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4454

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3491

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

4977

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

3882

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

11862

4

热门下载

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

精品课程

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

共22课时 | 9.3万人学习

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

共0课时 | 0人学习