0.8 への移行

リリース 0.8 は Flutter のスターターを Flutter 3.50 に移します。Flutter 3.50 は Material と Cupertino を SDK の外に出しました。Flutter のスターターもそれに従い、デザインライブラリを持ちません。Material と Cupertino は二つの新しいスターターで加わります (デザインライブラリ を参照)。material か cupertino のアプリは、そのスターターを加えて再ビルドします。見た目は変わりませんが、ページの切り替えは Flutter と同じくアニメーションするようになります (手順 9)。以下の手順は Flutter アプリのためのものです。純粋な Dart のパッケージによるサーバーは Dart 3.13 のままで、このために変えるものはありません。

1. Flutter 3.50

Flutter のパッケージ (spring_boot_starter_flutter、_navigation、_security、_material、_cupertino) には、Flutter 3.50 以降と Dart 3.14 が必要です。

# pubspec.yaml
environment:
  sdk: ^3.14.0
  flutter: '>=3.50.0'
flutter upgrade

2. デザインのスターター

spring.flutter.app.type: material のアプリは Material のスターターと material_ui を、cupertino のアプリは Cupertino のスターターと cupertino_ui を加えます。デザインのスターターは Flutter のスターターを持ち込むので、依存関係の中でそれを置き換えられます。

# Material のアプリの pubspec.yaml
dependencies:
  flutter:
    sdk: flutter
  material_ui: ^1.11.0
  spring_boot_starter_flutter_material: ^0.9.0
# Cupertino のアプリの pubspec.yaml
dependencies:
  flutter:
    sdk: flutter
  cupertino_ui: ^1.1.6
  spring_boot_starter_flutter_cupertino: ^0.9.0

セキュリティのスターターを使うアプリは、それを残したまま、隣にデザインのスターターを加えます。widgets のアプリは何も加えません。スターターがなければ、material や cupertino は起動を失敗させ、パッケージの名前を挙げます。

デザインのスターターを一つだけ使うアプリは、spring.flutter.app.type を省けるようになりました。Spring Boot がクラスパスから Web アプリケーションの種類を推定するのと同じように、スターターが決め、その行がなくてもアプリは material か cupertino の種類になります。その行を残したアプリは変わりません。二つのデザインのスターターを列挙するアプリ (Android では Material、iOS では Cupertino) は種類を残します。すべてのプラットフォーム向けに、そして異なるプラットフォームごとのプロファイルで設定します。それがなければ、起動はプロパティと種類を示して失敗します。種類を設定しないとき を参照してください。

3. インポート

package:flutter/material.dart と package:flutter/cupertino.dart は Flutter 3.50 で非推奨です。dart fix に、その修正だけで package:material_ui/material_ui.dart と package:cupertino_ui/cupertino_ui.dart へ書き換えさせます。

dart fix --apply --code=deprecated_member_use

何も指定しない dart fix --apply は実行しないでください。 それは missing_dependency も適用し、インポートされているパッケージを制約 any で pubspec.yaml に加えてしまいます。material_ui や cupertino_ui は、手順 2 のように、バージョン付きで手で加えます。

Material の型のためだけにスターターをインポートしていた所では、デザインのスターターをインポートします。ThemeCustomizer、MaterialThemes、SpringThemeExtension は package:spring_boot_starter_flutter_material/spring_boot_starter_flutter_material.dart に、CupertinoThemeCustomizer と CupertinoThemes は package:spring_boot_starter_flutter_cupertino/spring_boot_starter_flutter_cupertino.dart にあります。デザインのスターターのインポートは、Flutter のスターターもエクスポートします。

4. アプリの種類はテキスト

列挙型 AppType はなくなりました。設定ファイルの spring.flutter.app.type は変わりません (デザインのスターターが一つなら省けます。手順 2 を参照)。コードでは、FlutterAppSettings.type は String です。

// 0.7
if (app.type == AppType.material) { ... }

// 0.8
if (app.type == 'material') { ... }

5. SpringThemes.material の代わりの MaterialThemes

SpringThemes.material(name) と SpringThemes.cupertino(name) はなくなりました。Material と Cupertino としてのテーマは、デザインのスターターの Bean です。

// 0.7
final theme = springThemes.material('ocean');

// 0.8: MaterialThemes を注入する (ウィジェットでは SpringStatelessWidget<(MaterialThemes,)>)
final theme = materialThemes.theme('ocean');

// または、アプリケーションコンテキストが手元にあれば
final theme = MaterialThemes.of(applicationContext).theme('ocean');

Cupertino も同じで、cupertinoThemes.theme('ocean') です。カスタマイザーと置き換えの Bean (theme と darkTheme という名前の ThemeData の Bean、CupertinoThemeData の Bean) は、デザインのスターターから、これまでどおり働きます。

6. パレットのクラス

SpringThemeData.colorScheme は、Material の ColorScheme ではなく、Flutter のスターター自身のパレットのクラス SpringColorScheme です。同じ名前で同じ 46 のロールを持つので、ロールを読むコード (theme.colorScheme.primary) はそのままコンパイルできます。Material のクラスが必要なコードは、Material のスターターの toMaterial().colorScheme か materialColorScheme を使います。toMaterial()、visualDensity、tapTargetSize、splashFactory、toCupertino()、cupertinoPrimaryColor、cupertinoProperties は、今はデザインのスターターの拡張メンバーです。スターターのインポートで戻ってきます。

7. LoginDesign

セキュリティのスターターの LoginDesign.material と LoginDesign.cupertino はなくなりました。LoginDesign.app はアプリのデザインのスターターのコントロール (これまでどおり Material か Cupertino のもの) で描き、LoginDesign.widgets は素のウィジェットを描きます。

// 0.7
LoginForm(design: LoginDesign.material)

// 0.8
LoginForm(design: LoginDesign.app)   // または design を省く: アプリのものがデフォルト

8. デザインのないアプリのシード

seed-color、scheme-variant、contrast には、Material 3 のパレットのアルゴリズムを持つデザインのスターターが必要です。widgets のアプリでは、それらを持つテーマは今は起動を失敗させます。デザインのスターターを加えるか、colors.* にロールを書きます。

# 0.7
spring.flutter.theme:
  seed-color: teal

# 0.8、デザインライブラリのないアプリで
spring.flutter.theme:
  colors:
    primary: '#006A6A'
    on-primary: '#FFFFFF'
    primary-container: '#9CF1F0'
    surface: '#F4FBFA'
    # ... アプリが使うすべてのロール。それ以外はベースライン

リポジトリの neon テーマはそうしました。すべてのロールを colors.* に挙げ、seed-color を持ちません。

デザインのプロパティ (components.*、visual-density、tap-target-size、一つの値の splash、cupertino.*) は、スターターがなくても受け付けられます。これまでどおり表示されず、もう検査もされません。ログが、それぞれを読むスターターの名前を挙げます。ページ遷移 zoom と cupertino には、そのスターターが必要です。

9. ページのトランジション

Material と Cupertino のアプリは、ページの切り替えをアニメーションするようになりました。motion.page-transition のないテーマには、どのアプリの種類でもトランジションがありませんでしたが、今は Flutter と同じく platform、つまりアプリの種類固有のものです。MaterialApp ではプラットフォームごとの Material のもの、CupertinoApp ではスワイプで戻れる iOS のスライドです。デザインライブラリのないアプリは、これまでどおりページを即座に切り替えます。即座のページのままにするには、none と書きます。

spring.flutter.theme.motion.page-transition: none

独自のものを選んだ画面やナビゲーション (@ScreenRoute(transition:)、go(path, transition:)) はそのままです。デフォルトが変わった理由は トランジション を参照してください。

10. Android

Flutter 3.50 は、9.1.1 より古い Android Gradle Plugin の Android アプリを拒否します。android/settings.gradle.kts でそれを上げ (セキュリティのスターターのプラグインは、Flutter 3.50 のテンプレートのバージョン 9.3.1 でビルドします)、Gradle ラッパーを推奨の 9.5.0 にします。

// android/settings.gradle.kts
plugins {
    id("com.android.application") version "9.3.1" apply false
}
# android/gradle/wrapper/gradle-wrapper.properties
distributionUrl=https\://services.gradle.org/distributions/gradle-9.5.0-all.zip

11. 再生成

dart run build_runner build --delete-conflicting-outputs

ジェネレーターはデザインのスターターを見つけ、その Bean とデザインを lib/spring_gen/main.spring.dart に書きます。型付きのキーは新しい名前 (theme.spring.keys.dart、messages.spring.keys.dart、json_schemas.spring.classes.dart) で書かれます。生成されたライブラリのパートなのでインポートは変わらず、ビルドが古いファイルを削除します。

関連項目