realm_logo.jpg

Realm簡介

Realm是一個跨平臺的移動數(shù)據(jù)庫引擎，目前支持iOS、Android平臺，同時支持Objective-C、Swift、Java、React Native、Xamarin等多種編程語言。Realm并不是對SQLite或者CoreData的簡單封裝, 是由核心數(shù)據(jù)引擎C++打造，是擁有獨(dú)立的數(shù)據(jù)庫存儲引擎，可以方便、高效的完成數(shù)據(jù)庫的各種操作。

官方文檔：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 無效，這時可以進(jìn)行以下步驟：

在 android/setting.gradle 內(nèi)添加:

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中導(dǎo)入并且鏈接package

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

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

建立model

通過schema定義的模型會在realm初始化的時候加入realm數(shù)據(jù)庫中，每個schema都有一個name字段定義的名字、primaryKey為主鍵以及其他屬性。

// 定一個car
const CarSchema = {
  name: 'Car',
  properties: {
    make:  'string',  // 字符類型
    model: 'string',  // 字符類型
    miles: {type: 'int', default: 0}, // 數(shù)字類型，并且初始值為0
  }
};

支持的類型

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

• bool 對應(yīng)JavaScript中的boolean
• int, float, double 對應(yīng)JavaScript中的 number
• string 對應(yīng)JavaScript中的 string
• data 對應(yīng)JavaScript中的ArrayBuffer
• date 對應(yīng)JavaScript中的 Date

主鍵

通過設(shè)置一個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
  }
};

設(shè)置默認(rèn)值

通過default字段為屬性添加一個默認(rèn)值

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

數(shù)組

除了存儲單個值之外，還可以將屬性聲明為任何受支持的基本類型的列表。 這是通過在類型名稱后附加[]來完成

const PersonSchema = {
  name: 'Person',
  properties: {
    name: 'string',
    testScores: 'double?[]'  // 一個存儲double類型的數(shù)組
  }
};

const PersonSchema = {
  name: 'Person',
  properties: {
    name:     'string',
    birthday: 'date',
    cars:     'Car[]'  // 一個存儲Car對象的數(shù)組
    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，即可快速的創(chuàng)建并打開數(shù)據(jù)庫。

當(dāng)然也可以通過創(chuàng)建realm實(shí)例打開

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

增

對域中對象的更改、創(chuàng)建、更新和刪除，必須在write事務(wù)塊中進(jìn)行。
需要注意：寫入事務(wù)具有不可忽略的開銷，應(yīng)該盡量減少代碼中寫入塊的數(shù)量。

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事務(wù)塊中進(jìn)行。

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
});

改

在創(chuàng)建方法后面添加參數(shù)true即可

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

查

通過model的名稱查找數(shù)據(jù)

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

返回Dog中的所有數(shù)據(jù)，或者通過filtered查找指定數(shù)據(jù)

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

Realm Studio

Realm Studio是Realm數(shù)據(jù)庫的可視化工具，通過Realm Studio下載，支持Windows、Linux、Mac OS系統(tǒng)，下載打開之后

realm-studio-logo.png

點(diǎn)擊Open Realm file 選中需要打開的數(shù)據(jù)庫即可，是以realm為后綴的文件

找到realm文件

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

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

如果是在iOS真機(jī)上，可以在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

首次運(yùn)行時，如果出現(xiàn)長時間卡在編輯階段，打開Xcode發(fā)現(xiàn)一直在下載realm-sync-cocoa-4.9.2.tar.gz
該文件大概有100M以上，翻墻效果依舊不明顯

1. 手動下載realm-sync-cocoa-4.9.2.tar.gz
2. 打開/node_modules/realm/scripts/download-realm.js文件，并找到以下代碼

function generateRandomString() {
    // return crypto.randomBytes(20).toString('hex');
    return 'realm';  
}
// 該方法是返回一個20位隨機(jī)字符串作為下載的文件夾名，每次啟動下載realm-sync-cocoa任務(wù)的時候，都會先創(chuàng)建一個文件夾，并將下載到該文件夾中，這里將文件夾名稱改成固定名稱，目的是把手動下載好的文件直接放入。

修改之后重新編譯一下，就會生成一個realm文件夾

3. 在命令行輸入getconf DARWIN_USER_TEMP_DIR獲取下載緩存路徑，并把手動下載好的文件，放入realm中
4. 清空項(xiàng)目并且編譯即可成功

參考資料

• 移動數(shù)據(jù)庫 Realm 在 React-Native 的使用詳解
• realm.io