Zenn
🚰

ObjectBoxでStreamを理解する

2023/02/08に公開
Flutter
stream
objectbox
tech

hasなんとか理解してなかったな

StreamBuilderのhasDataはどんな役割をしているのかが理解してないままでした。これは良くないなと思いFlutterの内部を除いてみて調べてみました。
自分がいつみてもわかるように日本語に翻訳しました。

hasData、hasErrorについて

///これは、非同期計算が成功した場合でも、計算が非NULL値を返さなかった場合は
/// 計算が成功しても，非NULL値を返さない場合は偽となる．例えば
/// 例えば，[Future<void>] が成功しても，NULL値で完了します．
/// 成功裏に完了する．
bool get hasData => data != null;

/// このスナップショットが非NULLの[エラー]値を含むかどうかを返します。
///
/// 非同期計算の最後の結果が失敗であった場合、これは常に真となる。
/// 失敗。
bool get hasError => error != null;

connectionStateについて

/// 非同期計算への接続の現在の状態．
final ConnectionState connectionState;

/// 非同期計算で受け取った最新のデータ。
///
/// これが非NULLの場合、[hasData]は真となる。
///
/// [error]がNULLでない場合、これはNULLとなる。hasError]を参照。
///
/// 非同期計算が一度も値を返さなかった場合、これは
/// 関連するウィジェットによって指定された初期データ値に設定されます。参照
/// [FutureBuilder.initialData] と [StreamBuilder.initialData] を参照してください。
final T data?

これで、こちらのコードが何をしているのか理解できるようになりそうです。

FlutterFire公式のコード

class UserInformation extends StatefulWidget {
  @override
    _UserInformationState createState() => _UserInformationState();
}

class _UserInformationState extends State<UserInformation> {
  final Stream<QuerySnapshot> _usersStream = FirebaseFirestore.instance.collection('users').snapshots();

  @override
  Widget build(BuildContext context) {
    return StreamBuilder<QuerySnapshot>(
      stream: _usersStream,
      builder: (BuildContext context, AsyncSnapshot<QuerySnapshot> snapshot) {
        if (snapshot.hasError) {
          return Text('Something went wrong');
        }

        if (snapshot.connectionState == ConnectionState.waiting) {
          return Text("Loading");
        }

        return ListView(
          children: snapshot.data!.docs.map((DocumentSnapshot document) {
          Map<String, dynamic> data = document.data()! as Map<String, dynamic>;
            return ListTile(
              title: Text(data['full_name']),
              subtitle: Text(data['company']),
            );
          }).toList(),
        );
      },
    );
  }
}

LocalDBでもStreamを使ってみる

Firebaseばかり普段使っているので、LocalDBのObjectBoxでStreamを使ってみました。
なぜStreamを使うのかというと、データを追加してもすぐに画面に状態が変わったことが伝わらないので、Streamを使って、データを監視させて変化したら、画面を更新する処理が必要だからです。

詳しくはこちらを参照

https://api.flutter.dev/flutter/dart-async/Stream-class.html

こんなアプリを作ります

必要なpackageを追加する

pubspec.yaml
name: object_box_app
description: A new Flutter project.

# The following line prevents the package from being accidentally published to
# pub.dev using `flutter pub publish`. This is preferred for private packages.
publish_to: 'none' # Remove this line if you wish to publish to pub.dev

# The following defines the version and build number for your application.
# A version number is three numbers separated by dots, like 1.2.43
# followed by an optional build number separated by a +.
# Both the version and the builder number may be overridden in flutter
# build by specifying --build-name and --build-number, respectively.
# In Android, build-name is used as versionName while build-number used as versionCode.
# Read more about Android versioning at https://developer.android.com/studio/publish/versioning
# In iOS, build-name is used as CFBundleShortVersionString while build-number is used as CFBundleVersion.
# Read more about iOS versioning at
# https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html
# In Windows, build-name is used as the major, minor, and patch parts
# of the product and file versions while build-number is used as the build suffix.
version: 1.0.0+1

environment:
  sdk: '>=2.18.0 <3.0.0'

# Dependencies specify other packages that your package needs in order to work.
# To automatically upgrade your package dependencies to the latest versions
# consider running `flutter pub upgrade --major-versions`. Alternatively,
# dependencies can be manually updated by changing the version numbers below to
# the latest version available on pub.dev. To see which dependencies have newer
# versions available, run `flutter pub outdated`.
dependencies:
  flutter:
    sdk: flutter


  # The following adds the Cupertino Icons font to your application.
  # Use with the CupertinoIcons class for iOS style icons.
  cupertino_icons: ^1.0.2
  objectbox: ^1.7.0
  objectbox_flutter_libs: ^1.7.0


dev_dependencies:
  flutter_test:
    sdk: flutter

  # The "flutter_lints" package below contains a set of recommended lints to
  # encourage good coding practices. The lint set provided by the package is
  # activated in the `analysis_options.yaml` file located at the root of your
  # package. See that file for information about deactivating specific lint
  # rules and activating additional ones.
  flutter_lints: ^2.0.0
  build_runner: ^2.3.3
  objectbox_generator: ^1.7.0

# For information on the generic Dart part of this file, see the
# following page: https://dart.dev/tools/pub/pubspec

# The following section is specific to Flutter packages.
flutter:

  # The following line ensures that the Material Icons font is
  # included with your application, so that you can use the icons in
  # the material Icons class.
  uses-material-design: true

  # To add assets to your application, add an assets section, like this:
  # assets:
  #   - images/a_dot_burr.jpeg
  #   - images/a_dot_ham.jpeg

  # An image asset can refer to one or more resolution-specific "variants", see
  # https://flutter.dev/assets-and-images/#resolution-aware

  # For details regarding adding assets from package dependencies, see
  # https://flutter.dev/assets-and-images/#from-packages

  # To add custom fonts to your application, add a fonts section here,
  # in this "flutter" section. Each entry in this list should have a
  # "family" key with the font family name, and a "fonts" key with a
  # list giving the asset and other descriptors for the font. For
  # example:
  # fonts:
  #   - family: Schyler
  #     fonts:
  #       - asset: fonts/Schyler-Regular.ttf
  #       - asset: fonts/Schyler-Italic.ttf
  #         style: italic
  #   - family: Trajan Pro
  #     fonts:
  #       - asset: fonts/TrajanPro.ttf
  #       - asset: fonts/TrajanPro_Bold.ttf
  #         weight: 700
  #
  # For details regarding fonts from package dependencies,
  # see https://flutter.dev/custom-fonts/#from-packages

設定ファイルとモデルを作る

こちらのサイトを参考にいたしました。Objectboxの記事３つしかないですよ!
なんだか悲しいですね😭
あっこの記事で４つ目か....
https://zenn.dev/pressedkonbu/articles/flutter-object-box

設定ファイルを作成

object_box.dart
import 'package:object_box_app/main.dart';
import 'package:path/path.dart' as p;
import 'package:path_provider/path_provider.dart';
import 'objectbox.g.dart'; // created by `flutter pub run build_runner build`

class ObjectBox {
  /// The Store of this app.
  late final Store store;

  ObjectBox._create(this.store) {
    // Add any additional setup code, e.g. build queries.
  }

  /// Create an instance of ObjectBox to use throughout the app.
  static Future<ObjectBox> create() async {
    final store = await openStore();
    return ObjectBox._create(store);
  }
}

モデルクラスを作成

idはdefaultで0に設定してint型で使う必要があるみたいです。id以外に名前を使うので、nameプロパティを定義します。

user.dart
import 'package:objectbox/objectbox.dart';

// ユーザークラスを作成
@Entity()
class User {
  User({this.name});
  int id = 0;
  String? name;
}

設定が終わったらビルドランナーを使ってデータベースに必要なファイルを自動生成します。

ビルドランナーでファイルを生成するコマンド.

flutter pub run build_runner build

アプリを操作するページ

main.dartにObjectBoxを使う設定をして、保存したデーターを取得するメソッドとデータを保存するロジックを定義します。

Stream型のメソッド

私、最近はRiverpodばかり使っていたのでStatefulWidgetで作られたアプリのコードが読めなかくて困ったことがありました💦
基礎が欠けていたのだなと反省しております。。。。
こちらのメソッドはリアルタイムにデータの変更を画面に表示するものだと解釈しております。他のコードですが、データはリストとしても扱うので、List<User>って書いていて、mapメソッドは、map型のデータをリストに変換してくれています。
間違っていたら誰か教えてください🙇‍♂️

// ObjectBoxをインスタンス化して、DBにアクセスできるようにする.
  final userBox = objectbox.store.box<User>();
  // StreamでObjectBoxのデータを取得する.
  Stream<List<User>> getUser() {
    final builder = userBox.query()..order(User_.id, flags: Order.descending);
    return builder.watch(triggerImmediately: true).map((queqy) => queqy.find());
  }

こちらが完成品のコード

main.dart
import 'package:flutter/material.dart';
import 'package:object_box_app/object_box.dart';
import 'package:object_box_app/objectbox.g.dart';
import 'package:object_box_app/user.dart';

/// アプリ全体を通してObjectBox Storeにアクセスできるようにします。
late ObjectBox objectbox;

Future<void> main() async {
  // これは、ObjectBox がデータベースを格納するアプリケーション ディレクトリを取得するために必要です。
  // に格納するためです。
  WidgetsFlutterBinding.ensureInitialized();

  objectbox = await ObjectBox.create();

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      home: Builder(
        builder: (context) {
          return const DemoPage();
        },
      ),
    );
  }
}

class DemoPage extends StatefulWidget {
  const DemoPage({Key? key}) : super(key: key);

  @override
  State<DemoPage> createState() => _DemoPageState();
}

class _DemoPageState extends State<DemoPage> {
  // ObjectBoxをインスタンス化して、DBにアクセスできるようにする.
  final userBox = objectbox.store.box<User>();
  // StreamでObjectBoxのデータを取得する.
  Stream<List<User>> getUser() {
    final builder = userBox.query()..order(User_.id, flags: Order.descending);
    return builder.watch(triggerImmediately: true).map((queqy) => queqy.find());
  }

  // Formのデータを入力するコントローラー.
  final controller = TextEditingController();

  // 状態を破棄する.
  @override
  void dispose() {
    controller.dispose();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Colors.green[400],
        title: const Text('ObjectBox'),
      ),
      body: Column(
        children: [
          Padding(
            padding: const EdgeInsets.all(32),
            child: TextFormField(
              controller: controller,
              decoration: InputDecoration(hintText: 'ユーザー名'),
            ),
          ),
          ElevatedButton(
              style: ElevatedButton.styleFrom(backgroundColor: Colors.black54),
              onPressed: () {
                // Userクラスのnameプロパティにcontrollerの値を保存する.
                final user = User(name: controller.text);
                // objectboxにデータを保存する.
                userBox.put(user);
                // 状態の変更を伝えるのに、setStateを書く.
                setState(() {});
              },
              child: Text('ユーザーを追加する')),
          const SizedBox(height: 16),
          Expanded(
              child: StreamBuilder<List<User>>(
                  stream: getUser(),// getUserメソッドからデータを取得する.
                  builder: (context, snapshot) {
                    // スナップショットが非NULLの[エラー]値を含むかどうかを返す
                    if (!snapshot.hasData) {
                      return const CircularProgressIndicator();// エラーだったらローディングの処理をする.
                    }
                    return ListView.builder(
                        itemCount: snapshot.hasData ? snapshot.data!.length : 0,
                        itemBuilder: (BuildContext context, int index) {
                          // snapshotの情報を格納する.
                          final user = snapshot.data![index];
                          return ListTile(
                            trailing: IconButton(
                              onPressed: () {
                                // snapshotからidを呼び出す.
                                userBox.remove(user.id);
                              },
                              icon: const Icon(Icons.delete, color: Colors.red),
                            ),
                            title: Text(snapshot.data![index].name.toString()),
                          );
                        });
                  })),
        ],
      ),
    );
  }
}

最後に

StatefulWidgetについて最近学び直すことになったので、誰かの役に立てばいいな思って記事を書いていこうと思います。
私、Flutter大学というコミュニティに所属しております。もしご興味があれば参加してみてください。
３ヶ月に一度、アプリの共同開発をやっていたり滋賀県のFlutter別荘で合宿をやっております!
https://flutteruniv.com/

おまけ

エラーメッセージをローカルDBで表示するのをやったことがなかったので、Validationを追加してみました!

変更後のコード

main.dart
import 'package:flutter/material.dart';
import 'package:object_box_app/object_box.dart';
import 'package:object_box_app/objectbox.g.dart';
import 'package:object_box_app/user.dart';

/// アプリ全体を通してObjectBox Storeにアクセスできるようにします。
late ObjectBox objectbox;

Future<void> main() async {
  // これは、ObjectBox がデータベースを格納するアプリケーション ディレクトリを取得するために必要です。
  // に格納するためです。
  WidgetsFlutterBinding.ensureInitialized();

  objectbox = await ObjectBox.create();

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      home: Builder(
        builder: (context) {
          return const DemoPage();
        },
      ),
    );
  }
}

class DemoPage extends StatefulWidget {
  const DemoPage({Key? key}) : super(key: key);

  @override
  State<DemoPage> createState() => _DemoPageState();
}

class _DemoPageState extends State<DemoPage> {
  // ObjectBoxをインスタンス化して、DBにアクセスできるようにする.
  final userBox = objectbox.store.box<User>();
  // StreamでObjectBoxのデータを取得する.
  Stream<List<User>> getUser() {
    final builder = userBox.query()..order(User_.id, flags: Order.descending);
    return builder.watch(triggerImmediately: true).map((queqy) => queqy.find());
  }

  // Formのデータを入力するコントローラー.
  final controller = TextEditingController();

  // 状態を破棄する.
  @override
  void dispose() {
    controller.dispose();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Colors.green[400],
        title: const Text('ObjectBox'),
      ),
      body: Column(
        children: [
          Padding(
            padding: const EdgeInsets.all(32),
            child: TextFormField(
              controller: controller,
              decoration: InputDecoration(hintText: 'ユーザー名'),
            ),
          ),
          ElevatedButton(
              style: ElevatedButton.styleFrom(backgroundColor: Colors.black54),
              onPressed: () {
                try {
                  if (controller.text.isEmpty) {
                    throw ('名前が入力されておりません!');
                  }
                  // Userクラスのnameプロパティにcontrollerの値を保存する.
                  final user = User(name: controller.text);
                  // objectboxにデータを保存する.
                  userBox.put(user);
                  // 状態の変更を伝えるのに、setStateを書く.
                  setState(() {});
                } catch (e) {
                  showDialog(
                    context: context,
                    builder: (BuildContext context) {
                      return AlertDialog(
                        // throwのエラーメッセージがダイアログで表示される.
                        title: Text(e.toString()),
                        actions: <Widget>[
                          ElevatedButton(
                            child: Text('OK'),
                            onPressed: () {
                              Navigator.of(context).pop();
                            },
                          ),
                        ],
                      );
                    },
                  );
                }
              },
              child: Text('ユーザーを追加する')),
          const SizedBox(height: 16),
          Expanded(
              child: StreamBuilder<List<User>>(
                  stream: getUser(), // getUserメソッドからデータを取得する.
                  builder: (context, snapshot) {
                    // スナップショットが非NULLの[エラー]値を含むかどうかを返す
                    if (!snapshot.hasData) {
                      return const CircularProgressIndicator(); // エラーだったらローディングの処理をする.
                    }
                    return ListView.builder(
                        itemCount: snapshot.hasData ? snapshot.data!.length : 0,
                        itemBuilder: (BuildContext context, int index) {
                          // snapshotの情報を格納する.
                          final user = snapshot.data![index];
                          return ListTile(
                            trailing: IconButton(
                              onPressed: () {
                                // snapshotからidを呼び出す.
                                userBox.remove(user.id);
                              },
                              icon: const Icon(Icons.delete, color: Colors.red),
                            ),
                            title: Text(snapshot.data![index].name.toString()),
                          );
                        });
                  })),
        ],
      ),
    );
  }
}

実行結果

2023/04/18（火）に編集機能を追加
編集機能の実装ができたので、コードを新たに追加します。

// main.dart

import 'package:flutter/material.dart';
import 'package:item_box/object_box.dart';
import 'package:item_box/user.dart';
import 'package:objectbox/objectbox.dart';
import 'objectbox.g.dart'; // This file is generated by build_runner.

/// アプリ全体を通してObjectBox Storeにアクセスできるようにします。
late ObjectBox objectbox;

Future<void> main() async {
  // これは、ObjectBox がデータベースを格納するアプリケーション ディレクトリを取得するために必要です。
  // に格納するためです。
  WidgetsFlutterBinding.ensureInitialized();

  objectbox = await ObjectBox.create();

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: DemoPageState(),
    );
  }
}

class DemoPageState extends StatefulWidget {
  DemoPageState({Key? key}) : super(key: key);

  @override
  State<DemoPageState> createState() => _DemoPageStateState();
}

class _DemoPageStateState extends State<DemoPageState> {
  // ObjectBoxをインスタンス化して、DBにアクセスできるようにする.
  final userBox = objectbox.store.box<User>();
  // StreamでObjectBoxのデータを取得する.
  Stream<List<User>> getUser() {
    final builder = userBox.query()..order(User_.id, flags: Order.descending);
    return builder.watch(triggerImmediately: true).map((queqy) => queqy.find());
  }

  // Formのデータを入力するコントローラー.
  final controller = TextEditingController();

  // 状態を破棄する.
  @override
  void dispose() {
    controller.dispose();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Colors.green[400],
        title: const Text('ObjectBox'),
      ),
      body: Column(
        children: [
          Padding(
            padding: const EdgeInsets.all(32),
            child: TextFormField(
              controller: controller,
              decoration: InputDecoration(hintText: 'ユーザー名'),
            ),
          ),
          ElevatedButton(
              style: ElevatedButton.styleFrom(backgroundColor: Colors.black54),
              onPressed: () {
                // Userクラスのnameプロパティにcontrollerの値を保存する.
                final user = User(name: controller.text);
                // objectboxにデータを保存する.
                userBox.put(user);
                // 状態の変更を伝えるのに、setStateを書く.
                setState(() {});
              },
              child: Text('ユーザーを追加する')),
          const SizedBox(height: 16),
          Expanded(
              child: StreamBuilder<List<User>>(
                  stream: getUser(),
                  builder: (context, snapshot) {
                    if (!snapshot.hasData) {
                      return const CircularProgressIndicator();
                    }
                    return ListView.builder(
                        itemCount: snapshot.hasData ? snapshot.data!.length : 0,
                        itemBuilder: (BuildContext context, int index) {
                          final user = snapshot.data![index];
                          return ListTile(
+                            trailing: Row(
+                              mainAxisSize: MainAxisSize.min,
+                              children: [
+                                IconButton(
+                                  onPressed: () {
+                                    _showEditDialog(user);
+                                  },
+                                  icon: const Icon(Icons.edit,
+                                      color: Colors.blue),
+                                ),
+                                IconButton(
+                                  onPressed: () {
+                                    userBox.remove(user.id);
+                                    setState(() {});
+                                  },
+                                  icon: const Icon(Icons.delete,
+                                      color: Colors.red),
+                                ),
+                              ],
+                            ),
                            title: Text(snapshot.data![index].name.toString()),
                          );
                        });
                  })),
        ],
      ),
    );
  }

+  Future<void> _showEditDialog(User user) async {
+    final TextEditingController _editController =
+        TextEditingController(text: user.name);
+
+    return showDialog<void>(
+      context: context,
+      barrierDismissible: false,
+      builder: (BuildContext context) {
+        return AlertDialog(
+          title: const Text('ユーザー名を編集'),
+          content: SingleChildScrollView(
+            child: ListBody(
+              children: <Widget>[
+                TextField(
+                  controller: _editController,
+                  decoration: InputDecoration(hintText: 'ユーザー名'),
+                ),
+              ],
+            ),
+          ),
+          actions: <Widget>[
+            TextButton(
+              child: const Text('キャンセル'),
+              onPressed: () {
+                Navigator.of(context).pop();
+              },
+            ),
+            TextButton(
+              child: const Text('保存'),
+              onPressed: () {
+                user.name = _editController.text;
+                userBox.put(user);
+                setState(() {});
+                Navigator.of(context).pop();
+              },
+            ),
+          ],
+        );
+      },
+    );
+  }
+}

スクリーンショット

Discussion