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

アノテーションが追跡できないメンバーに付いていると、ジェネレーターは、メンバーと変えるべき点を示してビルドを失敗させます。

使う理由

Bean のプロキシは、Bean のクラスを継承してそのメンバーをオーバーライドする、生成されたクラスです。オーバーライドできないメンバーは、黙って誰にも伝えないフィールドになります。そのため、この間違いは古いままの画面ではなく、ビルドエラーになります。

例

@Component()
class Basket {
  @Signal()
  final List<Book> items = [];   // ビルドが失敗する: final のフィールド

  @Signal()
  String? _coupon;               // ビルドが失敗する: private のフィールド
}

ビルドを失敗させるもの

アノテーション 失敗する対象
@Signal private、static、final のフィールド。ゲッターやメソッド
@Computed フィールド。private や static のメンバー。パラメーターのあるメソッド、値を返さないメソッド
@Effect private や static のメソッド。パラメーターのあるメソッド、値を返すメソッド
どれでも 抽象メンバー。追跡されるメンバーを、アノテーションを繰り返さずにオーバーライドするメンバー。プロキシがオーバーライドできないメンバー (演算子、private な型のフィールド)
どれでも このようなメンバーを持ち、生成されたクラスが継承できないクラス: final、sealed、ジェネリック、ファクトリーコンストラクター

メンバーが public でなければならないのは、プロキシが別のライブラリに生成されるからです。

アノテーションを付けられない場所

アノテーションは、コンポーネントのクラス (@Component、@Service、本体のある @Repository クラス) と、その基底クラス、そのミックスインのメンバーで働きます。それ以外の場所では何も追跡されないため、そこでもビルドは失敗します。

場所 代わりにすること
Bean ではないクラス: ウィジェット、State、データクラス コンポーネントにするか、状態をコンポーネントに置く
@Configuration クラスや @ConfigurationProperties クラス 状態をコンポーネント (プロパティを読むコンポーネント) に置く
@Bean メソッドが返すクラス そのクラスをコンポーネントとして宣言する
リポジトリ (DataRepository) や HTTP クライアント (@FeignClient): そのメソッドはジェネレーターが書く コンポーネントの @Computed ゲッターの中でそのメソッドを呼ぶ
コンテナーがプロキシしない Bean: @Aspect、ポストプロセッサー メンバーを専用のコンポーネントに移す
enum、拡張、トップレベルの変数や関数 コンポーネントに移す
abstract interface class BookRepository implements DataRepository<Book, int> {
  @Computed()                                   // ビルドが失敗する
  Future<List<Book>> findByGenre(String genre);
}

@Service()
class Catalog {
  Catalog(this.repository);
  final BookRepository repository;

  @Signal()
  String genre = 'fiction';

  @Computed()                                   // ここに付ける
  Future<List<Book>> get books => repository.findByGenre(genre);
}

抽象クラスとミックスインは、それを継承するコンポーネントのために、追跡されるメンバーを宣言できます。追跡されるメンバーをオーバーライドするメンバーは、そのアノテーションを繰り返します。

チェックされないもの

ビルドがチェックしないもの: 非同期の @Computed ゲッターの中で、await の後に読んだフィールド。コンパイルされ、そのフィールドが変わっても値は読み込み直されません。値が依存するものは、最初の await の前に読んでください (非同期の状態 を参照)。

起動時

このようなメンバーを持つ Bean は、コンテナーが作り、プロキシされなければなりません。アドバイスが適用されていない Bean は、その名前を示すメッセージで起動を止めます。アプリケーションはジェネレーターがプロキシ付き (aop_proxies: all、既定値) でビルドし、Bean はコンテナーが作る必要があります。

関連項目