Realm使用记录

realm_logo.jpg

Realm简介

Realm是一个跨平台的移动数据库引擎，目前支持iOS、Android平台，同时支持Objective-C、Swift、Java、React Native、Xamarin等多种编程语言。Realm并不是对SQLite或者CoreData的简单封装, 是由核心数据引擎C++打造，是拥有独立的数据库存储引擎，可以方便、高效的完成数据库的各种操作。

官方文档：https://realm.io

GitHub：https://github.com/realm/realm-cocoa

Realm Studio: https://realm.io/cn/products/realm-studio

安装

npm install --save realm

react-native版本大于等于0.60

cd ios & pod install

react-native版本小于0.60

react-native link realm

安卓端可能使用 link 无效，这时可以进行以下步骤：

在 android/setting.gradle 内添加:

include ':realm'
project(':realm').projectDir = new File(rootProject.projectDir, '../node_modules/realm/android')

在android/app/build.gradle增加依赖库

// When using Android Gradle plugin 3.0 or higher
dependencies {
  implementation project(':realm')
}

// When using Android Gradle plugin lower than 3.0
dependencies {
  compile project(':realm')
}

在MainApplication.java中导入并且链接package

import io.realm.react.RealmReactPackage; // add this 

import public class MainApplication extends Application implements ReactApplication {
    @Override
    protected List getPackages() {
        return Arrays.asList(
            new MainReactPackage(),
            new RealmReactPackage() // add this line
        );
    }
}

建立model

通过schema定义的模型会在realm初始化的时候加入realm数据库中，每个schema都有一个name字段定义的名字、primaryKey为主键以及其他属性。

// 定一个car
const CarSchema = {
  name: 'Car',
  properties: {
    make:  'string',  // 字符类型
    model: 'string',  // 字符类型
    miles: {type: 'int', default: 0}, // 数字类型，并且初始值为0
  }
};

支持的类型

Realm支持的基本类型有：bool, int, float, double, string, data, and date

bool 对应JavaScript中的boolean
int, float, double 对应JavaScript中的 number
string 对应JavaScript中的 string
data 对应JavaScript中的ArrayBuffer
date 对应JavaScript中的 Date

主键

通过设置一个string或者int类型的值作为model的主键

const BookSchema = {
  name: 'Book',
  primaryKey: 'id',
  properties: {
    id:    'int',    // primary key
    title: 'string',
    price: 'float'
  }
};

可选属性

Realm的基本类型是非可选的，并且不可以存储null以及undefined。但是可以在属性定义中添加可选的指示符?来使属性成为可选属性。

const PersonSchema = {
  name: 'Person',
  properties: {
    realName:    'string', // required property
    displayName: 'string?', // optional property
    birthday:    {type: 'date', optional: true}, // optional property
  }
};

设置默认值

通过default字段为属性添加一个默认值

const CarSchema = {
  name: 'Car',
  properties: {
    make:  {type: 'string'},
    model: {type: 'string'},
    drive: {type: 'string', default: 'fwd'},
    miles: {type: 'int',    default: 0}
  }
};

数组

除了存储单个值之外，还可以将属性声明为任何受支持的基本类型的列表。这是通过在类型名称后附加[]来完成

const PersonSchema = {
  name: 'Person',
  properties: {
    name: 'string',
    testScores: 'double?[]'  // 一个存储double类型的数组
  }
};

const PersonSchema = {
  name: 'Person',
  properties: {
    name:     'string',
    birthday: 'date',
    cars:     'Car[]'  // 一个存储Car对象的数组
    picture:  'data?', // optional property
  }
};

初始化Realm

Realm.open({schema: [Car, Person]})
  .then(realm => {
    // ...use the realm instance here
  })
  .catch(error => {
    // Handle the error here if something went wrong
  });

通过realm中的open方法以及定义好的models，即可快速的创建并打开数据库。

当然也可以通过创建realm实例打开

const realm = new Realm({schema: [PersonSchema]});

增

对域中对象的更改、创建、更新和删除，必须在write事务块中进行。
需要注意：写入事务具有不可忽略的开销，应该尽量减少代码中写入块的数量。

try {
  realm.write(() => {
    realm.create("Hello", {
      uid: "a371d56d7b6f77ba31f71d22",
      name: "名字1",
      phone: "137xxxxxxxx"
    });
    realm.create("Hello", {
      uid: "a371d56d7b6f77ba31f71d22",
      name: "名字1",
      phone: "137xxxxxxxx"
    });
    // ...
  });
catch(e) {
  console.log("Error on creation");
}

删

通过delete方法删除，必须在write事务块中进行。

realm.write(() => {
  // Create a book object
  let book = realm.create('Book', {id: 1, title: 'Recipes', price: 35});

  // Delete the book
  realm.delete(book);

  // Delete multiple books by passing in a `Results`, `List`,
  // or JavaScript `Array`
  let allBooks = realm.objects('Book');
  realm.delete(allBooks); // Deletes all books
});

改

在创建方法后面添加参数true即可

  realm.write(() => {
    realm.create("Hello", {
      uid: "a371d56d7b6f77ba31f71d22",
      name: "名字1",
      phone: "137xxxxxxxx"
    }, true);
  });

查

通过model的名称查找数据

const dogs = realm.objects('Dog'); // retrieves all Dogs from the Realm

返回Dog中的所有数据，或者通过filtered查找指定数据

const tanDogs = dogs.filtered('color = "tan" AND name BEGINSWITH "B"');

Realm Studio

Realm Studio是Realm数据库的可视化工具，通过Realm Studio下载，支持Windows、Linux、Mac OS系统，下载打开之后

realm-studio-logo.png

点击Open Realm file 选中需要打开的数据库即可，是以realm为后缀的文件

找到realm文件

如果是在iOS模拟器上，那么可以到以下路径查找

/Users/你的名字/Library/Developer/CoreSimulator/Devices/2AAE2917-8519-4024-BAE7-3A59F124691E/data/Containers/Data/Application/0EE00136-357D-46F8-B709-2BAA1DDF8909/Documents

如果是在iOS真机上，可以在Xcode中的Devices and Simulator查找

常见问题

Realm安装不上

React Native 0.31.0 and later is supported.
Node version 8.3.0 (and later versions in 8.x) and 10.x are supported.

仅支持React Native 0.31.0及以上
仅支持node 8.3.0及以上或者10.x

realm-sync-cocoa下载失败

realm-sync-cocoa.png

首次运行时，如果出现长时间卡在编辑阶段，打开Xcode发现一直在下载realm-sync-cocoa-4.9.2.tar.gz
该文件大概有100M以上，翻墙效果依旧不明显

手动下载realm-sync-cocoa-4.9.2.tar.gz
打开/node_modules/realm/scripts/download-realm.js文件，并找到以下代码

function generateRandomString() {
    // return crypto.randomBytes(20).toString('hex');
    return 'realm';  
}
// 该方法是返回一个20位随机字符串作为下载的文件夹名，每次启动下载realm-sync-cocoa任务的时候，都会先创建一个文件夹，并将下载到该文件夹中，这里将文件夹名称改成固定名称，目的是把手动下载好的文件直接放入。

修改之后重新编译一下，就会生成一个realm文件夹

在命令行输入getconf DARWIN_USER_TEMP_DIR获取下载缓存路径，并把手动下载好的文件，放入realm中
清空项目并且编译即可成功

参考资料

移动数据库 Realm 在 React-Native 的使用详解
realm.io