Flutter文件管理状态跟踪插件file_state_manager的使用

概述

file_state_manager 是一个用于在 Flutter 应用程序中轻松实现数据撤销（undo）和重做（redo）功能的插件。该插件不适用于详细的历史记录跟踪，而是针对复杂且可能涉及大量数据变更的应用程序设计。

使用方法

安装

首先，在 pubspec.yaml 文件中添加 file_state_manager 依赖：

dependencies:
  file_state_manager: ^1.0.0

然后运行 flutter pub get 来安装依赖。

示例代码

以下是一个完整的示例代码，展示了如何使用 file_state_manager 插件来管理文件状态并实现撤销和重做功能。

定义可克隆的类

首先，定义一些继承自 CloneableFile 的类，这些类需要实现 clone 和 toDict 方法，并且如果启用了差异检查（enableDiffCheck），还需要重写 == 运算符和 hashCode 方法。

import 'package:file_state_manager/file_state_manager.dart';

class ExampleClass extends CloneableFile {
  late int count;
  late ExampleClassChild child;

  ExampleClass(this.count, this.child);

  ExampleClass.fromDict(Map<String, dynamic> src) {
    count = src["count"];
    child = ExampleClassChild.fromDict(src["child"]);
  }

  @override
  ExampleClass clone() {
    return ExampleClass.fromDict(toDict());
  }

  @override
  Map<String, dynamic> toDict() {
    return {"count": count, "child": child.toDict()};
  }

  // Required if you want to set enableDiffCheck param to true.
  @override
  bool operator ==(Object other) {
    if (other is ExampleClass) {
      return count == other.count && child == other.child;
    } else {
      return false;
    }
  }

  // Required if you want to set enableDiffCheck param to true.
  @override
  int get hashCode {
    return Object.hashAll([count, child]);
  }
}

class ExampleClassChild extends CloneableFile {
  late String message;

  ExampleClassChild(this.message);

  ExampleClassChild.fromDict(Map<String, dynamic> src) {
    message = src["message"];
  }

  @override
  ExampleClassChild clone() {
    return ExampleClassChild.fromDict(toDict());
  }

  @override
  Map<String, dynamic> toDict() {
    return {"message": message};
  }

  // Required if you want to set enableDiffCheck param to true.
  @override
  bool operator ==(Object other) {
    if (other is ExampleClassChild) {
      return message == other.message;
    } else {
      return false;
    }
  }

  // Required if you want to set enableDiffCheck param to true.
  @override
  int get hashCode {
    return Object.hashAll([message]);
  }
}

使用 FileStateManager

接下来，创建一个 FileStateManager 实例，并使用它来管理文件状态。

void main() {
  // 初始化文件状态
  final saveFile = ExampleClass(0, ExampleClassChild("First State"));
  
  // 创建 FileStateManager 实例，设置栈大小为 30 并启用差异检查
  final fsm = FileStateManager(saveFile, stackSize: 30, enableDiffCheck: true);

  // 修改文件状态并推入栈
  saveFile.child.message = "Second State";
  fsm.push(saveFile);

  // 撤销操作
  if (fsm.canUndo()) {
    // 输出 "First State"
    print((fsm.undo()! as ExampleClass).child.message);
  }

  // 重做操作
  if (fsm.canRedo()) {
    // 输出 "Second State"
    print((fsm.redo()! as ExampleClass).child.message);
  }

  // 保存和恢复整个历史记录
  // 将历史记录转换为 Map
  List<Map<String, dynamic>> history = [];
  for (CloneableFile i in fsm.getStack()) {
    history.add((i as ExampleClass).toDict());
  }

  // 从 Map 恢复历史记录
  List<ExampleClass> restoredHistory = [];
  for (Map<String, dynamic> i in history) {
    restoredHistory.add(ExampleClass.fromDict(i));
  }

  // 创建新的 FileStateManager 实例并恢复历史记录
  final restoredFSM = FileStateManager(restoredHistory.removeAt(0),
      stackSize: 30, enableDiffCheck: true);
  for (ExampleClass i in restoredHistory) {
    restoredFSM.push(i);
  }

  // 检查恢复后的文件状态
  ExampleClass restoredNowState = restoredFSM.now() as ExampleClass;
  // 输出 "Second State"
  print(restoredNowState.child.message);

  // 撤销操作
  if (restoredFSM.canUndo()) {
    // 输出 "First State"
    print((restoredFSM.undo()! as ExampleClass).child.message);
  }

  // 输出当前索引
  // 输出 0
  print(restoredFSM.nowIndex());

  // 推送具有相同参数的对象（无效，因为差异检查已启用）
  saveFile.child.message = "First State";
  restoredFSM.push(saveFile);
  // 输出 0
  print(restoredFSM.nowIndex());

  // 显式禁用下一次推送
  restoredFSM.skipNextPush();
  saveFile.child.message = "Second State";
  // 无效推送
  restoredFSM.push(saveFile);
  // 输出 0
  print(restoredFSM.nowIndex());

  // 有效推送
  restoredFSM.push(saveFile);
  // 输出 1
  print(restoredFSM.nowIndex());
}

支持

基本上没有官方支持。如果您遇到任何问题，请提交一个 issue。此包优先级较低，但可能会进行修复。

版本控制

在版本升级时，C 部分将会发生变化。但是，1.0.0 之前的版本可能会在不遵循以下规则的情况下更改文件结构：

• 添加变量、导致读取先前文件出现问题的结构更改：
  • C.X.X
• 添加方法等：
  • X.C.X
• 次要更改和 bug 修复：
  • X.X.C

许可证

本软件根据 MIT 许可证发布，详见 LICENSE 文件。

版权声明

“Dart” 名称和 “Flutter” 名称是 Google LLC 的商标。 *本包的开发者不是 Google LLC。