Spring Boot キャッシュ入門 — 再取得の省略と更新時の無効化
講義の区切り
基本編の目安は 60 分です。終了条件は、同じ商品の 2 回目の取得でデータの読み込みが省かれることをログで確認できることです。
さらに、価格を更新しても古い値が返る状態を再現し、@CacheEvict を追加して更新後の価格が返ることを確認します。
概要
商品を取得する API と、商品の価格を更新する API を作ります。 取得した商品をキャッシュに保存することで、同じ商品を読み取る処理を省きます。 価格が変わったときは、更新した商品に対応するキャッシュの項目を削除します。
この演習のリクエストは、前の応答を受け取ってから次を送ります。同時実行時の整合性は、後半の「同時実行時の制約」で確認します。
演習では、商品の保管場所とキャッシュの両方に、それぞれ独立したメモリ上の領域を使います。アプリを再起動すると、商品は初期価格に戻り、キャッシュは空になります。
事前準備
- JDK 21
- Controller と Service を使った API の作成経験
- 空きポート 8080
Spring Initializr で新しいプロジェクトを作成します。
Maven / Java / Jar / YAML を選び、Spring Boot は 4.0 系、Java は 21 にします。
Group は dev.mikoto2000.springboot、Artifact は cache、Package name は dev.mikoto2000.springboot.cache です。
依存関係に Spring Web を選び、生成した pom.xml の dependencies に次の依存関係を追加します。
触って学ぶキャッシュ
商品を取得・更新する API を作る
次のファイルは src/main/java/dev/mikoto2000/springboot/cache の下に配置します。
まず、API が返す商品を record で定義します。
次に、商品を保管するクラスを作ります。読み込み時は READ、価格の更新時は UPDATE をログに出します。
価格変更では新しい Product を作り、保管場所の値を置き換えます。
Service の getProduct は商品を取得し、updatePrice は価格を更新します。後でこの 2 つのメソッドにキャッシュのアノテーションを付けます。
Controller を作ります。商品取得は GET /products/{id}、価格の更新は PUT /products/{id}/price?priceYen=1500 です。
プロジェクトのルート(pom.xml と同じ場所)でアプリを起動します。
PowerShell では .\mvnw.cmd spring-boot:run を使います。
別のターミナルから同じ商品を 2 回取得します。PowerShell では、以下の curl を curl.exe に読み替えてください。
どちらも 200 と {"id":1,"name":"Notebook","priceYen":1200} を返し、アプリのターミナルには READ productId=1 priceYen=1200 が 2 行出ます。
@Cacheable で再取得を省く
アプリを Ctrl+C で停止します。src/main/resources/application.yaml の既存の spring に、次の cache 設定を追加します。
spring.application がある場合は、同じ spring の下で application と cache を並べます。
type: simple はアプリ内のメモリを使い、cache-names は利用するキャッシュの名前を指定します。
生成された CacheApplication.java に EnableCaching の import と @EnableCaching を追加します。
ProductService.java に org.springframework.cache.annotation.Cacheable を import し、既存の getProduct メソッドに次のアノテーションを追加します。
#p0 はメソッドの第 1 引数です。このメソッドでは商品 ID の id がキーになります。
アプリを起動し直し、先ほどと同じ GET を 2 回実行します。両方の応答は 1200 円ですが、READ productId=1 priceYen=1200 は 1 行だけ出ます。
更新後に古い価格が残ることを確認する
アプリを動かしたまま、商品 1 の価格を 1500 円に更新してから、もう一度取得します。
PUT は 204 を返し、ログに UPDATE productId=1 priceYen=1500 が出ます。一方、直後の GET の本文は priceYen: 1200 のままです。
GET で新たな READ が出ないことも確認します。保管場所には 1500 円が保存され、キャッシュには取得時の 1200 円が残っています。
@CacheEvict で更新した商品のキャッシュを削除する
アプリを停止します。ProductService.java に org.springframework.cache.annotation.CacheEvict を import し、既存の updatePrice メソッドに次のアノテーションを追加します。
updatePrice(long id, int priceYen) の第 1 引数は商品 ID です。取得時と同じキャッシュ名とキーを指定します。更新が成功すると、該当する項目が削除されます。
アプリを起動し直したら、更新前の GET からやり直します。最初の GET で 1200 円をキャッシュに入れてから価格を更新してください。
発展として、商品 2 も更新前に GET してから商品 1 を更新し、商品 2 を再び GET します。商品 2 の READ が増えなければ、商品 2 のキャッシュは残っています。
後片付け
アプリを起動したターミナルで Ctrl+C を押して停止します。
座学で学ぶキャッシュ
キャッシュヒットとキャッシュミス
同じキャッシュ名とキーで値が見つかると、キャッシュヒットです。getProduct の本体を実行せず、保存済みの値を返します。
値が見つからないキャッシュミスでは、メソッドが保管場所から商品を読み込み、その戻り値をキャッシュに保存します。
この演習では、Controller から Spring が管理する Service を呼び出すときに、アノテーションの処理が適用されます。
同じ Service 内から自分自身のメソッドを直接呼ぶ場合、既定のプロキシ方式ではアノテーションの処理が適用されません。
更新したキーを無効化する
@CacheEvict は指定したキーの項目を削除します。この演習のようにリクエストを順番に送る場合、次の GET が保管場所から新しい値を取り直し、その値をキャッシュに保存します。
取得と更新でキーがずれていると、古い項目が残ります。この演習では、両方で商品 ID をキーにしました。
ほかの処理から同じデータを書き換える設計では、その更新経路でもキャッシュの扱いを決める必要があります。
同時実行時の制約
@Cacheable と @CacheEvict は、保管場所の読み書きとキャッシュ操作の全体を排他制御しません。
同じ商品の GET と PUT が重なると、次の順序になる場合があります。
- GET がキャッシュミスになり、保管場所から旧価格の 1200 円を読み取る。
- PUT が保管場所を 1500 円に更新し、キャッシュを削除して 204 を返す。
- 先ほどの GET が、読み取り済みの 1200 円をキャッシュへ保存する。
この後の GET は、保管場所が 1500 円でも 1200 円を返します。
この章のメモリキャッシュには TTL を設定していません。再更新による削除やアプリの再起動まで、古い値を返し続ける場合があります。
@Cacheable(sync = true) は同じキーの読み込み同士を調整する設定で、PUT との排他を保証するものではありません。
更新後の取得で必ず新しい値を返す必要がある場合は、キャッシュを使わない方法や、読み込み・更新・キャッシュ操作を含む単位で排他制御する方法を検討します。 アプリが複数ある場合は、各アプリ内のロックだけでは足りません。保存先のバージョンを使うなど、全インスタンスで整合性を保つ設計が必要です。 TTL は古い値が残る期間を制限する手段で、更新直後の整合性を保証するものではありません。
理解を確かめる
- 同じ商品への 2 回目の GET で
READが増えない理由を説明する。 - 価格更新の PUT が 204 を返したあとも、取得結果に古い価格が残った理由を説明する。
@CacheEvictを付けたあと、更新直後の GET とその次の GET で、READの有無が異なる理由を説明する。
続編の Redis キャッシュ入門 では、同じ商品価格 API を使い、Redis でキャッシュの削除と期限切れを確認します。