Flutter数据库生成插件realm_generator的使用

Flutter数据库生成插件realm_generator的使用

警告

我们宣布在2024年9月停止支持Atlas Device Sync + Realm SDKs。如果您需要没有同步功能的realm-dart版本，请安装版本20或查看community分支。

介绍

Realm 是一个直接运行在手机、平板或可穿戴设备上的移动数据库。该仓库包含用于Flutter™和Dart™的Realm SDK的源代码。

功能

• 移动端优先：Realm 是第一个从头开始构建以直接运行在手机、平板和可穿戴设备上的数据库。
• 简单：Realm 的面向对象数据模型易于学习，不需要ORM，并且API可以让您在几分钟内编写更少的代码来启动和运行应用程序。
• 现代：Realm 支持最新的Dart和Flutter版本，并具有健全的空安全机制。
• 快速：Realm 在常见操作中比原始SQLite更快，同时保持极其丰富的功能集。
• MongoDB Atlas Device Sync：可以轻松地在用户、设备和后端之间实时同步数据。您可以免费使用模板应用程序并创建云后端。

入门指南

1. 导入Realm

在Dart文件（如app.dart）中导入Realm包，并声明一个部分文件：

import 'package:realm/realm.dart';  // 导入realm包

part 'app.realm.dart'; // 声明一个部分文件

@RealmModel() // 定义一个名为`_Car`的数据模型类
class _Car {
  late String make;

  late String model;

  int? kilometers = 500;
}

2. 生成RealmObject类

从数据模型类_Car生成RealmObject类Car：

dart run realm generate

3. 打开Realm并添加对象

创建一个配置对象并打开一个Realm实例，然后添加一些对象：

var config = Configuration.local([Car.schema]);
var realm = Realm(config);

var car = Car("Tesla", "Model Y", kilometers: 5);
realm.write(() {
  realm.add(car);
});

4. 查询Realm中的对象

查询Realm中的对象并进行过滤：

var cars = realm.all<Car>();
Car myCar = cars[0];
print("My car is ${myCar.make} model ${myCar.model}");

cars = realm.all<Car>().query("make == 'Tesla'");

5. 获取查询结果的变化流

获取查询结果的变化流并监听变化：

final cars = realm.all<Car>().query(r'make == $0', ['Tesla']);
cars.changes.listen((changes) {
  print('Inserted indexes: ${changes.inserted}');
  print('Deleted indexes: ${changes.deleted}');
  print('Modified indexes: ${changes.modified}');
});
realm.write(() => realm.add(Car('VW', 'Polo', kilometers: 22000)));

示例代码

以下是一个完整的示例代码，展示了如何使用realm_generator生成Realm对象并在Flutter应用中使用它们。

catalog.dart

import 'package:realm/realm.dart';

part 'catalog.realm.dart';

// 定义一个数据模型类
@RealmModel()
class _Item {
  @PrimaryKey()
  late int id;

  late String name;

  int price = 42;
}

void main() {
  // 创建一个配置对象
  var config = Configuration.local([Item.schema]);

  // 打开一个Realm
  var realm = Realm(config);

  // 创建一个Item对象
  var myItem = Item(0, 'Pen', price: 4);

  // 打开一个写事务
  realm.write(() {
    realm.add(myItem);
    var item = realm.add(Item(1, 'Pencil')..price = 20);
  });

  // 对象`myItem`和`item`现在由Realm管理并持久化
  print("Added items to realm");

  // 读取对象属性
  print("Item name: ${myItem.name}");
  print("Item price: ${myItem.price}");

  // 更新对象属性
  realm.write(() {
    myItem.price = 20;
    myItem.name = "Special Pencil";
  });

  // 获取所有Item对象
  var items = realm.all<Item>();

  // 通过索引获取对象
  var item = items[1];

  // 通过主键获取对象
  var itemByKey = realm.find<Item>(0);

  // 过滤和排序对象
  var objects = realm.query<Item>("name == 'Special Pencil'");
  var name = 'Pen';
  objects = realm.query<Item>(r'name == $0', [name]);

  // 关闭Realm
  realm.close();
}

环境设置

1. 添加realm包

在Flutter应用中添加realm包：

flutter pub add realm

2. 安装所需的本地二进制文件

为运行Flutter小部件和单元测试，安装所需的本地二进制文件：

dart run realm install

3. 导入Realm

在Dart文件（如catalog.dart）中导入Realm包：

import 'package:realm/realm.dart';

4. 声明部分文件

在catalog.dart文件的开头声明一个部分文件catalog.realm.dart：

import 'dart:io';

part 'catalog.realm.dart';

5. 创建数据模型类

创建一个以下划线开头的数据模型类，并使用@RealmModel()注解：

@RealmModel()
class _Item {
  @PrimaryKey()
  late int id;

  late String name;

  int price = 42;
}

6. 生成RealmObject类

从数据模型类_Item生成RealmObject类Item：

dart run realm generate

生成的文件catalog.realm.dart将与catalog.dart文件相邻创建。请将生成的文件提交到源代码控制中。

使用Device Sync同步数据

1. 设置Atlas App Services

1. 在cloud.mongodb.com上创建一个账户。
2. 按照说明创建一个新的应用程序。
3. 配置适当的认证提供程序类型。
4. 启用Flexible Sync。
5. 复制新应用程序的App ID。

2. 使用Device Sync

1. 初始化App Services客户端并认证用户：

String appId = "<Atlas App ID>";
final appConfig = AppConfiguration(appId);
final app = App(appConfig);
final user = await app.logIn(Credentials.anonymous());

1. 打开一个同步的Realm：

final config = Configuration.flexibleSync(user, [Task.schema]);
final realm = Realm(config);

1. 添加同步订阅并写入数据：

realm.subscriptions.update((mutableSubscriptions) {
  mutableSubscriptions.add(realm.query<Task>(r'status == $0 AND progressMinutes == $1', ["completed", 100]));
});
await realm.subscriptions.waitForSynchronization();
realm.write(() {
  realm.add(Task(ObjectId(), "Send an email", "completed", 4));
  realm.add(Task(ObjectId(), "Create a meeting", "completed", 100));
  realm.add(Task(ObjectId(), "Call the manager", "init", 2));
});
realm.close();