Spring との違い
Spring Boot には Flutter の対応物がないため、このスターターのほとんどは新しいものです。Bean を受け取るウィジェット、YAML からのテーマ、スプラッシュです。Spring Boot から取り入れたもの (設定ファイル、プロファイル、@ConfigurationProperties、ライフサイクル、DevTools の再起動) については、Spring の名前と動作を保っています。このページでは、Flutter アプリが Spring Boot のアプリケーションと異なる動作をする箇所とその理由を挙げます。
使う理由
Spring から来た場合や、Spring のサーバーとコードを共有する場合は、どの習慣が引き継がれるかを知っておく必要があります。違いのほとんどは、次の三つの事実から来ています。
- Dart は Java ではありません。 実行時のリフレクションはなく、ジェネレーターがビルド時にアプリケーションを書き出します。
- Flutter アプリはサーバーではありません。 UI のツリー、フォアグラウンドとバックグラウンド、プラットフォームとビルドモードがあり、コマンドラインはありません。
- アプリはユーザーに配布されます。 その中のすべてのものは読まれうるもので、スプラッシュの背後で素早く起動しなければなりません。
例
両方で同じ設定です。ファイルは同じで、違いは誰が何を読むかにあります。
# Spring Boot: src/main/resources/application.yml
# Flutter: lib/resources/application.yml
spring:
profiles:
active: dev
shop:
api-url: https://api.neon.books
アプリケーションの起動
| Spring Boot | ここ |
|---|---|
main での SpringApplication.run(App.class, args) |
runApp(SpringApplicationWidget(application: () => springApplication))。コンテキストはスプラッシュの背後で非同期に起動する |
クラスに @SpringBootApplication |
main 関数に @SpringBootApplication()。ジェネレーターが springApplication を書き出す |
| 起動時にクラスパスがスキャンされる | ジェネレーターがビルド時に lib/ をスキャンする。アノテーションを変更したら build_runner を実行する |
| 失敗した起動はレポートを出力して終了する | レポートはログに出て、失敗画面が表示される。それを修正したホットリロードで再び起動する |
設定
- ファイルは
lib/resources/にあり、生成コードに埋め込まれます。flutter: assets:のエントリーは不要で、すべてのプラットフォームで同じで、ファイルあたり最大 1 MB です。 - プラットフォームとビルドのプロファイルは常にアクティブです:
androidとmobile、ios、web、macosとdesktopなど、そしてdebug、profile、release。Spring Boot にはそうしたプロファイルはありません。 - デフォルトでは環境変数はありません。 スマートフォンの環境はノイズです。代わりに
--dart-defineの値が、同じ緩い名前 (SHOP_API_URL) で使われます。デスクトップのビルドは--dart-define=spring.flutter.scan-os-environment=trueで環境を有効にします。 - 見えるのは既知の define だけです。
String.fromEnvironmentは定数の名前を必要とするため、コンパイルされたアプリが読めるのは、ジェネレーターが見つけた--dart-defineの名前 (プレースホルダー、@ConfigurationPropertiesのフィールド、ファイルのキー) だけです。 - アプリにシークレットを置いてはいけません。 ファイル、define、アセットはすべて APK、IPA、
main.dart.jsに入ります。 - リモートの設定ファイル (
spring.config.import: https://...) は、起動が非同期なので動きます。Spring Boot は代わりに Spring Cloud Config を通じてそうしたファイルを読みます。 - 二つのキーのリストは一つの値です。
spring.flutter.app.localesとspring.messages.basenameは、YAML でも一つのカンマ区切りの値でなければなりません。YAML のリストはスターターには見えません。
Bean とウィジェット
- ウィジェットは Bean ではありません。 Flutter が作るため、何も注入されません。ウィジェットはその型で Bean を指定する (
SpringStatelessWidget<(Basket,)>) か、それを検索します (context.bean<T>())。Java の Bean が UI のツリーから検索されることはありません。 - ウィジェットの Bean が存在しないと起動が失敗します。 ジェネレーターがすべてのウィジェットの Bean を見るため、Spring でコンストラクターの依存関係が存在しない場合と同じです。
- 状態の Bean は自分で通知します。
@ChangeNotifierComponentと@NotifyListenersは、@Transactionalのような、メソッドの周りのアドバイスです。Spring には対応するものがありません。
ライフサイクル
- コンテキストはバックグラウンドで一時停止します。
@Scheduledのタスクと WebSocket の接続が止まり、フォアグラウンドで再び始まります。これは、サーバーにはないアプリのライフサイクルで駆動される、Spring Framework 7 のpause()とrestart()です。 spring.main.register-shutdown-hookはアプリでは意味を持ちません。コンテキストはSpringApplicationWidgetが取り除かれると閉じます。
ホットリロード
- DevTools の再起動は組み込まれており、デフォルトで有効です。Bean やファイルを変更したホットリロードは、Spring Boot DevTools がクラスパスの変更で再起動するように、コンテキストを再起動します。
spring.devtools.restart.enabled=falseで、DevTools 自身のキーで無効にします。ランナーは、rerunRunnersOnReload: trueでない限り再び実行されません。 - 再起動するのはコンテキストだけで、アプリのプロセスではありません。
デザインライブラリ
- スターターはデザインライブラリを持ちません。 Spring Boot には、デザインする UI がありません。Material と Cupertino は、それぞれのスターター
spring_boot_starter_flutter_materialとspring_boot_starter_flutter_cupertinoで入ります。Spring Boot のアプリが、列挙したスターターから Tomcat や Jetty を得るのと同じです (デザインライブラリ を参照)。 - アプリの種類は、
SpringAppFactoryBean を名指すテキストです。spring.flutter.app.type: materialは Material のスターターのアプリファクトリーの種類です。どの Bean も持たない種類は、追加すべきスターターを示して起動を失敗させます。 - 設定されていなければアプリの種類は推定されますが、候補が二つあるとエラーです。 Spring Boot がクラスパスから
spring.main.web-application-typeを推定するのと同じように、スターターが決めます。デザインのスターターが一つ (または独自の種類のSpringAppFactoryBean が一つ) あればアプリはその種類になり、なければwidgetsです。Spring Boot は Spring MVC と WebFlux の両方がクラスパスにあると、固定の優先順位で servlet を選びます。ここでは複数の種類のアプリファクトリーがあると、プロパティと種類を示して起動が失敗します。二つのデザインのスターターを持つアプリは、たいていあるプラットフォームでは Material、別のプラットフォームでは Cupertino です。そのため選択は設定に、プロファイル (application-ios.properties) でプラットフォームごとに置くべきもので、すべてのプラットフォームを黙って一方にしてしまう優先順位に任せるものではありません。設定されていれば、Spring Boot と同じくプロパティが常に優先されます。 - デザインは
AutoConfigurationModule.factoriesを通じて加わります。 そのThemeDesignは Bean ではなく、スターターのモジュールに列挙された定数です。テーマは、どの Bean も存在する前にスプラッシュのために読まれるためです。Spring Boot のMETA-INF/spring.factoriesをSpringFactoriesLoaderが読むのに当たります。Dart にはスキャンするクラスパスがないため、ジェネレーターがその定数をspringApplicationにコピーします。 - デザインのプロパティは、そのスターターがなくてもチェックされずに受け入れられます。 テーマのキーはすべてチェックされますが、
components、visual-density、tap-target-size、単一の値のsplash、cupertinoは、それを読むスターターのないアプリでも受け入れられます。表示されず、チェックされず、ログで一度だけ名前を挙げられます。テーマのライブラリは、それぞれのデザインのアプリのための値を持つからです。 - ページのトランジションはデフォルトで Flutter のものです。 Spring Boot にはアニメーションする画面がないため、デフォルトは Flutter に従います。
motion.page-transitionが設定されていなければplatform、つまりアプリの種類固有のもの (MaterialAppではプラットフォームごとの Material のもの、CupertinoAppでは iOS のスライド、デザインライブラリのないアプリではなし) です。0.8 より前は、どのアプリの種類でもなしでした。テーマごと、プロファイルごとに設定できるテーマの一つの値が、Flutter のプラットフォームごとのビルダーの代わりになります (トランジション を参照)。
エクスポート
- Boot の起動時の
Bannerはエクスポートされません。Flutter にBannerウィジェットがあるためです。 - バリデーションの制約
@SizeはSizeConstraintとしてエクスポートされます。dart:uiにSizeがあるためです。
既知の制限
ThemeConfigはエクスポートされていません。SpringThemes.configはそれを返し、SpringThemeData.ofはそれを受け取りますが、アプリはその型を名指しできません。その値は読めます (themes.config.active)。テーマを表示するには、SpringThemes.data(name)とThemeSelectionを使ってください。- 同じ Bean のレコードを持つウィジェットは、一つのバインディングを共有します。 Bean が存在しない場合、起動はそのレコードを使うウィジェットのそれぞれではなく、そのうちの一つを示して失敗します。
SpringApplicationWidgetはテストのための Bean のオーバーライドを受け取りません。 Bean を置き換えてアプリ全体を起動するテストは、springApplicationのコピーに自分でオーバーライドを加えます。- Web にはまだ SQLite のディレクトリがありません。 そこでは何も設定されません。
- デスクトップのウィンドウには位置のプロパティがなく、ユーザーが残したサイズと位置を復元しません。