Flutter通用功能插件neuro_realm_common的使用

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

注意：该项目处于 Alpha 阶段。所有 API 可能会在不提前通知的情况下更改，且稳定性无法保证。请勿在生产环境中使用。

开始使用

要将 Realm SDK 添加到 Flutter 项目中，请将以下内容添加到 pubspec.yaml 文件的依赖项部分：

dependencies:
  neuro_realm: ^x.x.x  # 替换为最新版本号

然后运行以下命令以获取依赖项：

flutter pub get

接下来，我们通过一个完整的示例来展示如何使用该插件。

1. 导入 Realm

在项目中导入 Realm：

import 'package:neuro_realm/realm.dart';

2. 定义数据模型类

创建一个数据模型类 _Car，并使用 [@RealmModel](/user/RealmModel)() 注解标记它：

[@RealmModel](/user/RealmModel)()
class _Car {
  late String make;       // 制造商
  late String model;      // 型号
  int? kilometers = 500;  // 行驶公里数
}

3. 生成 RealmObject 类

从数据模型类 _Car 自动生成对应的 Car 类：

dart run realm generate

这将在项目中生成一个名为 Car 的类。

4. 打开 Realm 并添加对象

打开 Realm 数据库，并向其中添加一些对象：

void main() {
  // 配置 Realm
  var config = Configuration([Car.schema]);

  // 打开 Realm 数据库
  var realm = Realm(config);

  // 创建一个汽车对象
  var car = Car("Tesla", "Model Y", kilometers: 5);

  // 开启事务并添加对象
  realm.write(() {
    realm.add(car);
  });

  print("汽车已成功添加到 Realm 中！");
}

5. 查询 Realm 中的对象

查询 Realm 数据库中的对象，并打印结果：

void queryCars() {
  // 获取所有汽车对象
  var cars = realm.all<Car>();

  // 打印第一辆汽车的信息
  if (cars.isNotEmpty) {
    Car myCar = cars[0];
    print("我的汽车是 ${myCar.make} 型号 ${myCar.model}");
  }

  // 查询特定制造商的汽车
  cars = realm.all<Car>().query("make == 'Tesla'");

  print("查询结果数量: ${cars.length}");
}

完整示例代码

以下是完整的示例代码，展示了如何定义模型、插入数据和查询数据：

import 'package:neuro_realm/realm.dart';

// 定义数据模型
[@RealmModel](/user/RealmModel)()
class _Car {
  late String make;
  late String model;
  int? kilometers = 500;
}

void main() {
  // 配置 Realm
  var config = Configuration([Car.schema]);

  // 打开 Realm 数据库
  var realm = Realm(config);

  // 创建并插入汽车对象
  realm.write(() {
    var car = Car("Tesla", "Model Y", kilometers: 5);
    realm.add(car);
  });

  print("汽车已成功添加到 Realm 中！");

  // 查询所有汽车
  var cars = realm.all<Car>();
  if (cars.isNotEmpty) {
    Car myCar = cars[0];
    print("我的汽车是 ${myCar.make} 型号 ${myCar.model}");
  }

  // 查询特定制造商的汽车
  cars = realm.all<Car>().query("make == 'Tesla'");
  print("查询结果数量: ${cars.length}");
}