「［改訂新版］Spring入門 ――Javaフレームワーク・より良い設計とアーキテクチャ」という本を買った。SpringFramework4なので1つ古い感じがするが、内容として〇〇層の設計と実装というような感じで設計を意識した感じが良かったので購入しました(えーと近くのブックオ・・・ｺﾞﾎﾝ)

他にもSpringSecurityについて解説があったり満足できる内容です。

キャッシュ機能

キャッシュを使う動機としては

「頻繁に変更されることのないデータ(マスタデータなど)については、毎回データアクセスを行うのではなくキャッシュを利用したほうがパフォーマンスが良い」

サンプルとしてSpring でデータキャッシングが簡潔でわかりやすいです。

以下の手順で実装します

キャッシュが必要な箇所に@Cacheableアノテーションを付ける
キャッシュの更新は@CacheEvictアノテーションを付ける
@Cacheableアノテーションを有効化するには@EnableCachingアノテーションを利用する

時間のかかる処理

以下のクラスはデータベースからレコードを取得してくる想定のリポジトリ実装クラスです（実際にはただのクラスです）

@Component
public class SampleRepository {
	
	private List<String> database = new ArrayList<>();
	
	public SampleRepository() {
		this.database.addAll(List.of("リンゴ","ジャガイモ","ブロッコリー","チキン"));
	}
	
	public List<String> findAll(){
		// 時間がかかる処理
		this.simulateSlowService();
		// ここでDAOからデータを取得する
		return List.copyOf(this.database);
	}

	public void add(String name) {
		this.database.add(name);
	}
	
	private void simulateSlowService() {
		try {
			long time = 3000L;
			Thread.sleep(time);
		}catch (InterruptedException e) {
			throw new IllegalStateException(e);
		}
	}
}

simulateSlowServiceメソッドは、わざと処理に時間をかけています。

これをテストしてみるととても時間がかかることがわかります

@SpringBootTest
class SampleRepositoryTest {

	@Autowired
	private SampleRepository repository;
	
	@Test
	void test() {	
		this.execute();
		this.execute();
		this.execute();
		// レコードを1件追加します
		this.addData("チョコレート チョコレートチップ チーズケーキ");
		this.execute();
		this.execute();
		System.out.println("テスト完了");
		assertTrue(true);
	}
	
	private void execute() {
		// ストップウォッチを利用して経過時間を簡単に計測します
		StopWatch stopWatch = new StopWatch();
		stopWatch.start();
		List<String> lists = this.repository.findAll();
		// データベースから取得したレコードをログ出力しています
		lists.stream().forEach(System.out::println);
		stopWatch.stop();
		System.out.println("処理時間 : " + stopWatch.getTotalTimeMillis());
	}
	
	private void addData(String name) {
		this.repository.add(name);
	}
}

@SpringBootTestアノテーションを付けるとテスト時にもSpringアプリケーションとして実行できます
- @Autowiredアノテーションも利用可能になる
途中でレコードを1件追加しています

ログ

リンゴ
ジャガイモ
ブロッコリー
チキン
処理時間 : 3014
リンゴ
ジャガイモ
ブロッコリー
チキン
処理時間 : 3013
リンゴ
ジャガイモ
ブロッコリー
チキン
処理時間 : 3007
リンゴ
ジャガイモ
ブロッコリー
チキン
チョコレート チョコレートチップ チーズケーキ
処理時間 : 3009
リンゴ
ジャガイモ
ブロッコリー
チキン
チョコレート チョコレートチップ チーズケーキ
処理時間 : 3001
テスト完了

データアクセスが発生するたびに、このような時間がかかってしまいます。そこでキャッシュを利用してみます。

キャッシュ機能を使う

@Component
public class SampleRepository {
	
	private List<String> database = new ArrayList<>();
	
	public SampleRepository() {
		this.database.addAll(List.of("リンゴ","ジャガイモ","ブロッコリー","チキン"));
	}
	// キャッシュを有効化する
	@Cacheable(value = "database")
	public List<String> findAll(){
		// 時間がかかる処理
		this.simulateSlowService();
		// ここでDAOからデータを取得する
		return List.copyOf(this.database);
	}

	public void add(String name) {
		this.database.add(name);
	}
	
	private void simulateSlowService() {
		try {
			long time = 3000L;
			Thread.sleep(time);
		}catch (InterruptedException e) {
			throw new IllegalStateException(e);
		}
	}
}

@Cacheableアノテーション
- キャッシュを有効化したいメソッドに付与してキャッシュします
- databaseという名前のキャッシュを設定しています

そして、実行時にはこの@Cacheableを有効化する必要があります。

// アノテーションを有効化する
@EnableCaching
@SpringBootTest
class SampleRepositoryTest {

	@Autowired
	private SampleRepository repository;
	
	@Test
	void test() {	
		this.execute();
		this.execute();
		this.execute();
		// レコードを1件追加します
		this.addData("チョコレート チョコレートチップ チーズケーキ");
		this.execute();
		this.execute();
		System.out.println("テスト完了");
		assertTrue(true);
	}
	
	private void execute() {
		// ストップウォッチを利用して経過時間を簡単に計測します
		StopWatch stopWatch = new StopWatch();
		stopWatch.start();
		List<String> lists = this.repository.findAll();
		// データベースから取得したレコードをログ出力しています
		lists.stream().forEach(System.out::println);
		stopWatch.stop();
		System.out.println("処理時間 : " + stopWatch.getTotalTimeMillis());
	}
	
	private void addData(String name) {
		this.repository.add(name);
	}
}

@EnableCachingアノテーション
- キャッシュアノテーション処理の有効化

ログ

リンゴ
ジャガイモ
ブロッコリー
チキン
処理時間 : 3033
リンゴ
ジャガイモ
ブロッコリー
チキン
処理時間 : 1
リンゴ
ジャガイモ
ブロッコリー
チキン
処理時間 : 0
リンゴ
ジャガイモ
ブロッコリー
チキン
処理時間 : 0
リンゴ
ジャガイモ
ブロッコリー
チキン
処理時間 : 0
テスト完了

最初に時間がかかった後はキャッシュを利用しているので全く時間がかかっていないことがわかります。

しかし、追加したレコードが取得できていないことも確認できます。わざわざ、長い名前の「チョコレートチョコレートチップチーズケーキ」を追加したのに、これではいけません。

@CacheEvictアノテーションを利用して、レコード追加時にキャッシュを更新するようにします。

@Component
public class SampleRepository {
	
	private List<String> database = new ArrayList<>();
	
	public SampleRepository() {
		this.database.addAll(List.of("リンゴ","ジャガイモ","ブロッコリー","チキン"));
	}
	
	@Cacheable(value = "database")
	public List<String> findAll(){
		// 時間がかかる処理
		this.simulateSlowService();
		// ここでDAOからデータを取得する
		return List.copyOf(this.database);
	}
  // キャッシュの更新を行う
	@CacheEvict(value = "database", allEntries = true)
	public void add(String name) {
		this.database.add(name);
	}
	
	private void simulateSlowService() {
		try {
			long time = 3000L;
			Thread.sleep(time);
		}catch (InterruptedException e) {
			throw new IllegalStateException(e);
		}
	}
}

@CacheEvictでキャッシュdatabaseの更新を行います
- allEntriesにtrueを渡してすべてのエントリーを強制的に更新するようにしています。

ログ

リンゴ
ジャガイモ
ブロッコリー
チキン
処理時間 : 3036
リンゴ
ジャガイモ
ブロッコリー
チキン
処理時間 : 1
リンゴ
ジャガイモ
ブロッコリー
チキン
処理時間 : 0
リンゴ
ジャガイモ
ブロッコリー
チキン
チョコレート チョコレートチップ チーズケーキ
処理時間 : 3006
リンゴ
ジャガイモ
ブロッコリー
チキン
チョコレート チョコレートチップ チーズケーキ
処理時間 : 0
テスト完了

レコードが追加された時には、キャッシュが更新されていることがわかります。

参考

https://ja.getdocs.org/spring-boot-evict-cache/

Spring | キャッシュ機能