php Yii2框架创建定时任务方法详解

吾爱主题阅读：135 2022-11-16 16:39:00 评论：0

在我们项目开发中，需要使用定时任务来完成批处理业务，下面通过Yii2框架来实现定时任务

Yii2框架定时任务代码统一放在 ./console 目录下

简单的定时任务脚步文件

首先在console/controller目录下创建一个定时任务控制器TestController.php

1 2 3 4 5 6 7 8 9 10 11 12 13 <?php namespace console\controllers; use yii\console\Controller; class TestController extends Controller { /** * 执行测试脚本 */ public function actionDo() { echo 'hello test console' ; } }

在控制台运行命令php yii，会看到test控制下的do方法

······
- test
test/do 执行测试脚本

执行脚步命令php yii 控制器名/方法名，会输出

php yii test/do
hello test console

这就完成了一个简单的定时任务脚步控制器

传递参数

如果需要传递参数

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 <?php namespace console\controllers; use yii\console\Controller; class TestController extends Controller { /** * @var integer 接收的参数 */ public $param1 ; /** * @var string 接收的参数 */ public $param2 ; /** * 设置参数 * @param string $actionID * @return string[] */ public function options( $actionID ) { return [ 'param1' , 'param2' , ]; } /** * 执行测试脚本 */ public function actionDo() { echo $this ->param1 . PHP_EOL; echo $this ->param2 . PHP_EOL; } }

其中 param1和param2就是参数，执行脚步命令php yii 控制器名/方法名 --参数= ····

php yii test/do --param1=123 --param2=hello
123
hello

设置参数别名

如果需要给参数设置别名

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 <?php namespace console\controllers; use yii\console\Controller; class TestController extends Controller { /** * @var integer 接收的参数 */ public $param1 ; /** * @var string 接收的参数 */ public $param2 ; /** * 设置参数 * @param string $actionID * @return string[] */ public function options( $actionID ) { return [ 'param1' , 'param2' , ]; } /** * 参数设置别名 * @return array */ public function optionAliases() { return [ 'p1' => 'param1' , 'p2' => 'param2' ]; } /** * 执行测试脚本 */ public function actionDo() { echo $this ->param1 . PHP_EOL; echo $this ->param2 . PHP_EOL; } }