ビルド速度
ジェネレーターは、build_runner build の下で、また build_runner watch の下では保存のたびに、lib/、bin/、test/、example/ のすべての .dart ファイルに対して動きます。アナライザーで Dart のコードを解決するのがビルドの高価な部分なので、ジェネレーターはできるだけ少なく解決し、追加の作業は得るものがある場合にだけ行うように書かれています。
このページでは、コードが実際に行っていることを列挙します。
使う理由
build_runner watch は編集ループの一部です。遅いビルダーはすべての保存を遅くします。ジェネレーターは、アプリケーションのためにパッケージ全体を、自動構成とプロキシのために依存関係を見なければならないので、遅くなりやすいのです。以下の各項目は、結果に必要のない作業を避けます。
ほとんどのファイルは、軽く、何も生み出さない
メインのビルダーは、ライブラリごとに一つの可能な出力を宣言します (lib/a.dart は lib/spring_gen/a.spring.dart を生み出しうる)。各入力について、まずファイルのテキストを読み、二つの語をチェックします。
- テキストに
ComponentScanもSpringBootApplicationも含まない入力は、解決されずに スキップされます。それはパッケージのほとんどすべてのファイルです。 - 生成ファイル (
.spring.dart) が入力になることはありません。
解決されるのは、@ComponentScan 変数や @SpringBootApplication の main を宣言しうるファイルだけです。
入れ子のスキャンはまずテキストで見つける
@ComponentScan や @SpringBootApplication のビルドは、入れ子の @ComponentScan ルートを見つけるために、そのディレクトリの下のすべてのファイルを見ます。テキストに ComponentScan を含まないファイルは、この検索のために解決されることはありません。
重要な宣言だけを解決する
スキャンされるすべてのライブラリは、その要素 (クラス、メンバー、アノテーション) まで解決されます。コードの 本体 の解決はより高価で、ジェネレーターは本体が何かを伝える場所でだけそれを行います。
| 何のためか | どの本体が解決されるか |
|---|---|
@Bean メソッドが実際に返す型 (DataSource dataSource() => HikariDataSource(url) は HikariDataSource を登録する) |
ライブラリのクラスと、それが @Import するクラスの @Bean メソッドだけ |
フィールドの初期値 (IntrospectedProperty.initialValue) |
@Introspected と @Table のクラス、データリポジトリの DTO、@ConfigurationProperties の @Bean メソッドが返すクラスのフィールドだけ |
ObjectMapper の呼び出し (実行されるものだけ を参照) |
テキストが readValue、treeToValue、convertValue、readList、readMap、writeValueAsString、valueToTree のいずれかに触れるライブラリ (または part ファイル) だけ。sendJson と broadcast は WebSocket スターターをインポートするライブラリでだけ |
マッパーのメソッドに触れないライブラリは、マッパーの呼び出しのためにまったく解決されません。
スターターのライブラリはまずテキストで読む
アプリケーションのビルドは二つのことのために依存関係の中を見て、解決する前にテキストチェックを使います。
- プロキシの刈り込みのための、自動構成のアドバイス。 各自動構成ライブラリと、それがインポートする同じパッケージのライブラリについて、ビルドはテキストを読みます。そこに
AspectMetadataがあれば、ビルドが読めないアスペクトがあることを意味します (その場合、刈り込みは無効になり、検索は早めに止まります)。アドバイザーのポイントカットを読むために宣言が解決されるのは、テキストがAdvisorに触れるライブラリだけです。 - 遅延されるプロキシ。 自動構成とアプリケーションが到達する生成されたモジュールのうち、ゲッターが解決されるのは、テキストに
AopProxyFactory.deferredを含む.spring.dartファイルだけです。
検索されるのは、アプリケーションが実際に依存するパッケージだけです (自動構成 を参照)。pub ワークスペースでは兄弟パッケージはスキップされます。
ビルド条件は使われるまでコストがない
ビルドから外されるモジュール について:
- 設定ファイルは、
build:を持つ最初のモジュールが判定されるときにだけ環境に解析され、ビルドの他のモジュールでは再利用されます。スターターがbuild:を使わないアプリケーションは、このためにそれらを解析することはありません。 - プロファイルのファイルは、プロパティが設定されていない場合にだけ検索されます。
- モジュールの宣言は、モジュールが
neverまたはnotInReleaseと判定された場合にだけ、遅延されるプロキシのためにたどられます。常に含まれるモジュールは、取り除かれたモジュールがそのような Bean を定義する場合にだけたどられます。各宣言は一度だけたどられます。
テストのビルダーはテストを構文として読む
spring_test ビルダーは、テキストに SpringBootTest も DataTest も含まないテストファイルをスキップします。その他のファイルは、アナライザーの解決なしに構文として読みます (parseString)。テストファイルを解決するのは、構文だけでは情報が足りない場合だけです。値がコンストラクター呼び出しである (クラスを知るため)、または型が nullable な型エイリアスかもしれない @TestBean フィールドです。
他のビルダーはプロパティがなければ何もしない
Flutter のビルダーは、純粋な Dart サーバーを含め、ジェネレーターに依存するすべてのパッケージで動きます。たとえば web_dev_config.yaml のビルダーは、設定ファイルが spring.flutter.web.dev-server.* キーか spring.flutter.security.web.mode を設定していない限り、設定の読み込みすら行いません。ビルダー を参照してください。
安定した出力
ソースが同じなら、生成コードはビルドごとに同じです。
- ファイル、ライブラリ、自動構成モジュールは決まった順序 (パス順、パッケージと名前の順) で処理されます。
- アプリケーションの
fingerprint(デバッグ用 part のmain.spring.debug.dartにあります) は生成コードの FNV-1a ハッシュで、実行ごと、プラットフォームごとに安定しています。 - アクチュエーターを使うアプリケーション向けに書き出される
build-info.propertiesにはビルド時刻がありません。
エラーのためのビルドの実行を減らす
- すべての問題を一度に。 スキャナーは不正な宣言の後も続行し、ビルドのすべての独立した問題をまとめて報告する (
N problems in this build:) ので、エラーごとに一回ビルドするのではなく、一度にまとめて修正できます。ビルド時のチェック を参照してください。 - 入力中のちらつきなし。 スキャンされるライブラリに構文エラーがある間、既存の生成ファイルは変更されずに再び書き出されるので、それをインポートするファイルが赤くなることはなく、
watchがキーを押すたびに再生成することもありません。エラーと生成ファイル を参照してください。 - 最後の正常な出力はメモリーに保たれる。
watchの下では、ビルダーは出力ごとに最後に生成した内容を保持し、ソースが壊れたときはディスクを読まずにそれを使います。