详解PHP的Yii框架中的Controller控制器
控制器是 mvc 模式中的一部分, 是继承yii\base\controller类的对象,负责处理请求和生成响应。 具体来说,控制器从应用主体接管控制后会分析请求数据并传送到模型, 传送模型结果到视图,最后生成输出响应信息。
操作
控制器由 操作 组成,它是执行终端用户请求的最基础的单元,一个控制器可有一个或多个操作。
如下示例显示包含两个操作view and create 的控制器post:
namespace app\controllers; use yii; use app\models\post; use yii\web\controller; use yii\web\notfoundhttpexception; class postcontroller extends controller { public function actionview($id) { $model = post::findone($id); if ($model === null) { throw new notfoundhttpexception; } return $this->render('view', [ 'model' => $model, ]); } public function actioncreate() { $model = new post; if ($model->load(yii::$app->request->post()) && $model->save()) { return $this->redirect(['view', 'id' => $model->id]); } else { return $this->render('create', [ 'model' => $model, ]); } } }
在操作 view (定义为 actionview() 方法)中, 代码首先根据请求模型id加载 模型, 如果加载成功,会渲染名称为view的视图并显示,否则会抛出一个异常。
在操作 create (定义为 actioncreate() 方法)中, 代码相似. 先将请求数据填入模型, 然后保存模型,如果两者都成功,会跳转到id为新创建的模型的view操作,否则显示提供用户输入的create视图。
路由
终端用户通过所谓的路由寻找到操作,路由是包含以下部分的字符串:
- 模型id: 仅存在于控制器属于非应用的模块;
- 控制器id: 同应用(或同模块如果为模块下的控制器)下唯一标识控制器的字符串;
- 操作id: 同控制器下唯一标识操作的字符串。
路由使用如下格式:
controllerid/actionid
如果属于模块下的控制器,使用如下格式:
moduleid/controllerid/actionid
如果用户的请求地址为 http://hostname/index.php?r=site/index, 会执行site 控制器的index 操作。
创建控制器
在yii\web\application网页应用中,控制器应继承yii\web\controller 或它的子类。 同理在yii\console\application控制台应用中,控制器继承yii\console\controller 或它的子类。 如下代码定义一个 site 控制器:
namespace app\controllers; use yii\web\controller; class sitecontroller extends controller { }
控制器id
通常情况下,控制器用来处理请求有关的资源类型,因此控制器id通常为和资源有关的名词。 例如使用article作为处理文章的控制器id。
控制器id应仅包含英文小写字母、数字、下划线、中横杠和正斜杠, 例如 article 和 post-comment 是真是的控制器id,article?, postcomment, admin\post不是控制器id。
控制器id可包含子目录前缀,例如 admin/article 代表 yii\base\application::controllernamespace控制器命名空间下 admin子目录中 article 控制器。 子目录前缀可为英文大小写字母、数字、下划线、正斜杠,其中正斜杠用来区分多级子目录(如panels/admin)。
控制器类命名
控制器id遵循以下规则衍生控制器类名:
将用正斜杠区分的每个单词第一个字母转为大写。注意如果控制器id包含正斜杠,只将最后的正斜杠后的部分第一个字母转为大写;
去掉中横杠,将正斜杠替换为反斜杠;
增加controller后缀;
在前面增加yii\base\application::controllernamespace控制器命名空间.
下面为一些示例,假设yii\base\application::controllernamespace控制器命名空间为 app\controllers:
- article 对应 app\controllers\articlecontroller;
- post-comment 对应 app\controllers\postcommentcontroller;
- admin/post-comment 对应 app\controllers\admin\postcommentcontroller;
- adminpanels/post-comment 对应 app\controllers\adminpanels\postcommentcontroller.
控制器类必须能被 自动加载,所以在上面的例子中, 控制器article 类应在 别名 为@app/controllers/articlecontroller.php的文件中定义, 控制器admin/post2-comment应在@app/controllers/admin/post2commentcontroller.php文件中。
补充: 最后一个示例 admin/post2-comment 表示你可以将控制器放在 yii\base\application::controllernamespace控制器命名空间下的子目录中, 在你不想用 模块 的情况下给控制器分类,这种方式很有用。
控制器部署
可通过配置 yii\base\application::controllermap 来强制上述的控制器id和类名对应, 通常用在使用第三方不能掌控类名的控制器上。
配置 应用配置 中的application configuration,如下所示:
[ 'controllermap' => [ // 用类名申明 "account" 控制器 'account' => 'app\controllers\usercontroller', // 用配置数组申明 "article" 控制器 'article' => [ 'class' => 'app\controllers\postcontroller', 'enablecsrfvalidation' => false, ], ], ]
默认控制器
每个应用有一个由yii\base\application::defaultroute属性指定的默认控制器; 当请求没有指定 路由,该属性值作为路由使用。 对于yii\web\application网页应用,它的值为 'site', 对于 yii\console\application控制台应用,它的值为 help, 所以url为http://hostname/index.php 表示由 site 控制器来处理。
可以在 应用配置 中修改默认控制器,如下所示:
[ 'defaultroute' => 'main', ]
创建操作
创建操作可简单地在控制器类中定义所谓的 操作方法 来完成,操作方法必须是以action开头的公有方法。 操作方法的返回值会作为响应数据发送给终端用户,如下代码定义了两个操作 index 和 hello-world:
namespace app\controllers; use yii\web\controller; class sitecontroller extends controller { public function actionindex() { return $this->render('index'); } public function actionhelloworld() { return 'hello world'; } }
操作id
操作通常是用来执行资源的特定操作,因此,操作id通常为动词,如view, update等。
操作id应仅包含英文小写字母、数字、下划线和中横杠,操作id中的中横杠用来分隔单词。 例如view, update2, comment-post是真实的操作id,view?, update不是操作id.
可通过两种方式创建操作id,内联操作和独立操作. an inline action is 内联操作在控制器类中定义为方法;独立操作是继承yii\base\action或它的子类的类。 内联操作容易创建,在无需重用的情况下优先使用; 独立操作相反,主要用于多个控制器重用,或重构为扩展。
内联操作
内联操作指的是根据我们刚描述的操作方法。
操作方法的名字是根据操作id遵循如下规则衍生:
- 将每个单词的第一个字母转为大写;
- 去掉中横杠;
- 增加action前缀.
- 例如index 转成 actionindex, hello-world 转成 actionhelloworld。
注意: 操作方法的名字大小写敏感,如果方法名称为actionindex不会认为是操作方法, 所以请求index操作会返回一个异常,也要注意操作方法必须是公有的,私有或者受保护的方法不能定义成内联操作。
因为容易创建,内联操作是最常用的操作,但是如果你计划在不同地方重用相同的操作, 或者你想重新分配一个操作,需要考虑定义它为独立操作。
独立操作
独立操作通过继承yii\base\action或它的子类来定义。 例如yii发布的yii\web\viewaction和yii\web\erroraction都是独立操作。
要使用独立操作,需要通过控制器中覆盖yii\base\controller::actions()方法在action map中申明,如下例所示:
public function actions() { return [ // 用类来申明"error" 操作 'error' => 'yii\web\erroraction', // 用配置数组申明 "view" 操作 'view' => [ 'class' => 'yii\web\viewaction', 'viewprefix' => '', ], ]; }
如上所示, actions() 方法返回键为操作id、值为对应操作类名或数组configurations 的数组。 和内联操作不同,独立操作id可包含任意字符,只要在actions() 方法中申明.
为创建一个独立操作类,需要继承yii\base\action 或它的子类,并实现公有的名称为run()的方法, run() 方法的角色和操作方法类似,例如:
<?php namespace app\components; use yii\base\action; class helloworldaction extends action { public function run() { return "hello world"; } }
操作结果
操作方法或独立操作的run()方法的返回值非常重要,它表示对应操作结果。
返回值可为 响应 对象,作为响应发送给终端用户。
对于yii\web\application网页应用,返回值可为任意数据, 它赋值给yii\web\response::data, 最终转换为字符串来展示响应内容。
对于yii\console\application控制台应用,返回值可为整数, 表示命令行下执行的 yii\console\response::exitstatus 退出状态。
在上面的例子中,操作结果都为字符串,作为响应数据发送给终端用户,下例显示一个操作通过 返回响应对象(因为yii\web\controller::redirect()方法返回一个响应对象)可将用户浏览器跳转到新的url。
public function actionforward()
{ // 用户浏览器跳转到 http://example.com return $this->redirect('http://example.com'); }
操作参数
内联操作的操作方法和独立操作的 run() 方法可以带参数,称为操作参数。 参数值从请求中获取,对于yii\web\application网页应用, 每个操作参数的值从$_get中获得,参数名作为键; 对于yii\console\application控制台应用, 操作参数对应命令行参数。
如下例,操作view (内联操作) 申明了两个参数 $id 和 $version。
namespace app\controllers; use yii\web\controller; class postcontroller extends controller { public function actionview($id, $version = null) { // ... } }
操作参数会被不同的参数填入,如下所示:
http://hostname/index.php?r=post/view&id=123: $id 会填入'123',$version 仍为 null 空因为没有version请求参数;
http://hostname/index.php?r=post/view&id=123&version=2: $id 和 $version 分别填入 '123' 和 '2'`;
http://hostname/index.php?r=post/view: 会抛出yii\web\badrequesthttpexception 异常 因为请求没有提供参数给必须赋值参数$id;
http://hostname/index.php?r=post/view&id[]=123: 会抛出yii\web\badrequesthttpexception 异常 因为$id 参数收到数字值 ['123']而不是字符串.
如果想让操作参数接收数组值,需要指定$id为array,如下所示:
public function actionview(array $id, $version = null) { // ... }
现在如果请求为 http://hostname/index.php?r=post/view&id[]=123, 参数 $id 会使用数组值['123'], 如果请求为http://hostname/index.php?r=post/view&id=123, 参数 $id 会获取相同数组值,因为无类型的'123'会自动转成数组。
上述例子主要描述网页应用的操作参数,对于控制台应用,更多详情请参阅控制台命令。
默认操作
每个控制器都有一个由 yii\base\controller::defaultaction 属性指定的默认操作, 当路由 只包含控制器id,会使用所请求的控制器的默认操作。
默认操作默认为 index,如果想修改默认操作,只需简单地在控制器类中覆盖这个属性,如下所示:
namespace app\controllers; use yii\web\controller; class sitecontroller extends controller { public $defaultaction = 'home'; public function actionhome() { return $this->render('home'); } }
控制器动作参数绑定
从版本 1.1.4 开始,yii 提供了对自动动作参数绑定的支持。就是说,控制器动作可以定义命名的参数,参数的值将由 yii 自动从 $_get 填充。
为了详细说明此功能,假设我们需要为 postcontroller 写一个 create 动作。此动作需要两个参数:
- category:一个整数,代表帖子(post)要发表在的那个分类的id。
- language:一个字符串,代表帖子所使用的语言代码。
从 $_get 中提取参数时,我们可以不再下面这种无聊的代码了:
class postcontroller extends ccontroller { public function actioncreate() { if(isset($_get['category'])) $category=(int)$_get['category']; else throw new chttpexception(404,'invalid request'); if(isset($_get['language'])) $language=$_get['language']; else $language='en'; // ... fun code starts here ... } }
现在使用动作参数功能,我们可以更轻松的完成任务:
class postcontroller extends ccontroller { public function actioncreate($category, $language='en') { $category = (int)$category; echo 'category:'.$category.'/language:'.$language; // ... fun code starts here ... } }
注意我们在动作方法 actioncreate 中添加了两个参数。这些参数的名字必须和我们想要从 $_get 中提取的名字一致。当用户没有在请求中指定 $language 参数时,这个参数会使用默认值 en 。由于 $category 没有默认值,如果用户没有在 $_get 中提供 category 参数,将会自动抛出一个 chttpexception (错误代码 400) 异常。
从版本1.1.5开始,yii已经支持数组的动作参数。使用方法如下:
class postcontroller extends ccontroller { public function actioncreate(array $categories) { // yii will make sure $categories be an array } }
控制器生命周期
处理一个请求时,应用主体 会根据请求路由创建一个控制器,控制器经过以下生命周期来完成请求:
- 在控制器创建和配置后,yii\base\controller::init() 方法会被调用。
- 控制器根据请求操作id创建一个操作对象:
- 如果操作id没有指定,会使用yii\base\controller::defaultaction默认操作id;
- 如果在yii\base\controller::actions()找到操作id,会创建一个独立操作;
- 如果操作id对应操作方法,会创建一个内联操作;
- 否则会抛出yii\base\invalidrouteexception异常。
- 控制器按顺序调用应用主体、模块(如果控制器属于模块)、控制器的 beforeaction() 方法;
- 如果任意一个调用返回false,后面未调用的beforeaction()会跳过并且操作执行会被取消; action execution will be cancelled.
- 默认情况下每个 beforeaction() 方法会触发一个 beforeaction 事件,在事件中你可以追加事件处理操作;
- 控制器执行操作:
- 请求数据解析和填入到操作参数;
- 控制器按顺序调用控制器、模块(如果控制器属于模块)、应用主体的 afteraction() 方法;
- 默认情况下每个 afteraction() 方法会触发一个 afteraction 事件,在事件中你可以追加事件处理操作;
- 应用主体获取操作结果并赋值给响应.
最佳实践
在设计良好的应用中,控制器很精练,包含的操作代码简短; 如果你的控制器很复杂,通常意味着需要重构,转移一些代码到其他类中。
归纳起来,控制器:
- 可访问请求 数据;
- 可根据请求数据调用 模型 的方法和其他服务组件;
- 可使用视图构造响应;
- 不应处理应被模型处理的请求数据;
- 应避免嵌入html或其他展示代码,这些代码最好在 视图中处理.
上一篇: JBoss5.x下配置Log4j方法介绍
下一篇: Java编程接口调用的作用及代码分享