現在の位置: ホーム> 最新記事一覧> YII2 CRONサービスの構成と開発ガイド：タイミングタスク管理を簡単に実装する

YII2 CRONサービスの構成と開発ガイド：タイミングタスク管理を簡単に実装する

gitbox 2025-06-13

クロンサービスとは何ですか

Cronサービスは、タスクを定期的に実行するためのツールです。これにより、プログラムは指定された期間に応じて特定のタスクを自動的に実行できます。 Yii2では、Yii2Tech/Cron拡張機能パッケージをインストールすることにより、Cronサービスの機能を実装できます。この拡張パッケージを使用すると、Yii2のコンソールアプリケーションを介してスケジュールされたCronタスクを実行し、実行情報をリアルタイムで出力できるため、開発者がタスクステータスを監視しやすくなります。

Yii2Tech/Cron拡張機能パッケージをインストールする方法

まず、Composerを使用してYii2Tech/Cron拡張機能パッケージをインストールする必要があります。

 composer require yii2tech/cron

インストールが完了したら、拡張機能パッケージを有効にするためにコンソールアプリケーションを構成する必要があります。構成手順は次のとおりです。

ステップ1：Yii2コン​​ソールアプリケーションを作成します

プロジェクトルートディレクトリに移動し、次のコマンドを使用してコンソールアプリケーションを作成します。

 php yii2-app console

これにより、Cronタスクを実行するためにコンソールと呼ばれるプロジェクトでコンソールアプリケーションが生成されます。

ステップ2：Yii2Tech/Cron拡張機能パッケージを構成します

コンソールアプリケーションの構成ファイルでは、 `Console/config/main.php`ファイルに以下を追加するだけです。

 return [
    //...
    'controllerMap' => [
        //...
        'cron' => \yii2tech\crontab\CronController::class,
    ],
    'components' => [
        'crontab' => [
            'class' => \yii2tech\crontab\CronTab::class,
            'crontabFile' => '@app/config/crontab',
        ],
    ],
];

このコードでは、「controlmap」に「cron」要素を構成することにより、yii2tech/cron拡張機能パッケージによって提供されるcroncontrollerを有効にします。同時に、cronタスクスケジューリングファイルの場所を指定する「crontab」という名前のコンポーネントも構成しました。

クロンサービスの書き方

拡張機能パッケージのインストールと構成を完了した後、Cronタスクの書き込みを開始できます。特定の手順は次のとおりです。

ステップ1：Cronタスクを定義します

Yii2でCronタスクを定義するのは簡単です。「Yii2tech \ crontab \ cronjob」クラスから継承されたタスククラスを作成するだけです。例えば：

 class ClearLogs extends yii2tech\crontab\CronJob
{
    public function getSchedule()
    {
        return '0 * * * *';  // 時給0数分間の実行
    }

    public function run()
    {
        Yii::info('Cronタスクは実行されています');
        $logPath = 'logs/*.log';
        array_map('unlink', glob($logPath));  // すべてを削除します.log書類
    }
}

上記のコードは、「ClearLogs」と呼ばれるCronタスクを定義します。これは、時間の0分に実行され、ログフォルダーの下のすべての「.log」ファイルを削除してディスクスペースを解放するのに役立ちます。

ステップ2：CronサービスにCronタスクを追加します

タスクが書かれた後、Cronサービスにタスクを構成する必要があります。手順は次のとおりです。

Substep 1：Cron構成ファイルを書き込みます

`Console/Config`ディレクトリに「Crontab」という名前のファイルを作成し、Cronタスクとスケジューリング情報を追加します。以下に示すように：

 # crontab 形式：
# * * * * * 注文
# 使い方：
# {schedule} {command}
# 1時間ごとにログをきれいにします
0 * * * * php {yii} clear-logs
# 毎日3:00クリアキャッシュ
0 3 * * * php {yii} cache/flush-all

このファイルでは、「ClearLogs」タスクと別のタスクのスケジュール時間を構成します（キャッシュのクリアなど）。

Substep 2：Cronサービスを実行します

構成を完了したら、Cronサービスを開始し、タイミングタスクの実行を開始できます。コマンドラインで、プロジェクトルートディレクトリに移動し、次のコマンドを実行します。

 php yii cron

この時点で、CRONタスクはバックグラウンドでスケジュールされていると実行され、コンソールの実行ログを表示できます。

要約します

Cronサービスは、開発者がタスクを自動化し、時間と労力を節約するのに役立つ非常に実用的なツールです。 Yii2フレームワークでは、「Yii2Tech/Cron」拡張機能パッケージを介してCronサービスを簡単に実装し、単純な構成で定期的にさまざまなタスクを実行できます。このアプローチは、開発効率を改善し、繰り返しの運用を削減するのに役立ちます。この記事があなたを助けることを願っています！

関連内容