本文正在参加「金石方案」

前言

上一篇咱们介绍了运用 sqflite 这个数据库工具在 Flutter 的应用中树立本地数据库的实例应用。了解过数据库的同学应该会知道,数据表结构是可能发生改动的。可是 App 的版别会有碎片化的存在,假如数据表结构发生了改动,就需求对旧版别 App 的数据表结构进行同步,否则会导致程序运转过错。典型的比便利是数据表添加了字段,可是旧版 App的数据表没有同步,这样会导致程序读不到对应的字段而犯错。 解决这种情况就需求运用数据表的版别办理。

sqflite 版别办理

咱们运用 sqflite 创立数据库的时分,有个 version 参数,便是用于界说当时的数据库版别。

Future<Database> _initDB(String filePath) async {
    final dbPath = await getDatabasesPath();
    final path = join(dbPath, filePath);
    return await openDatabase(path, version: 1, onCreate: _createDB);
}

一起 sqflite 供给了一个办法来获取当时数据库的版别。

var version = await db.getVersion();

有了这个,咱们就能够判别当时本地的数据库版别是不是最新版别了。在 sqflite 中,供给了版别晋级的处理办法,当检测到 version 参数比当时的数据库版别高时,就能够执行 onUpgrade 办法,在这个办法里能够处理数据表晋级操作,比方添加/删去字段,更改字段默认值等。

var db = await openDatabase(path,
        version: latestVersion, onCreate: _createDB, onUpgrade: _updateDB);

备忘录实例 – 添加标签

还是以咱们上一篇的备忘录为例,咱们假设需求给备忘录添加一个标签字段,界面如下所示。

如何处理 Flutter 版本升级的数据表变化?
这个时分咱们就需求更改备忘录数据表,添加一个标签字段。由于 SQLite 无法存储数组,咱们能够将多个标签转换为特殊符号分隔的字符串,比方这儿运用的是竖线“|”。添加数据表的字段的数据库版别晋级代码如下。

Future<void> _updateDB(Database db, int oldVersion, int newVersion) async {
    try {
      await db.execute('ALTER TABLE memo ADD COLUMN tags TEXT');
    } on DatabaseException catch (e) {
      if (e.isDuplicateColumnError()) {
        // 忽略该反常,该列现已存在
      } else {
        rethrow;
      }
    }
    await db.setVersion(newVersion);
  }

这儿之所以捕获反常,是因为添加字段操作不允许添加已有的字段,假如发生了重复字段反常处理咱们忽略这个反常,已让程序能够正常运转。 这儿需求注意,在创立数据表的时分也需求更改SQL,添加 tags 字段(upgrade办法只对旧版别的做晋级处理,不会更改现有版别的数据表)。

Future<void> _createDB(Database db, int version) async {
    await db.execute('''
      CREATE TABLE memo (
        id INTEGER PRIMARY KEY AUTOINCREMENT,
        title TEXT,
        content TEXT,
        tags TEXT,
        created_time INTEGER,
        modified_time INTEGER
      )
    ''');
  }

接下来是备忘录的代码实现,咱们用 InputChip界说了一个标签组件,以支撑能够经过删去图标删掉标签。

class Tag extends StatelessWidget {
  final String text;
  final VoidCallback onDeleted;
  const Tag({Key? key, required this.text, required this.onDeleted})
      : super(key: key);
  @override
  Widget build(BuildContext context) {
    return InputChip(
      label: Text(text),
      onDeleted: onDeleted,
    );
  }
}

在添加备忘录的页面中,在表单区添加了如下内容,一个 Wrap 组件来显示多个标签,然后一个输入框来添加标签。

Column(
    crossAxisAlignment: CrossAxisAlignment.start,
    children: [
      Wrap(
        alignment: WrapAlignment.start,
        spacing: 4.0,
        runSpacing: 4.0,
        children: [
          for (final tag in _tags)
            Tag(
              text: tag,
              onDeleted: () => _removeTag(tag),
            )
        ],
      ),
      TextField(
        controller: _tagController,
        decoration: InputDecoration(
          labelText: '添加标签',
          suffixIcon: IconButton(
            icon: const Icon(Icons.add),
            onPressed: _addTag,
          ),
        ),
        onSubmitted: (_) => _addTag(),
      ),
    ],
  ),

当添加标签时,就往标签数组里添加标签字符串元素,删去标签时就移除该标签。这儿注意,为了防止标签重复,添加标签时需求查看当时标签是否现已存在。

void _addTag() {
  final newTag = _tagController.text.trim();
  if (newTag.isNotEmpty && !_tags.contains(newTag)) {
    setState(() {
      _tags.add(newTag);
      _tagController.clear();
    });
  }
}

之后便是更改咱们的保存备忘录的办法。

Future<int> _saveMemo(BuildContext context) async {
  var createdTimestamp = DateTime.now().millisecondsSinceEpoch ~/ 1000;
  var modifiedTimestamp = createdTimestamp;
  var memoMap = {
    'title': _title,
    'content': _content,
    'created_time': createdTimestamp,
    'modified_time': modifiedTimestamp,
    'tags': _tags.isNotEmpty ? _tags.join('|') : '',
  };
  // 保存备忘录
  var id = await insertMemo(memoMap);
  return id;
}

运转作用

运转作用如下,完整代码现已上传到:本地存储相关代码。

如何处理 Flutter 版本升级的数据表变化?

总结

本篇介绍了 Flutter 运用 sqflite 处理数据表改变的版别晋级处理办法。当咱们运用数据库在 App 里存储本地结构化数据的时分,不可防止会遇到新增字段、删去字段等的处理吗,这个时分就需求进行数据库版别晋级操作。在 sqflite 中,会主动根据本地的数据库版别和当时的数据库版别进行比照,假如本地版别低于当时的数据库版别就会调用 onUpgrade 办法处理版别晋级,比方字段改变,数据搬迁等。 一起,我们做本地数据库的时分,务必注意不同版别之间的兼容,一方面是尽可能地坚持数据表不改变,另一方面是做好不同版别的晋级和数据搬迁工作。

我是岛上码农,微信公众号同名。如有问题能够加自己微信沟通,微信号:island-coder

:觉得有收成请点个赞鼓舞一下!

:保藏文章,便利回看哦!

:谈论沟通,互相前进!

本文正在参加「金石方案」