Flutter数据库抽象层插件idb_shim的使用

idb_shim 是一个纯Dart编写的Indexed DB风格API，旨在为Flutter应用提供跨平台的数据库解决方案。它在不同平台上有着不同的实现方式：

• 在Web端（Wasm兼容，使用 dart:js_interop），它是基于IndexedDB Web API的一个轻量级封装。
• 在IO端（包括桌面和移动设备）以及内存中，提供了基于Sembast的实现，这使得开发者可以在测试环境中方便地模拟真实的数据访问场景。

一、基本用法

1. 替换原有的IndexedDB代码

如果你已经有一个使用IndexedDB的应用，可以将如下代码：

import 'dart:indexed_db';
window.indexedDB.open(dbName, version: xxx, onUpgradeNeeded: yyy);

替换为：

import 'package:idb_shim/idb_browser.dart'
IdbFactory idbFactory = getIdbFactory();
idbFactory.open(dbName, version: xxx, onUpgradeNeeded: yyy);

2. 示例代码

下面是一个简单的示例，展示了如何打开数据库、创建对象存储区、插入数据并读取数据：

// 定义存储区名称
const String storeName = "records";

// 打开数据库
Database db = await idbFactory.open("my_records.db", version: 1,
    onUpgradeNeeded: (VersionChangeEvent event) {
  Database db = event.database;
  // 创建存储区
  db.createObjectStore(storeName, autoIncrement: true);
});

// 插入数据
var txn = db.transaction(storeName, "readwrite");
var store = txn.objectStore(storeName);
var key = await store.put({"some": "data"});
await txn.completed;

// 读取数据
txn = db.transaction(storeName, "readonly");
store = txn.objectStore(storeName);
Map value = await store.getObject(key);
await txn.completed;

print(value);

二、Flutter支持

对于Flutter项目来说，虽然可以直接使用idb_shim结合sembast来作为后端存储方案，但也有专门针对移动端（iOS和Android）的实现——idb_sqflite，该实现基于sqflite库。

三、注意事项

1. 调试时保持相同的Web端口：由于浏览器中的IndexedDB与端口绑定，在调试过程中应确保使用相同端口以维持同一份数据库实例。
2. 类型限制：支持JSON序列化/反序列化的类型（如num、String、bool等），并且从版本1.11开始增加了对DateTime和Uint8List的支持。但是需要注意的是，循环引用不被支持，并且不要尝试在一个布尔值上建立索引。
3. 键类型的限制：只支持字符串和数字（整数或浮点数）作为键值。

四、完整示例Demo

为了更好地理解idb_shim的实际应用，以下是一个完整的示例demo，演示了如何在Flutter项目中使用idb_shim进行数据持久化操作。

示例代码

// ignore_for_file: avoid_print

import 'package:idb_shim/idb_io.dart';

void main() async {
  final idbFactory = getIdbFactoryPersistent('test/tmp/out');

  // 定义存储区名称
  final storeName = 'records';

  // 打开数据库
  final db = await idbFactory.open('my_records.db', version: 1,
      onUpgradeNeeded: (VersionChangeEvent event) {
    final db = event.database;
    // 创建存储区
    db.createObjectStore(storeName, autoIncrement: true);
  });

  // 插入数据
  var txn = db.transaction(storeName, idbModeReadWrite);
  var store = txn.objectStore(storeName);
  var key = await store.put({'some': 'data'});
  await txn.completed;

  // 读取数据
  txn = db.transaction(storeName, idbModeReadOnly);
  store = txn.objectStore(storeName);
  final value = await store.getObject(key) as Map;
  await txn.completed;

  print(value);
}

这个例子展示了如何在Flutter应用程序中使用idb_shim来进行简单的CRUD操作。通过这种方式，你可以轻松地在多个平台上实现一致的数据存储逻辑。