
Yii2 的命令行工具(Console Application)是开发过程中非常实用的功能,适合执行定时任务、数据维护、消息推送等不需要通过 Web 页面触发的操作。掌握它的使用方法,能极大提升开发效率。
创建和运行控制台命令
在 Yii2 中,控制台命令本质上是继承 yii/console/Controller 的类。你可以将命令放在 console/controllers 目录下。
例如,创建一个简单的命令:
// console/controllers/HelloController.php
<?php<br>namespace console/controllers;<br><br>use yii/console/Controller;<br><br>class HelloController extends Controller<br>{<br> public function actionIndex($name = 'World')<br> {<br> echo "Hello, $name!/n";<br> }<br>}<br>?>
保存后,在项目根目录运行:
php yii hello/index John
输出结果为:Hello, John!
添加选项和参数
你可以通过定义 options() 和 optionAliases() 来支持自定义参数。
示例:添加 verbose 选项
// console/controllers/ProcessController.php
<?php<br>namespace console/controllers;<br><br>use yii/console/Controller;<br><br>class ProcessController extends Controller<br>{<br> public $verbose;<br><br> public function options($actionID)<br> {<br> return ['verbose']; // 声明可用选项<br> }<br><br> public function optionAliases()<br> {<br> return ['v' => 'verbose'];<br> }<br><br> public function actionRun()<br> {<br> if ($this->verbose) {<br> echo "Running in verbose mode.../n";<br> }<br> echo "Processing data.../n";<br> }<br>}<br>?>
调用方式:
php yii process/run –verbose 或简写 php yii process/run -v
集成数据库和其他组件
控制台命令可以像 Web 应用一样使用数据库、日志、缓存等组件,因为它们共享相同的配置文件。
比如在命令中操作数据库:
use app/models/User;<br><br>// 在 action 中使用<br>$users = User::find()->where(['status' => 1])->all();<br>foreach ($users as $user) {<br> echo "Send email to: " . $user->email . "/n";<br>}
确保你的 config/console.php 正确加载了 components,如 db、mailer 等。
定时任务集成(Crontab)
实际项目中,常配合 Linux 的 crontab 定时执行命令。
例如每天凌晨 2 点同步数据:
0 2 * * * /usr/bin/php /path/to/yii app/sync-data
注意:要使用绝对路径,并确认 PHP CLI 环境与 Web 一致。
基本上就这些。写好命令后,记得加日志或邮件通知,方便排查问题。控制台应用虽不显眼,但对系统稳定性很关键。


