数据库初始化 Flutter 使用 ORM 框架管理数据库版本升级

先关注,精彩内容不错过

前言

我们前面一篇介绍了使用 floor 这个 ORM 框架处理 Flutter 本地的 SQLite 数据库。使用 ORM 框架最大的好处是简化了数据库维护的代码量,使得我们可以专注于业务代码实现。在之前,我们也讲到了不同 App 版本的 数据表结构变化后,如何使用 sqflite 来处理版本升级。本篇,我们看看使用 floor 如何处理数据库版本升级。

floor 数据库版本升级

floor 框架同样提供了数据库版本号,当前使用的版本号使用注解配置。

@Database(version: 1, entities: [Memo])

当数据表结构发生变化时,就需要变更版本号指定新的版本。同时需要做如下处理:

Migration(this.startVersion, this.endVersion, this.migrate)

其中第一个参数为起始版本号,第二个参数为要迁移到的版本号,最后是一个迁移处理函数,函数定义为:Future Function(sqflite.Database database) migrate。我们要做的数据表变动就在这个函数里处理。

final database = await $FloorAppDatabase
    .databaseBuilder('app_database.db')
    .addMigrations([migration1to3, migration2to3])
    .build();

看起来非常简单数据库初始化,我们来看实际的例子。

版本升级实例

我们给之前的备忘录增加一个分类(category)字段,可以设置备忘录的分类,分类我们简单地固定为预设的几类。我们按照上面的步骤一步步编写代码即可。

@Database(version: 2, entities: [Memo])

@entity
class Memo {
  @PrimaryKey(autoGenerate: true)
  final int? id;
  String title;
  String content;
  @ColumnInfo(name: 'created_time')
  DateTime createdTime;
  @ColumnInfo(name: 'modified_time')
  DateTime modifiedTime;
  String? category;
  List<String> tags;

  Memo({
    this.id,
    required this.title,
    required this.content,
    required this.createdTime,
    required this.modifiedTime,
    this.category = '',
    required this.tags,
  });
}

final migration1to2 = Migration(12, (database) async {
  await database.execute('ALTER TABLE Memo ADD COLUMN category TEXT');
  // 可选,设置旧版本字段初始值
  await database.update('Memo',{'category'''});
});

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();

  final database = await $FloorMemoDatabase
      .databaseBuilder('app_database.db')
      .addMigrations([migration1to2]).build();

  final dao = database.memoDao;

  getIt.registerSingleton(dao, signalsReady: true);

  runApp(const MyApp());
}

flutter packages pub run build_runner build

当然,我们也需要对 UI 相关的代码进行变更,变更后的 UI 界面如下图所示。

危化库设计规范_数据库初始化_疾病库数据

总结

从代码量上来说,使用 floor 和直接使用 sqflite 处理版本迁移差不多。相比直接使用 sqflite 做数据库版本迁移数据库初始化,使用 floor 的好处是可以通过添加多个 Migration 对象支持多版本迁移。

运行效果如下,在“岛上码农”公众号回复“源码”可获取《Flutter入门与实战》专栏源码。

———END———
限 时 特 惠:本站每日持续更新海量各大内部创业教程,一年会员只需128元,全站资源免费下载点击查看详情
站 长 微 信:jiumai99

滚动至顶部