ロック処理です。以前の現場でソース上使っているのを見たことがありますが、私は意識をしていませんでした。

ロックが取得出来たら処理。取得できなかったら少しまって再度取得。取得できなかったらエラーみたいなことをやっていた記憶があるので、そんな感じのものを実装してみます。

以前やったsynchronizedを使った簡単なロック処理

リンク

synchronizedは、利用するメソッドに対して単純にロックをかけたい場合は便利ですが、ロック可能かチェックできないとかメソッドやクラスを跨ってロックできないなどの問題があります。

Lockインターフェースを利用することで明示的ロックをより細かいロック制御を行うことができる。

軽く実践

以下のようなクラスがある。見ての通りただカウントをインクリメントするだけのしょうもないクラスです。

public class SampleSave {

	private int count;
	
	public SampleSave() {
		this.count = 0;
		System.out.println("countを初期化しました。");
		System.out.println("count : " + this.count);
	}
	
	public void incCount() {
		this.count++;
		System.out.println("count : " + this.count);
	}

}

Userクラスは、上述のクラスをコンストラクタで受け取り、とにかくインクリメントメソッドを発火しまくる

package User;

import com.volkruss.uzuisama.SaveLogic.SampleSave;

public class User implements Runnable{
	
	private SampleSave save;
	
	public User(SampleSave save) {
		this.save = save;
	}

	@Override
	public void run() {
		try {
			for(int i = 0; i < 100; i++) {
				this.save.incCount();
				Thread.sleep(10);
			}
		} catch (InterruptedException e) {
			e.printStackTrace();
		}
	}

}

とりあえずコンソールの値を確認してみよう！普通に考えれば同じSampleSaveクラスを受取っているのだから、カウントは順番に進んでいくよ。。。

@Test
	void test() {
		SampleSave sample = new SampleSave();
		
		List<User> users = List.of(
				new User(sample),
				new User(sample),
				new User(sample),
				new User(sample),
				new User(sample),
				new User(sample),
				new User(sample)
			);	
		
		for(User user: users) {
			Thread t = new Thread(user);
			t.start();
		}
			
	}

countを初期化しました。
count : 0
count : 1
count : 2
count : 2
count : 5
count : 5
count : 5
count : 5
count : 7
count : 7
count : 7
count : 9
count : 10
count : 9

これはなかなか悲惨な結果です。

というわけでロック処理を行ってみます。ロックをかける際にはlockメソッドを使いますが、unlockを忘れずに行います。

runメソッドは修正しておきます

@Override
	public void run() {
		this.save.incCount();
	}

ロック処理を取り入れます

public class SampleSave {

	private int count;
	
	// ReentrantLockを利用する
	private final Lock lock = new ReentrantLock();
	
	public SampleSave() {
		this.count = 0;
		System.out.println("countを初期化しました。");
		System.out.println("count : " + this.count);
	}
	
	public void incCount() {
		// ロックをかける
		this.lock.lock();
		try {
			this.count++;
		} finally {
			System.out.println("ロックを外しました。");
			//ロックを開放する
			lock.unlock();
		}
		
		System.out.println("count : " + this.count);
	}

}

これを実行すると気持ちの良いログが流れます？

countを初期化しました。
count : 0
ロックを外しました。
count : 1
ロックを外しました。
count : 2
ロックを外しました。
count : 3
ロックを外しました。
count : 4
ロックを外しました。
count : 5
ロックを外しました。
count : 6
ロックを外しました。
count : 7
ロックを外しました。
count : 8

何回かやるとロックを突破している?人を発見します

countを初期化しました。
count : 0
ロックを外しました。
count : 1
ロックを外しました。
count : 2
ロックを外しました。
count : 3
ロックを外しました。
ロックを外しました。
count : 5
ロックを外しました。
count : 5
ロックを外しました。
count : 7
count : 6

ReentrantLookの生成時にtrueを渡してあげます

// ReentrantLockを利用する
private final Lock lock = new ReentrantLock(true);

tryLock

tryLockはロックが取得できればtrueを返しますので、ロックが取得できない場合はそもそも処理をしないということができます。

ちょっと全体的にコードを見直します。

Userクラスは名前を持つようにして、誰がロックを取得したのかがわかるようにします。

public class User implements Runnable{
	
	private SampleSave save;
	
	private String name;
	
	public User(SampleSave save, String name) {
		this.save = save;
		this.name = name;
	}

	@Override
	public void run() {
		this.save.incCount(this.name);
	}
}

そしてtryLockを利用します。ロックを取得したユーザーのみが処理を行えるようにしました。これは最初のフレームで呼ばれている人が確実にロックを取得できます。あとは何らかの要因で進められる人が出てくる場合があります。

public void incCount(String name) {
		// ロックをかける
		if(this.lock.tryLock()) {
			try {
				System.out.println(name + "がカウントを進めます");
				this.count++;
				System.out.println("現在のカウント" + this.count);
			} finally {
				System.out.println("ロックを外しました。");
				//ロックを開放する
				lock.unlock();
			}
		}else {
			System.out.println("失敗ユーザー " + name + " 何者かがロックを取得しています");
		}
		
	}

コンソールを確認します

@Test
	void test() {
		SampleSave sample = new SampleSave();
		
		List<User> users = List.of(
				new User(sample,"ヒカル"),
				new User(sample,"アキラ"),
				new User(sample,"ヨシタカ"),
				new User(sample,"シンイチロウ"),
				new User(sample,"アツシ"),
				new User(sample,"トシロウ"),
				new User(sample,"ユウキ")
			);	
		
		for(User user: users) {
			Thread t = new Thread(user);
			t.start();
		}
			
	}

今回は３回実施しました。

countを初期化しました。
count : 0
ヒカルがカウントを進めます
失敗ユーザー アキラ 何者かがロックを取得しています
失敗ユーザー ヨシタカ 何者かがロックを取得しています
失敗ユーザー シンイチロウ 何者かがロックを取得しています
失敗ユーザー ユウキ 何者かがロックを取得しています
失敗ユーザー トシロウ 何者かがロックを取得しています
失敗ユーザー アツシ 何者かがロックを取得しています
現在のカウント1
ロックを外しました。

countを初期化しました。
count : 0
ヒカルがカウントを進めます
現在のカウント1
ロックを外しました。
失敗ユーザー ヨシタカ 何者かがロックを取得しています
失敗ユーザー シンイチロウ 何者かがロックを取得しています
失敗ユーザー アキラ 何者かがロックを取得しています
失敗ユーザー ユウキ 何者かがロックを取得しています
失敗ユーザー トシロウ 何者かがロックを取得しています
アツシがカウントを進めます
現在のカウント2
ロックを外しました。

countを初期化しました。
count : 0
ヒカルがカウントを進めます
現在のカウント1
ロックを外しました。
失敗ユーザー アキラ 何者かがロックを取得しています
失敗ユーザー ヨシタカ 何者かがロックを取得しています
シンイチロウがカウントを進めます
現在のカウント2
ロックを外しました。
失敗ユーザー アツシ 何者かがロックを取得しています
失敗ユーザー トシロウ 何者かがロックを取得しています
失敗ユーザー ユウキ 何者かがロックを取得しています

ヒカルの処理が終わる場合もあれば、終わらない場合もあります。終わらない場合はちょうどロックを取得しようとした人がロックを取得できます。

すべてのユーザーが処理できるようにtryLockする

tryLockがロックを取得できない場合に処理を弾くことができますが、単なるlockは処理を待ちます。もう一度確認してみます。

public void incCount(String name) {
		this.lock.lock();		
		try {
			System.out.println(name + "がカウントを進めます");
			this.count++;
			System.out.println("現在のカウント" + this.count);
		} finally {
			System.out.println("ロックを外しました。");
			//ロックを開放する
			lock.unlock();
		}
	}

countを初期化しました。
count : 0
ヒカルがカウントを進めます
現在のカウント1
ロックを外しました。
アツシがカウントを進めます
現在のカウント2
ロックを外しました。
シンイチロウがカウントを進めます
現在のカウント3
ロックを外しました。
アキラがカウントを進めます
現在のカウント4
ロックを外しました。
ヨシタカがカウントを進めます
現在のカウント5
ロックを外しました。
トシロウがカウントを進めます
現在のカウント6
ロックを外しました。
ユウキがカウントを進めます
現在のカウント7
ロックを外しました。

tryLockでも全てのユーザーが処理をできるようにします。

tryLockメソッドは上記の通り引数を受取るバージョンも用意されています

この待機時間を設けてあげれば実施できそうです。Mainメソッドにて実行します。

public void incCount(String name) {
		try {
			if(this.lock.tryLock(5,TimeUnit.SECONDS)) {
				try {
					System.out.println(name + "がカウントを進めます");
					this.count++;
					System.out.println("現在のカウント" + this.count);
				} finally {
					System.out.println("ロックを外しました。");
					//ロックを開放する
					lock.unlock();
				}
			}else {
				System.out.println("失敗ユーザー " + name + " 何者かがロックを取得しています");
			}
		} catch (InterruptedException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
		
	}

countを初期化しました。
count : 0
ヒカルがカウントを進めます
現在のカウント1
ロックを外しました。
シンイチロウがカウントを進めます
現在のカウント2
ロックを外しました。
ヨシタカがカウントを進めます
現在のカウント3
ロックを外しました。
アツシがカウントを進めます
現在のカウント4
ロックを外しました。
アキラがカウントを進めます
現在のカウント5
ロックを外しました。
ユウキがカウントを進めます
現在のカウント6
ロックを外しました。
トシロウがカウントを進めます
現在のカウント7
ロックを外しました。

5秒間の待機時間内でロックが取得可能となるためこのようになります。

ではスレッドスリープするとどうなるでしょうか

public void incCount(String name) {
		try {
			if(this.lock.tryLock(5,TimeUnit.SECONDS)) {
				try {
					System.out.println(name + "がカウントを進めます");
					this.count++;
　　　　　 Thread.sleep(1000);
					System.out.println("現在のカウント" + this.count);
				} finally {
					System.out.println("ロックを外しました。");
					//ロックを開放する
					lock.unlock();
				}
			}else {
				System.out.println("失敗ユーザー " + name + " 何者かがロックを取得しています");
			}
		} catch (InterruptedException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
		
	}

countを初期化しました。
count : 0
アキラがカウントを進めます
現在のカウント1
ロックを外しました。
ヒカルがカウントを進めます
現在のカウント2
ロックを外しました。
シンイチロウがカウントを進めます
現在のカウント3
ロックを外しました。
トシロウがカウントを進めます
現在のカウント4
ロックを外しました。
アツシがカウントを進めます
失敗ユーザー ユウキ 何者かがロックを取得しています
失敗ユーザー ヨシタカ 何者かがロックを取得しています
現在のカウント5
ロックを外しました。

スレッドスリープされるのでカウントは5まで進めることができましたが、一部のUserはロックが取得できず失敗しています。

※これを実行するときはmainメソッドから実行してください

public static void main(String[] args) {
		SampleSave sample = new SampleSave();	
		List<User> users = List.of(
				new User(sample,"ヒカル"),
				new User(sample,"アキラ"),
				new User(sample,"ヨシタカ"),
				new User(sample,"シンイチロウ"),
				new User(sample,"アツシ"),
				new User(sample,"トシロウ"),
				new User(sample,"ユウキ")
			);	
		
		for(User user: users) {
			Thread t = new Thread(user);
			t.start();
		}
	}

ザックリですが、Lockの使い方についてやりました。

Lockが取得できない場合は待機時間を設けて再度取得するということもできました。

次回はより実践的な内容でLockを使っていきます。

Java | ロック処理の基本