Javaアプリケーションの二重起動を確実に処理したい

Question

###やりたいこと
Javaのバッチ処理アプリケーションを作成する。
アプリケーションにはロックファイルのロック状態を参照して、ロック中ならそこで処理終了することによりアプリケーションの二重起動を防ぐ機能を持たせる。

発生している問題・エラーメッセージ

Windows環境で、Jar形式にしたJavaアプリケーションの動作確認を行っているが、場合により二重起動が防止できない。

public class XXXMain {

	public static void main(String[] args) {
		boolean ret = false;
...
		//起動チェック
		try {
...
			String lockFileName = logPath + "/XXX.lock";
			final FileOutputStream fos = new FileOutputStream(new File(lockFileName));
			final FileChannel fc = fos.getChannel();
			final FileLock lock = fc.tryLock();
			if (lock == null) {
				//既に起動されているので終了する
				logger.info("既に起動されているので終了する");
				System.exit(1);
			}

			//ロック開放処理を登録
			Runtime.getRuntime().addShutdownHook(
				new Thread() {
					public void run() {
						try {
							if (lock != null && lock.isValid()) {
								lock.release();
							}
							fc.close();
							fos.close();
						} catch (IOException e) {
							e.printStackTrace();
						}
					}
				}
			);

			XXXLogic class1 = new XXXLogic();

			class1.setApplicationPath(mainClassPath);	// アプリケーションのパス設定
			ret = class1.dologic(logger, props);	// メール編集->DB登録処理メイン

...
			System.exit(0);
		} catch (Exception e) {
			e.printStackTrace();
			System.exit(2);
		}

	}
}

試したこと

・コマンドプロンプトを２つ開いて、コマンドプロンプト(1)とコマンドプロンプト(2)でほぼ同時にアプリケーションを開始する
→両方のアプリケーションが二重起動チェックの箇所を越えてメイン処理が実行されてしまう。
（後に実行した方のアプリケーションがファイルロック箇所で処理終了してほしい）
・Eclipseをデバッグ実行して、ファイルロックをかけた状態でデバッガで停止させた状態
→コマンドプロンプトからJar形式のアプリケーションを実行する
→コマンドプロンプトから実行したアプリケーションはファイルロック箇所で処理終了する。

補足情報（FW/ツールのバージョンなど）

Java1.8
Eclipse環境で実行、Jar形式をコマンドプロンプトから実行

Comments

[dodox86]

抜粋されたコードなので確認です。この部分ですが、

> String lockFileName = logPath + "/XXX.lock";

logPathは常にその2つのプロセスで同じPATHを指していますか。つまり、正しく、同じファイルのPATHを指していますか。

[taa-sap_032]

logpathの取得部分は省略してしまったのですが、2つのプロセスで同じプロパティファイルからパス項目を取得してファイルパスを生成しており、同じファイルのパスになっています。

[szk.]

「ロックファイル」を使うことは必須なんですか？

[taa-sap_032]

ロックファイルを使う方法でしか対応出来ない、というわけではないようなので他の方法も考えてみます。
本番環境はlinuxなのでプロセスidまたはプロセス名で同じものを検知する？方法も検討しています。

Answer 1

ちょっと試してみましたけど、こちらの環境では問題は発生しませんでした。
jdk-15.0.2 (Windows10)

なんでしょうね…

コマンドプロンプトを２つ開いて、コマンドプロンプト(1)とコマンドプロンプト(2)でほぼ同時にアプリケーションを開始する

ちなみに、ほぼ同時ではなければ（少し間をおくなど）問題は発生しませんでしょうか？

Comments

[taa-sap_032]

>ほぼ同時ではなければ（少し間をおくなど）問題は発生しませんでしょうか？

ロック取得の直後に30秒ほど時間を遅延させる処理(TimeUnitのsleep())を入れた状態でアプリケーションを２か所から実行したところ、二重起動検知→終了と処理本体の実行に分かれたので、複数個所からの実行も間隔が狭すぎなければ二重起動検知は有効なのかと思います。
（実際に動かしたときにどの程度処理時間がかかるのかまだわからないのですが...）

[dodox86]

横からすみません。

> 複数個所からの実行も間隔が狭すぎなければ二重起動検知は有効なのかと思います。

間隔が狭かろうがほぼ同時であろうが、複数の並列（なかんじ）の処理を抑止するためのロックなので、それではダメなのではないかと思います。本質問が投稿された当初、私もコードを簡単にした上でJava8、 11で試しましたが、問題は再現しませんでした。（＜なので回答はしませんでした）
疑う訳ではないのですが、プロパティファイルからPATHを取得しているとのことですが、実際に起動するときに違う値になってしまっているということはありませんでしょうか。

[pg-tips]

私もdodox86さんと同じで、タイミングの問題ではなく、なにか別の問題なのかなと思って質問させていただきました。（同時じゃなくても問題は再現するのではないかなと思って）

FileLock自体はAPI仕様に

> ファイル・ロックはJava仮想マシン全体のために保持されます。
> https://docs.oracle.com/javase/jp/8/docs/api/java/nio/channels/FileLock.html

とあるので二重起動のチェックに使うのは問題ないと思います。

手がかりを得るには…

- 実は違うファイルをロックしてしまっていないか
- 変にプロセスが残っちゃっていてファイルロックしたままになっていないか(タスクマネージャーでJavaプロセスを確認してみるとか）
- 実は例外が発生していてe.printStackTrace()でなにか表示されていないか
- addShutdownHookは期待したとおりのタイミングで動いているか(想定より早くlock.releaseされてないか)

あたりでしょうか。

それでもダメであれば、余計なコードを削除した二重起動チェックだけのシンプルなサンプルを作って、問題が再現するかどうか確認してみるのもよいかもです。

Answer 2

FileChannelつかって、FileLockつかって。なんかかっこういいですが、StandardOpenOption.CREATE_NEWで十分目的は果たせるのではないかと。
「確実に」の保証があるかどうかはわかりませんけど。

import java.nio.file.*;

public class HogeLock{
  private static final Path LOCK_FILE = Paths.get("/tmp/.lock");

  public static void main(final String[] args) throws Exception {
    Files.newOutputStream(LOCK_FILE, StandardOpenOption.CREATE_NEW);
    Thread.sleep(1000);
    Files.delete(LOCK_FILE);
  }
}