Flutter模型管理插件rocket_model的使用

Flutter模型管理插件rocket_model的使用

RocketModel 从 RocketClient 获取数据，并通过 RocketView 显示数据。

这是一个定义了在 Flutter 中模型对象行为的抽象类。模型对象是一个类，它表示数据并提供了管理及更新该数据的方法。数据可以存储在各种形式中（例如，在内存中、数据库中或服务器上），并且可以通过模型对象的公共方法访问和操作。

特性

• 提供了一个创建模型对象的基础类。
• 允许你以一致且可预测的方式定义模型对象的行为。
• 实现了 RocketListenable 混入类，允许你在模型发生变化时通知监听者。
• 包含了用于管理及更新数据的方法，如添加和删除项目。
• 提供了处理数据加载和错误处理的钩子。

开始使用

要在你的 Flutter 应用程序中使用 RocketModel，你需要导入 rocket_listenable 和 rocket_exception 包。然后，你可以创建一个新的类并扩展 RocketModel 类来定义模型对象的行为。

import 'package:flutter/foundation.dart';
import 'package:rocket_listenable/rocket_listenable.dart';

import 'constants.dart';

import 'rocket_exception.dart';

abstract class RocketModel<T> extends RocketListenable {
  // ...
}

一旦你创建了 RocketModel 的子类，你就可以在应用程序中使用它来管理和更新数据。例如，你可能会使用一个模型对象来管理你想在视图中显示的一组项。

class MyItem {
  final String name;
  final String description;

  MyItem({required this.name, required this.description});
}

class MyModel extends RocketModel<MyItem> {
  MyModel() {
    // Load data from a server or database...
  }

  [@override](/user/override)
  void fromJson(Map<String, dynamic> json, {bool isSub = false}) {
    // Deserialize data from a JSON map...
  }

  [@override](/user/override)
  Map<String, dynamic> toJson() {
    // Serialize data to a JSON map...
    return {};
  }
}

class MyView extends StatelessWidget {
  final MyModel model = MyModel();

  [@override](/user/override)
  Widget build(BuildContext context) {
    return ListView.builder(
      itemCount: model.all?.length ?? 0,
      itemBuilder: (BuildContext context, int index) {
        final item = model.all![index];
        return ListTile(
          title: Text(item.name),
          subtitle: Text(item.description),
        );
      },
    );
  }
}

API 文档

RocketModel

这是一个定义了模型对象行为的抽象类。

属性

• instance: 模型实例。
• _loadingChecker: 一个标志，指示模型是否正在加载数据。
• existData: 一个标志，指示模型是否包含任何数据。
• exception: 一个异常对象，表示在数据加载或操作过程中发生的任何错误。
• all: 一个类型为 T 的数据对象列表。
• _state: 模型的当前状态。

方法

• setException(RocketException exception): 使用给定的异常设置异常对象。
• delItem(int index): 删除指定索引的数据对象。
• addItem(T newModel): 添加一个新的数据对象。
• _mapToInstance(e): 将给定的数据映射到模型的一个实例。
• setMulti(List data): 将模型的数据设置为给定的数据列表。
• fromJson(Map<String, dynamic> json, {bool isSub = false}): 从给定的 JSON 映射反序列化模型的数据。
• toJson(): 将模型的数据序列化为 JSON 映射。
• rebuildWidget({bool fromUpdate = false}): 通知监听者模型已更改，需要重建。

RocketState

这是一个表示 RocketModel 对象可能状态的枚举。

值

• loading: 模型正在加载数据。
• done: 模型已完成加载数据，并包含有效数据。
• failed: 在加载或操作数据时发生错误。

使用示例

import 'package:flutter_rocket/flutter_rocket.dart';

const String postUserIdField = "userId";
const String postIdField = "id";
const String postTitleField = "title";
const String postBodyField = "body";

class Post extends RocketModel<Post> {
  int? userId;
  int? id;
  String? title;
  String? body;
  // 禁用日志调试
  [@override](/user/override)
  bool get enableDebug => false;

  Post({
    this.userId,
    this.id,
    this.title,
    this.body,
  });

  [@override](/user/override)
  void fromJson(Map<String, dynamic> json, {bool isSub = false}) {
    userId = json[postUserIdField];
    id = json[postIdField];
    title = json[postTitleField];
    body = json[postBodyField];
    super.fromJson(json, isSub: isSub);
  }

  void updateFields({
    int? userIdField,
    int? idField,
    String? titleField,
    String? bodyField,
  }) {
    userId = userIdField ?? userId;
    id = idField ?? id;
    title = titleField ?? title;
    body = bodyField ?? body;
    rebuildWidget(fromUpdate: true);
  }

  [@override](/user/override)
  Map<String, dynamic> toJson() {
    final Map<String, dynamic> data = {};
    data[postUserIdField] = userId;
    data[postIdField] = id;
    data[postTitleField] = title;
    data[postBodyField] = body;

    return data;
  }

  [@override](/user/override)
  get instance => Post();
}

完整示例

以下是一个完整的示例，展示了如何使用 RocketModel 来管理数据并在视图中显示数据。

import 'package:example/model.dart';
import 'package:flutter/material.dart';
import 'package:rocket_model/rocket_model.dart';

void main() {
  runApp(const MyApp());
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const RocketModelExample(),
    );
  }
}

class RocketModelExample extends StatefulWidget {
  const RocketModelExample({super.key});

  [@override](/user/override)
  RocketModelExampleState createState() => RocketModelExampleState();
}

class RocketModelExampleState extends State<RocketModelExample> {
  final ExampleModel _model = ExampleModel();

  [@override](/user/override)
  void initState() {
    super.initState();
    _model.registerListener(rocketRebuild, _onModelChanged);
    _model.loadData();
  }

  [@override](/user/override)
  void dispose() {
    _model.removeListener(rocketRebuild, _onModelChanged);
    super.dispose();
  }

  void _onModelChanged() {
    setState(() {});
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('RocketModel Example Screen'),
      ),
      body: Center(
        child: _buildBody(),
      ),
    );
  }

  Widget _buildBody() {
    switch (_model.state) {
      case RocketState.loading:
        return const CircularProgressIndicator();
      case RocketState.failed:
        return Text('Failed to load data: ${_model.exception}');
      case RocketState.done:
        if (_model.existData) {
          return ListView.builder(
            itemCount: _model.all?.length,
            itemBuilder: (BuildContext context, int index) {
              final data = _model.all![index];
              return ListTile(
                leading: Text(data.id!.toString()),
                title: Text(data.name!),
              );
            },
          );
        } else {
          return const Text('No data');
        }
      default:
        return Container();
    }
  }
}