spring_boot_starter_cache

spring_boot_starter_cache は Spring for Dart のアプリケーションにキャッシュを追加します。Spring Boot の spring-boot-starter-cache に当たる Dart のものです。Bean のメソッドに @Cacheable を付けると、同じ引数での繰り返しの呼び出しは、メソッドを再び実行する代わりに保存された結果を返します。サーバーでも Flutter アプリでも同じように動きます。

使う理由

メソッドによっては、遅く、コストが高く、同じ引数には同じ答えを返します。ネットワーク呼び出し、データベースのクエリ、重い計算などです。その結果を手で保持すると、メソッドごとのマップ、キー、無効化、有効期限が業務のコードに混ざります。このスターターを使えば、メソッドにアノテーションを付けるだけで、キャッシュがその前に置かれます。結果はデフォルトでメモリに保持され、任意で有効期間とサイズの上限を持ちます。spring.cache.type: disk ならディスクに保持され、再起動後も残ります。同じアノテーションの背後に独自のストレージを置くこともできます。

セットアップ

# pubspec.yaml
dependencies:
  spring_boot_starter_cache: ^0.9.0

dev_dependencies:
  build_runner: ^2.17.0
  spring_core_dart_generator: ^0.9.0   # 必須: キャッシュが動くプロキシを生成する

インポートは一つで足ります。package:spring_boot_starter_cache/spring_boot_starter_cache.dart は spring_boot_dart と spring_boot_starter_logging を再エクスポートします。

例

import 'package:spring_boot_starter_cache/spring_boot_starter_cache.dart';

import 'spring_gen/main.spring.dart';

@Service()
class Books {
  Books(this.api);

  final CatalogApi api;

  // 遅い: API は isbn ごとに一度だけ呼ばれ、以降の呼び出しはキャッシュを読む。
  @Cacheable('books')
  Future<Book> find(String isbn) => api.load(isbn);

  // 同時に同じ価格を尋ねる呼び出し元は、一つのリクエストを共有する。
  @Cacheable('prices', sync: true)
  Future<double> price(String isbn) => api.price(isbn);

  // 本がなくなった: そのキャッシュのエントリーもなくなる。
  @CacheEvict('books', key: '#isbn')
  Future<void> delete(String isbn) => api.delete(isbn);
}

@SpringBootApplication()
void main(List<String> args) => runApplication(args);
# lib/resources/application.properties
spring.cache.simple.time-to-live=10m
spring.cache.simple.max-size=1000
spring.cache.simple.caches.prices.time-to-live=30s

起動するもの

プロキシを通した呼び出しだけ

ジェネレーターは各 Bean のために AOP プロキシを書き (ジェネレーターのオプション aop_proxies、デフォルトは all)、スターターはキャッシュのアノテーションを持つすべてのメソッドを包むアドバイザーを登録します。そのため、Spring と同じく:

@Service()
class Books implements BookService {
  Books(@Lazy() this._self); // この同じ Bean のプロキシ

  final BookService _self;

  @Cacheable('books')
  @override
  Book find(String isbn) => load(isbn);

  List<Book> findAll(List<String> isbns) =>
      [for (final isbn in isbns) _self.find(isbn)]; // キャッシュされる。find(isbn) ならされない
}

内容

Spring (Java) との対応

@EnableCaching
@SpringBootApplication
class ShopApplication {}

@Service
class Books {
  @Cacheable("books")
  public Book find(String isbn) { ... }
}

重要な違い:

関連項目