cron4j を使ってみた - JavaVM上で動く cron

そもそも cron とは

cron とは、定期的に or 指定した時刻に、何らかの処理を実行させたい場合に使うUNIX系のOSの仕組みです。いわゆるスケジューラというプログラムです。
例えば「サーバのバックアップを取るためのプログラムを毎朝AM4:00に自動で動かす」みたいなことをするときに cron を使うことが多いです。
※ Windows でも、タスクスケジューラという似たような機能があります。

cron4j とは

cron のような機能を JVM上で実装するためのライブラリが cron4j です。これを使うと、Java で cron っぽいプログラムを作れるようになります。
例えば「一度実行すると10分に1回 "Hello" と出力する Java のプログラム」などを簡単に書けるようになります。

cron4j を使ってみる

ライブラリのダウンロード

ここから cron4j-X.X.X.zip をダウンロードして解凍します。 cron4j - a pure Java cron-like scheduler
解凍して出てきたファイルに入っている cron4j-X.X.X.jar にパスを通せば、Java のソースコードの中から cron4j の機能を呼べるようになります。

使い方

まず、cron で実行させたいモジュールを Runnable なクラスとして定義します。

class ScheduledTask implements Runnable{
    @Override
    public void run() {
        System.out.println("hello");
    }
}

次に、Scheduler の schedule()メソッドに、crontab でおなじみの " * * * * * " と、実行する Runnable なクラスを渡し、start() を実行します。
" * * * * * " の部分を変えてあげれば、1時間に1回実行とか、◯月◯日の×時×分に実行とか、色んなスケジュールを定義できます。
詳しくは、マニュアルを。cron4j - Documentation and manual

import it.sauronsoftware.cron4j.Scheduler;

public class Main {
    public static void main(String[] args) {
        Scheduler scheduler = new Scheduler();
        scheduler.schedule("* * * * *", new ScheduledTask());
        scheduler.start();
    }
}

これで、１分毎に "hello" と言うだけのプログラムが完成。

ただし、これだと Javaの中で Runnable クラスで定義したコードしか実行できない。もっと、色んなコマンドとか実行させたいときは、ちゃんと本家の cron っぽい使い方もできるようになっています。

本家の cron っぽい使い方をする場合

本家の cron は crontab -eで設定ファイルとしてスケジュールを定義しておき、それを cron デーモンが読み込んで実行するという形態。
これと同じように、外部ファイルにスケジュールを定義して、それを定期的に実行する方法があります。つまり、JVM で動く cron デーモンを作っているような感じです。

まずは、実行させたい外部ファイルを定義し、テキトーにcrontab.txt と名付けます。

* * * * * say "hello"

自分は Mac を使っているので、say コマンドが使えます。これは、引数に渡した文字列を Mac が喋ってくれる（音声が出る）というコマンドです。

コマンド/say - MacWiki

次に、Java コードはこれだけです。

import it.sauronsoftware.cron4j.Scheduler;

public class Main {
    public static void main(String[] args) {     
        Scheduler scheduler = new Scheduler();
        scheduler.scheduleFile(new File("crontab.txt"));
        scheduler.start();
    }
}

これで実行すると、1分に1度、Mac が "Hello" って喋ってくれます。

また、外部ファイルからスケジュールを読んで実行させたいけど、実行させる内容は Java コード内に書きたい！という場合は、public クラスを作り、static 修飾子がついて、引数に String クラスの配列を取るメソッドを定義する必要があります。

public class Test{
    public static void print(String[] s){
        for(int i=0; i<s.length; i++)
            System.out.println(i+"番目の引数: " + s[i]);
        System.out.println();
    }
}

こんな感じ。

そして crontab.txt の中身は、

* * * * * java:Test#print "こんにちは" "Hello" "ni hao"

のように、「java:クラス名#メソッド名引数1 引数2 ...」とします。

これを実行すると、

0番目の引数: こんにちは
1番目の引数: Hello
2番目の引数: ni hao

が、1分毎に出力されるだけの関数が作れました。こんな感じで、外部ファイルから Java 内で定義したメソッドを呼び出して使います。

これで Java で cron と同じことができるようになります。

A little bit of everything

元・情報系大学院生の備忘録