spring_boot_starter_flutter_signals

spring_boot_starter_flutter_signals は、spring_boot_starter_flutter の上に作られた Flutter アプリの Bean に、リアクティブな状態を置きます。コンポーネントに付ける三つのアノテーションと、普通のフィールドです。

使う理由

互いに別々に変わる複数のフィールドを持つ Bean には、よくある答えが二つあります。Bean 全体のための一つの通知 (聞いているすべてのウィジェットが再構築される) か、すべてのフィールドを包むラッパー型と、読むたびの .value です。ここでは、フィールドは普通のフィールドのままです。Bean の生成されたプロキシが、読み取りと代入を追跡します。そのため、次のようになります。

スターターは、サードパーティのパッケージ signals_core の上に作られています。そこから再エクスポートするのは batch と untracked だけです。ChangeNotifier の代わりではなく、その横に並びます。@ChangeNotifierComponent と @NotifyListeners はそのままです (ChangeNotifier の横で を参照)。

セットアップ

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

dependencies:
  flutter:
    sdk: flutter
  spring_boot_starter_flutter_signals: ^0.9.0

dev_dependencies:
  build_runner: ^2.17.0
  spring_core_dart_generator: ^0.9.0

スターターは spring_boot_starter_flutter を連れてきて再エクスポートします。アプリは代わりにこのパッケージを列挙します。インポートは一つで足ります。

import 'package:spring_boot_starter_flutter_signals/spring_boot_starter_flutter_signals.dart';

Flutter 3.50 以降 (Dart 3.14) が必要です。プロキシはジェネレーターが書き出します。アノテーションを追加または削除した後は dart run build_runner build を実行します。

例

合計がアイテムとクーポンに従い、エフェクトが保存するバスケットです。

// lib/main.dart
import 'package:flutter/widgets.dart';
import 'package:spring_boot_starter_flutter_signals/spring_boot_starter_flutter_signals.dart';

import 'spring_gen/main.spring.dart';

class Book {
  const Book(this.title, this.price);

  final String title;
  final double price;
}

@Service()
class BasketStorage {
  final List<int> saved = [];

  void write(int count) => saved.add(count);
}

@Component()
class Basket {
  Basket(this.storage);              // 通常のインジェクション

  final BasketStorage storage;

  @Signal()
  List<Book> items = [];

  @Signal()
  String? coupon;

  @Computed()                        // items か coupon が変わるまで保持される
  double get total =>
      items.fold(0.0, (sum, book) => sum + book.price) *
      (coupon == null ? 1 : 0.9);

  @Effect()                          // items が変わるたびに再び実行される
  void save() => storage.write(items.length);

  void add(Book book) => items.add(book);
  void apply(String code) => coupon = code;
}

// Spring のウィジェットは自分の build を追跡する: クーポンが変わると
// 再構築され、バスケットの他のものでは再構築されない。
class CouponLabel extends SpringStatelessWidget<(Basket,)> {
  const CouponLabel({super.key});

  @override
  Widget build(BuildContext context) {
    final (basket,) = beans;
    return Text('Coupon: ${basket.coupon ?? 'none'}');
  }
}

class Shop extends StatelessWidget {
  const Shop({super.key});

  @override
  Widget build(BuildContext context) {
    final basket = context.bean<Basket>();
    return Column(
      children: [
        GestureDetector(
          onTap: () => basket.add(const Book('Dune', 10)),
          child: const Text('Add Dune'),
        ),
        // 合計が変わると再構築され、他のものでは再構築されない。
        Watch((context) => Text('Total: ${basket.total}')),
        const CouponLabel(),
      ],
    );
  }
}

@SpringBootApplication()
void main() => runApp(
  SpringApplicationWidget(
    application: () => springApplication,
    home: const Shop(),
  ),
);

コンポーネントは、別の指定がなければシングルトンです。そのため、これはアプリの状態であり、インジェクションによって、またはウィジェットのコンテキストから、どこからでも届きます。

実行する

dart run build_runner build   # Basket のプロキシを書き出す
flutter run

内容

知っておくこと

Spring (Java) との対応

Spring には対応するものがありません。形は Spring のものです。コンポーネントのメンバーに付けるアノテーションと、Bean のプロキシがその周りで実行するアドバイスで、@Transactional や @Cacheable と同じです。Spring と違う点が一つあります。このようなメンバーを持つ Bean は、自分自身に対して行う呼び出しにもアドバイスが適用されます。

関連項目