CakePHP3で作成したシェルをcron設定する（バッチ処理）

今回はCakePHPで作成したシェルをcronに設定することでバッチ処理を実現する方法を紹介します(CakePHP v.3.4.4)。

話のメインはcronの設定です。
シェルの作成方法はこちらの記事で紹介しています。

CakePHP3でシェルを作成し、コンソールから実行する方法

CakePHP3でシェルを作成し、コンソールから実行する手順を説明いたします。シェルを作ることができれば、cronジョブを使用してバッチ処理を実現するなど、ウェブブラウザからのアクセスを必要としない処理に使うことができます。

blog.chatlune.jp

2018-01-29 10:25

1 シェルの準備
2 crontabコマンド
3 crontabの書式
4 バッチ処理の確認
5 まとめ

シェルの準備

テスト用のシェルを作成し、src/Shell/に格納します。
【HelloLogShell.php】

namespace App\Shell;

use Cake\Console\Shell;
use Cake\Log\Log;

class HelloLogShell extends Shell
{
    public function main()
    {
        LOG::info('Hello World','hello');
    }
}

今回のシェルは、ファイル「logs/hello.log」に「Hello World」のログを残す処理です。

指定のログファイルにログを残す為には他にも設定が必要ですが、今回のお話のメインとはずれますので、そちらの説明は割愛しますが、参考にしたサイトを紹介します。

https://cakephp.euonymus.info/cakephp3%E3%81%AB%E3%81%A6%E3%82%AB%E3%82%B9%E3%82%BF%E3%83%A0%E3%83%AD%E3%82%B0%E3%82%92%E5%87%BA%E5%8A%9B%E3%81%99%E3%82%8B/

cakephp.euonymus.info

crontabコマンド

以下のコマンドで、cronを設定するエディタを起動します。

crontab -e

crontabの書式

crontabuは以下の書式になります。

分　時　日　月　曜日　コマンド

分　0~59、ワイルドカード(\*)を指定すると毎分。
時　0~23、ワイルドカード(\*)を指定すると毎時。
日　1~31、ワイルドカード(\*)を指定すると毎日。
月　1~12、ワイルドカード(\*)を指定すると毎月。
曜日　0~7、ワイルドカード(\*)を指定すると毎日。

複数パターンの設定の仕方は以下

リスト　「時」に「1,5,10」を設定すると、1時、5時、10時に実行
範囲　　「時」に「10-15」を設定すると10時、11時、12時、13時、14時、15時に実行
間隔　　「時」に「\*/2」を設定すると２時間おきに実行

上記の書式を踏まえて、cronの設定を記述してみます。

作成した「HelloLogShell」を1分毎に実行する設定を以下に書きます。

PATH=/Applications/MAMP/htdocs/sample/my_app_name/bin:
*/1 * * * * cake hellolog

１行目の「PATH=」で、コマンドまでのパスを設定できます。
２行目からコマンドの登録になります。
「cake hellolog」が実行コマンドになりますが、パスを設定しておかないとフルパスで書かなければなりませんので、複数のバッチ処理を組みたい場合はパスの設定をした方が良いと思います。パスを複数設定する場合は、パスを「:」コロンで区切ればOKです。
２つ目のコマンドを登録したい場合は、改行して３行目に同じように追加します。
「分」を「*/1」に設定し、他全て「*」となっているので毎分実行されるようになります。

あとは何もせずに待ってみましょう。

バッチ処理の確認

1分毎に、ログがしっかり残せているか「logs/hello.log」の中身を見てみましょう。
【hello.log】


2018-01-26 18:08:01 Info: Hello World
2018-01-26 18:09:00 Info: Hello World
2018-01-26 18:10:01 Info: Hello World
2018-01-26 18:11:00 Info: Hello World
2018-01-26 18:12:01 Info: Hello World
2018-01-26 18:13:00 Info: Hello World

ちゃんと設定通りにコマンドが通っておりますね。