ビルダー

spring_core_dart_generator は build.yaml に九つのビルダーを登録します。そのうち八つは、ジェネレーターに依存するすべてのパッケージに自動で適用されます。spring_properties はパッケージが有効にするまで無効です。各ビルダーはまずパッケージがそれを必要とするかを確認し、必要なければ何も書き出しません。そのため、純粋な Dart サーバーに Flutter のファイルができることはなく、テーマのない Flutter アプリにテーマキーができることもありません。

ビルダーが複数ある理由

build_runner のビルダーは、入力と出力をあらかじめ宣言します。ジェネレーターの出力にはさまざまな形があります。

形ごとにそれぞれのビルダーがあります。分けておくことで、パッケージは使わないものを無効にすることもできます。

概要

ビルダー 入力 書き出すもの 動く条件
spring_core_dart lib/、bin/、test/、example/ のすべての .dart ファイル <root>/spring_gen/<path>.spring.dart ファイルに @ComponentScan または @SpringBootApplication がある
spring_properties lib/ のすべての .dart ファイル lib/spring_gen/<path>.spring.dart パッケージが有効にする (デフォルトでは無効)
spring_test test/**_test.dart test/spring_gen/<name>.test.spring.dart ファイルに @SpringBootTest または @DataTest クラスがある
spring_prefetch パッケージ lib/resources/spring_gen/prefetch/resources.json spring.resources.prefetch.locations が設定されている
spring_search_index パッケージ lib/resources/spring_gen/search/<language>.json spring.search.markdown が設定されている
spring_json_schemas パッケージ lib/spring_gen/json_schemas.spring.classes.dart spring.json.schemas が設定されている
spring_metadata パッケージ lib/spring_gen/spring_metadata.json lib/ または bin/ に Spring のコードがある
spring_flutter_keys パッケージ lib/spring_gen/theme.spring.keys.dart、lib/spring_gen/messages.spring.keys.dart パッケージが spring_boot_starter_flutter に依存し、テーマのプロパティまたはメッセージファイルがある
spring_flutter_web パッケージ web_dev_config.yaml (宣言なし) spring.flutter.web.dev-server.* または spring.flutter.security.web.mode が設定されている
spring_flutter_page_loader パッケージ web/index.html のブロック (宣言なし) パッケージが spring_boot_starter_flutter に依存し、web/index.html がある
spring_flutter_seo パッケージ web/ のページ、sitemap.xml、robots.txt、llms.txt (宣言なし) spring.flutter.web.seo.enabled が true で、web/index.html が存在する
spring_flutter_deep_links パッケージ Info.plist、Runner.entitlements、AndroidManifest.xml のブロック、ドメインのファイル (宣言なし) spring.flutter.navigation.deep-links.* が設定されている

build.yaml では、ビルダーはパッケージ名を先頭に付けて spring_core_dart_generator:spring_core_dart のように書きます。

spring_core_dart

メインのビルダーです。Bean のモジュールとアプリケーションを書き出します。

オプション 値 デフォルト ページ
aop_proxies all、interfaces、none all AOP プロキシ
aop_prune true、false true AOP プロキシ
aop_defer true、false false AOP プロキシ
dart_defines_exclude プロパティ名のプレフィックスのリスト [] --dart-define キー

間違った値 (未知の aop_proxies モード、真偽値でない値、dart_defines_exclude のワイルドカード) は ArgumentError でビルドを失敗させます。すべてのオプションは オプション にあります。

# 自分のパッケージの build.yaml
targets:
  $default:
    builders:
      spring_core_dart_generator:spring_core_dart:
        options:
          aop_proxies: interfaces
          dart_defines_exclude: [spring.flutter.theme]

spring_properties

これもメインのビルダーですが、lib/ に限定され、spring_core_dart より前の独自のフェーズに置かれます (runs_before)。

# spring_boot_starter_flutter_security の build.yaml
targets:
  $default:
    builders:
      spring_core_dart_generator:spring_core_dart:
        generate_for: [example/**]
      spring_core_dart_generator:spring_properties:
        enabled: true
        generate_for: [lib/src/properties/**]
      spring_core_dart_generator:spring_test:
        enabled: false

アプリケーションには不要です。

spring_test

テストのビルダーです。テスト を参照してください。

spring_json_schemas

spring.json.schemas の JSON Schema のクラスを書き出します。JSON Schema のクラス を参照してください。

spring_prefetch

spring.resources.prefetch.locations のファイルを、Flutter の Web アプリが一度だけダウンロードする 1 つのファイルに書き出します。まとめてダウンロードする を参照してください。

spring_search_index

spring.search.markdown の検索インデックスを書き出し、アプリはそれを作る代わりに読みます。ビルドが書くインデックス を参照してください。

spring_metadata

エディターやツールが読むメタデータを書き出します。エディター向けのメタデータ を参照してください。

spring_flutter_keys

Flutter アプリの設定の型付きキー context.theme と context.messages を書き出します。型付きキー を参照してください。

spring_flutter_web

flutter run が Web 向けに読むファイル web_dev_config.yaml を書き出します (Flutter 3.38 以降)。Web 開発サーバー を参照してください。

spring_flutter_page_loader

アクティブなテーマの splash のページローダーを web/index.html に書き込み、Flutter が起動する前にブラウザーがアプリの見た目を表示できるようにします。ページローダー を参照してください。

spring_flutter_seo

Flutter Web アプリはキャンバスに描画し、その HTML にはテキストがないため、検索エンジン、リンクプレビュー、言語モデルが読むページを書き出します。検索エンジン向けのページ を参照してください。

アプリのディープリンクをプラットフォームのファイルに書き込み、ドメインが配信するファイルも書き出します。ディープリンク を参照してください。

ビルダーを無効にする

パッケージの build.yaml (pubspec.yaml の隣) で、build_runner の enabled 設定を使います。

# build.yaml
targets:
  $default:
    builders:
      spring_core_dart_generator:spring_flutter_seo:
        enabled: false
      spring_core_dart_generator:spring_test:
        enabled: false

ビルダーを残したまま、見るファイルを制限するには generate_for を使います。

targets:
  $default:
    builders:
      spring_core_dart_generator:spring_core_dart:
        generate_for: [example/**]

有効のままにすべきもの

ビルダー 無効にできるか
spring_core_dart アプリケーションや @ComponentScan モジュールを持つパッケージではできません。コードがそれが書き出すファイルをインポートするからです。手書きのパッケージ (スターター) は無効にするか、サンプルに限定できます。
spring_flutter_keys テーマのプロパティやメッセージファイルを持つ Flutter アプリでは、spring_core_dart が動いている間はできません。メインのビルダーは、theme.spring.keys.dart と messages.spring.keys.dart の part 行を、ファイルが存在するかを確認せずに書きます (別のフェーズで書き出されるので確認できません)。そのため、キーのビルダーがないと、生成されたライブラリは存在しない part を指し、コンパイルできません。
spring_metadata できます。ただし、spring_flutter_seo はそのファイルからルートを取り、アプリのキーのビルダーはそこでライブラリのローダーの種類を見つけ、エディターは補完を失います。ローダーの種類やルートを宣言するライブラリでは有効のままにしてください。
spring_search_index できます。その場合、アプリは spring.search.prebuilt: false のときと同じく検索インデックスを自分で作ります。
spring_json_schemas できます。ただしその場合、spring.json.schemas はクラスを書き出さず、メインのビルダーもモジュールにそのイントロスペクションを渡しません。
spring_test @SpringBootTest や @DataTest を使うテストがなければできます。
spring_flutter_web、spring_flutter_page_loader、spring_flutter_seo、spring_flutter_deep_links できます。アプリが所有するファイルにだけ書き込みます。無効にしたものは、以前に書き出したものを更新も削除もしなくなります。
spring_properties デフォルトで無効です。

Spring (Java) との対応

Spring Boot には、同様の役割を果たすビルド時のツールが二つあります。META-INF/spring-configuration-metadata.json を書き出すアノテーションプロセッサー spring-boot-configuration-processor (spring_metadata に相当) と、Bean 定義の Java ソースを書き出す Maven と Gradle のプラグインの Spring AOT エンジン (spring_core_dart に相当) です。Flutter のビルダーに相当するものは Spring にはありません。

関連項目