リポジトリ

リポジトリは、スターターのリポジトリのインターフェースのどれかを継承する abstract interface class です。ジェネレーターがその実装を書き、アノテーションなしに Bean として登録します。他の Bean と同じく、その型で注入します。

使う理由

findById、save、deleteById の背後にあるコードは、どの集約でも同じです。Spring Data はそれを一度だけ書き、利用者は自分の集約に特有のもの、つまりファインダーだけを宣言します。ビルドがクラスを書くため、誤ったメソッド名はビルドエラーになり、実行時にリフレクションで見つけるものは何もありません。

例

abstract interface class BookRepository
    implements
        ListCrudRepository<Book, int>,
        ListPagingAndSortingRepository<Book, int> {
  Future<List<Book>> findByTitle(String title);
}

@Service()
class Shelf {
  Shelf(this.books);

  final BookRepository books;

  Future<Book> rename(int id, String title) async {
    final book = await books.findById(id) ??
        (throw StateError('No book $id'));
    book.title = title;
    return books.save(book); // 更新: ID が設定され、バージョンが 0 でない
  }
}

インターフェース

インターフェース 提供するもの
DataRepository<T, ID> 何も: 宣言したメソッド (派生クエリ、@Query) だけ。Spring の Repository。
CrudRepository<T, ID> save、saveAll、findById、existsById、findAll、findAllById、count、deleteById、delete、deleteAllById、deleteAllOf、deleteAll。コレクションは Iterable として。
ListCrudRepository<T, ID> 同じものを List の結果で。
PagingAndSortingRepository<T, ID> findAllSorted(Sort) と findAllPaged(Pageable)。
ListPagingAndSortingRepository<T, ID> 同じもの。findAllSorted は List を返す。

T は @Table クラス、ID はその @Id の型です。ジェネリックなインターフェース (BaseRepository<T>) は他のものの基底で、Spring の @NoRepositoryBean と同じく、決して Bean になりません。

CRUD のメソッド

メソッド 働き
Future<T> save(T entity) 新規のエンティティを挿入し、既存のものを更新し、ストアが与えた ID と上がったバージョンを持つ保存済みのものを返す。@Version があれば、更新は読み込んだバージョンで照合し、その間に別の保存が割り込んでいれば OptimisticLockingFailureException を投げる。
saveAll(Iterable<T>) それぞれを順に保存し、保存済みのものを返す。
Future<T?> findById(ID id) 子を伴う集約、または null。
Future<bool> existsById(ID id) 存在するかどうか。
findAll() すべての集約。
findAllById(Iterable<ID>) ID が列挙された集約。存在しない ID はスキップされる。
Future<int> count() 集約の数。
deleteById(ID id) 子とともに削除する。なければ何もしない。バージョンはチェックされない。
delete(T entity) 子とともに削除する。save と同じく @Version をチェックする。
deleteAllById(Iterable<ID>) 列挙した ID を削除する。
deleteAllOf(Iterable<T>) 各エンティティを delete と同じく削除する。Spring の deleteAll(Iterable): Dart にはオーバーロードがない。
deleteAll() すべての集約を削除する。

save が挿入と更新をどう決めるかは エンティティ にあります。@Version なしで、行がなくなったエンティティを更新すると IncorrectUpdateSemanticsDataAccessException を投げます。

欲しいメソッドだけ

CRUD 一式が多すぎるとき、たとえば読み取り専用のビューには、DataRepository を継承します。

abstract interface class BookSearch implements DataRepository<Book, int> {
  Future<List<Book>> findByTitleContainingIgnoreCase(String text);
  Future<int> countByYear(int year);
}

Bean

ストアとデータベース

アノテーション 意味
なし spring.data.store が設定されていればそのストア。なければ、spring.datasource.url が設定されていればプライマリーのデータソース上の jdbc ストア、そうでなければ memory ストア。
@UseStore('memory') このリポジトリのデータをメモリに保持する (テスト、プロトタイプ、キャッシュ)。
@UseStore('jdbc') SQL データベース (SQLite、PostgreSQL)。
@UseDataSource('stats') spring.datasources.stats.* のデータベース (データソース を参照)。
@UseDataSource('stats')
abstract interface class VisitRepository implements ListCrudRepository<Visit, int> {}

メモリ上のストアは、トランザクション、行ロック (デッドロック検出付きの read committed)、外部キー、一意キーを持ちます。行ロックの待機時間は spring.data.memory.lock-timeout (デフォルトは 10 秒) です。

ビルドがチェックするもの

インターフェースの問題はそれぞれ一つのビルドエラーになり、他のものと一緒に列挙されます。

Spring (Java) との対応

interface BookRepository extends ListCrudRepository<Book, Long> {
  List<Book> findByTitle(String title);
}

インターフェースは同じ名前ですが、DataRepository だけは違います (Spring の Repository。ここでは @Repository はステレオタイプのアノテーションです)。すべてのメソッドは Future か Stream を返します。findById は Optional ではなく nullable な値を返します。deleteAll(Iterable) は deleteAllOf、findAll(Sort) は findAllSorted、findAll(Pageable) は findAllPaged です。

関連項目