Yii2 REST控制器怎么继承ActiveController

夏强同学_1527

夏强同学_1527

2026-09-05

629人浏览

原创

yii rest控制器必须继承yii\rest\activecontroller并设$modelclass,配置yii\rest\urlrule路由规则,且模型需有rules()方法;否则将出现404、空响应或400错误。

yii2 rest控制器怎么继承activecontroller

控制器类必须继承 yii\rest\ActiveController,不能用普通 Controller

Yii2 的 REST 行为(比如自动映射 GET /users 到 index 动作、自动序列化 JSON、处理 Content-Type 协商)只在 yii\rest\ActiveController 及其子类中生效。用 yii\web\Controller 写个 actionIndex(),哪怕返回 json_encode(),也不算 REST 接口——它不响应 Accept: application/json,不校验 HTTP 方法,也不触发 VerbFilter 或 ContentNegotiator。

实操要点:

  • 控制器文件里 use yii\rest\ActiveController;,类定义写 class UserController extends ActiveController
  • 必须声明 public $modelClass = 'app\models\User';,路径要完整、大小写敏感,且该类必须继承 yii\db\ActiveRecord
  • 不要覆盖 actions() 方法,除非你清楚自己在删掉哪些默认动作(index、view、create 等);若覆盖,需显式调用 parent::actions() 并保留关键项
  • 模块内控制器(如 api\modules\v1\controllers\UserController)的 $modelClass 仍写模型的完整命名空间,不写模块前缀,例如 'api\modules\v1\models\User' 或 'common\models\User',不是 'v1\User'

$modelClass 没设对,404 或空响应就来了

ActiveController 本身不查数据库,它靠 $modelClass 去反射调用 findModel($id)、find() 这些静态方法。如果 $modelClass 指向一个不存在的类、没继承 ActiveRecord、或类里没实现 findModel()(比如自定义了主键字段但没重写),请求就会静默失败:GET /users 返回空数组,GET /users/1 返回 404 —— 不报错,只没数据。

检查步骤:

  • 确认模型类存在且可被自动加载(var_dump(class_exists('app\models\User'));)
  • 确认模型继承 yii\db\ActiveRecord,并至少有一个 public static function tableName()
  • 如果主键不是 id,必须在模型中重写 public static function findModel($id),否则 view 和 update 动作会找不到记录
  • 模型里必须有 rules() 方法,否则 POST/PUT 请求即使数据合法,也会因验证跳过而返回 400(ActiveController 默认启用验证,但不会提示缺规则)

URL 规则必须配 yii\rest\UrlRule,且顺序不能错

光有控制器不够。ActiveController 是“能力”,yii\rest\UrlRule 才是“入口”。它负责把 GET /v1/users 解析成 ['v1/user', 'index'],再交给控制器执行。常见错误是:写了自定义路由(比如 '<action>' => 'site/<action>'</action></action>)放在 urlManager->rules 前面,结果所有 REST 请求都被提前匹配、进不了 UrlRule。

Yii Framework 2.0.51
Yii Framework 2.0.51

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

下载

正确配置要点:

  • 'enablePrettyUrl' => true 和 'enableStrictParsing' => true 必须同时开启
  • yii\rest\UrlRule 实例必须放在 rules 数组的末尾
  • 'controller' => ['v1/user'] 中的路径是小写、无命名空间、斜杠分隔的模块+控制器 ID,和实际类名无关(UserController 对应 user)
  • 如果模型叫 User,默认期望复数路由 /users;若想用单数 /user,得加 'pluralize' => false 配置项
  • 别漏 'showScriptName' => false,否则 Apache/Nginx 重写失效时,index.php/v1/users 会走默认路由,不触发 REST 行为

POST/PUT 数据为空?检查 Content-Type 和解析器

ActiveController 默认只解析 application/json 格式的请求体。如果前端用 application/x-www-form-urlencoded 发 POST(比如 jQuery $.post() 默认行为),数据会完全被忽略,$_POST 为空,模型接收不到字段,验证失败后直接返回 400。

解决方式:

  • 前端发请求时显式设置 Content-Type: application/json,并确保 body 是合法 JSON 字符串(如 {"name":"test"})
  • 服务端确认 request 组件已注册 JSON 解析器:'parsers' => ['application/json' => 'yii\web\JsonParser'],通常在 config/web.php 的 components['request'] 下配置
  • 如果必须支持表单编码,得手动在控制器中加解析逻辑,或改用 yii\rest\Controller 自行实现动作,而不是依赖 ActiveController 的自动绑定

最常被忽略的是:模型层 rules() 没定义、URL 规则顺序错、以及 POST 时 Content-Type 不是 JSON —— 这三处一出问题,接口就“看起来能跑,但死活不干活”。

相关文章

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

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

下载

相关标签:

yii2 yii

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

相关专题

更多
PHP Yii框架专题
PHP Yii框架专题

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

2025.09.04

2950

22

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

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

2026.10.10

0

15

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

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

2026.10.10

0

15

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

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

2026.10.10

0

15

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

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

2026.10.10

0

26

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

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

2026.10.10

0

32

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

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

2026.10.10

20

16

Kratos框架零基础入门教程
Kratos框架零基础入门教程

本专题整理Kratos框架入门内容,涵盖Go环境准备、kratos CLI安装升级、new命令创建项目、目录结构分层说明、服务启动与双协议端口、依赖下载报错排查,帮助开发者快速跑通第一个Kratos框架微服务应用。

2026.10.10

0

15

C++条件判断语句怎么写
C++条件判断语句怎么写

C++条件判断是控制程序执行流程的重要基础。本专题介绍if、if-else、else if和switch等常见分支语句,结合条件表达式、比较运算符与代码示例,帮助初学者掌握不同场景下的判断逻辑。

2026.10.10

0

13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Yii2中文手册
Yii2中文手册

共0课时 | 0.6万人学习

thinkphp基础介绍和yii2基础介绍
thinkphp基础介绍和yii2基础介绍

共10课时 | 2.5万人学习

Yii2框架基础视频教程
Yii2框架基础视频教程

共22课时 | 2.8万人学习