Flutter功能未定义插件proclaim的使用

Flutter功能未定义插件proclaim的使用

使用说明

Proclaim 是一个类似表格的数据类型，并且支持索引。它与 HiveDB 配合使用效果很好。

示例代码

以下是一个使用 Proclaim 的完整示例代码，展示了如何通过键值对和索引来管理数据。

import 'package:proclaim/proclaim.dart';

// 定义用户类
class User {
  final String name;
  final bool active;
  final String status;
  User(this.name, this.active, this.status);

  [@override](/user/override)
  String toString() => 'User($name, $active, $status)';
}

// 定义名称键类
class NameKey extends Key<User> {
  [@override](/user/override)
  String getKey(User user) => user.name;
}

// 定义活动状态键类
String _activeStatusKeyStr(bool active, String status) => '$active:$status';

class ActiveStatusKey extends Key<User> {
  [@override](/user/override)
  String getKey(User user) => _activeStatusKeyStr(user.active, user.status);
}

// 扩展索引类以获取特定条件下的用户列表
extension ByActiveStatus on IndexMultiple<ActiveStatusKey, User> {
  List<User> getAll(bool active, String status) =>
      getByKeyStr(_activeStatusKeyStr(active, status));
}

// 定义 Proclaim 类
class UserProclaim extends Proclaim<NameKey, User> {
  late IndexMultiple<ActiveStatusKey, User> byActiveStatus;

  UserProclaim() : super(NameKey()) {
    byActiveStatus = addIndexMultiple('active-status', ActiveStatusKey());
  }
}

void main() async {
  // 创建数据源
  var source = MapSource<User>();
  
  // 初始化 Proclaim 并设置数据源
  var res = UserProclaim()..setSource(source);

  // 添加用户数据
  await res.save(User('John', true, 'pending'));
  await res.save(User('Shawna', true, 'complete'));
  await res.save(User('Meili', false, 'complete'));
  await res.save(User('Yetir', true, 'pending'));

  // 获取符合条件的用户列表
  print(res.byActiveStatus.getAll(true, 'pending'));
  // 输出结果: (User(John, true, pending), User(Yetir, true, pending))
}

特性与问题

如果需要报告功能请求或发现任何问题，请前往 GitHub issue 跟踪器 提交。

完整示例代码

以下是完整的示例代码，方便直接复制运行：

import 'package:proclaim/proclaim.dart';

class User {
  final String name;
  final bool active;
  final String status;
  User(this.name, this.active, this.status);

  [@override](/user/override)
  String toString() => 'User($name, $active, $status)';
}

class NameKey extends Key<User> {
  [@override](/user/override)
  String getKey(User user) => user.name;
}

String _activeStatusKeyStr(bool active, String status) => '$active:$status';

class ActiveStatusKey extends Key<User> {
  [@override](/user/override)
  String getKey(User user) => _activeStatusKeyStr(user.active, user.status);
}

extension ByActiveStatus on IndexMultiple<ActiveStatusKey, User> {
  List<User> getAll(bool active, String status) =>
      getByKeyStr(_activeStatusKeyStr(active, status));
}

class UserProclaim extends Proclaim<NameKey, User> {
  late IndexMultiple<ActiveStatusKey, User> byActiveStatus;

  UserProclaim() : super(NameKey()) {
    byActiveStatus = addIndexMultiple('active-status', ActiveStatusKey());
  }
}

void main() async {
  var source = MapSource<User>();
  var res = UserProclaim()..setSource(source);
  await res.save(User('John', true, 'pending'));
  await res.save(User('Shawna', true, 'complete'));
  await res.save(User('Meili', false, 'complete'));
  await res.save(User('Yetir', true, 'pending'));
  print(res.byActiveStatus.getAll(true, 'pending'));
  // 输出结果: (User(John, true, pending), User(Yetir, true, pending))
}