[PHP知识库]Yii2 创建定时任务

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

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

简单的定时任务脚步文件

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

<?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

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

传递参数

如果需要传递参数

<?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

设置参数别名

如果需要给参数设置别名

<?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;
    }
}

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

php yii test/do -p1=123 -p2=hello
123
hello

注意：设置参数别名后，使用别名参数用一个横杆（-）链接。

在Linux配置crontab

执行命令crontab -e，我们以每分钟执行一次为例

*/1 * * * * /usr/bin/php /var/www/html/yii2-project/yii test/do >/dev/null 2>&1

其中

• /usr/bin/php 是php运行文件
• /var/www/html/yii2-project/yii 项目目录中的yii 文件
• test/do 是执行脚步命令
• >/dev/null 2>&1 这么写就行哈，可自行查找

保存退出即可。