Takahiro Octopress Blog

-1から始める情弱プログラミング

SwiftでRealmを使ってみよう!

| Comments

Realmをプロジェクトに追加しよう

本日は最近、流行っているRealmについて遊んでみたいと思います。
まずは導入の仕方から見て行きましょう!

Realmの導入方法

下記のPodfileを作成しましょう。
本記事のSwiftプロジェクトとして、SwiftRealm.xcodeprojを作成します。

1
2
3
4
5
6
7
8
9
10
11
// Podfile
platform :ios, '8.0'
source 'https://github.com/CocoaPods/Specs.git'

target 'SwiftRealm', exclusive: true do
  pod 'Realm'
end

target 'SwiftRealmTests', exclusive: true do
  pod 'Realm/Headers'
end

あとはpod installしましょう。
すると、SwiftRealm.xcworkspaceが作成されるので、Xcodeで起動しましょう。

Realmを追加した結果

なんと、Objective-C++で書かれていますね! Swiftで利用するためにはBridging-Headerファイルの設定を行う必要があります。

SwiftRealm-Bridging-Header.hを作成します。
ヘッダーファイルの作成

TARGETS > SwiftRealm > Build Settings > Swift Compiler – Code Generation > Objective-C Bridging Header にパスを設定します。
パスの設定

SwiftRealm-Bridging-Header.hの中身を書きます。

1
2
3
4
5
6
#ifndef SwiftRealm_SwiftRealm_Bridging_Header_h
#define SwiftRealm_SwiftRealm_Bridging_Header_h

#import <Realm/Realm.h>

#endif

これでRealmを利用する準備が整いました。
実際にコードを書いていきましょう。

保存オブジェクトの生成

Realmでは保存する対象をRLMObjectとして作成します。
SQLiteでいうところのテーブルを生成しているイメージでしょうか。

今回は練習としてEngineer.swift内でEngineerクラスを作ってみました。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
// Engineer.swift

// Engineerクラス
class Engineer:RLMObject {
  // プロパティと初期値の設定
  dynamic var id:Int = 0
  dynamic var level:Int = 0
  dynamic var businessTitle:String = ""
  dynamic var skills = RLMArray(objectClassName: "Skills")
  dynamic var created:Double = 0
  dynamic var updated:Double = 0

  // プライマリーキーの設定
  override class func primaryKey() -> String? {
      return "id"
  }

  // インデックスの設定
  override class func indexedProperties() -> [AnyObject]? {
      return ["level"]
  }
}

// Skillsクラス
class Skills: RLMObject {
      dynamic var skill:String = ""
}

ポイントとしては、skillsのように配列の形で1つの要素に複数の値を割り当てたい場合は、それ単体で別にRLMObjectの拡張クラスを作成する必要があります。
RLMArrayを初期化することは許可されていないためです。

オブジェクトのインサート/アップデート

続いて、先ほど生成したオブジェクトをインサート/アップデートしてみましょう。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
// ViewController.swift
import UIKit

class ViewController: UIViewController {

  override func viewDidLoad() {
      super.viewDidLoad()

      // id=0のオブジェクトを検索
      if let engineer = Engineer(forPrimaryKey: 0) {
          // 検索結果がある場合
          println("既にエンジニアが1人います。\(engineer)")

          // アップデート
          let realm = RLMRealm.defaultRealm()
          // 書込みの開始
          realm.beginWriteTransaction()
          // Skillsクラスをインスタンス化
          let skills = Skills()
          // 要素を設定
          skills.skill = "Objective-C"
          // 既存のデータに要素を追加
          engineer.skills.addObject(skills)
          engineer.updated = NSDate().timeIntervalSince1970
          // データのアップデート処理
          realm.addOrUpdateObject(engineer)
          // 書込みの終了
          realm.commitWriteTransaction()
      } else {
          // 検索結果がない場合
          // Engineerクラスをインスタンス化
          let newEngineer = Engineer()
          newEngineer.id = 0
          newEngineer.level = 0
          newEngineer.businessTitle = "新米エンジニア"
          // Skillsクラスをインスタンス化
          let skills = Skills()
          skills.skill = "Swift"
          newEngineer.skills.addObject(skills)
          newEngineer.created = NSDate().timeIntervalSince1970

          // データの新規作成
          let realm = RLMRealm.defaultRealm()
          // 書込みの開始
          realm.beginWriteTransaction()
          // データのインサート処理
          realm.addObject(newEngineer)
          // 書込みの終了
          realm.commitWriteTransaction()
      }
  }

  override func didReceiveMemoryWarning() {
      super.didReceiveMemoryWarning()
  }
}

ここでは、id=0のデータを検索して、見つからない場合は新規データをインサートし、見つかった場合はデータのアップデートをしています。
書込みにはトランザクションブロックを使った方法もあるようですが、今回はbeginWriteTransactioncommitWriteTransactionを利用しました。

データの確認

では、データを作成した後に、そのデータを確認したい場合はどうすれば良いのでしょうか?
実はMac専用のアプリが提供されています。

こちらのサイトRealm Browser の項目からインストールしましょう。

Realm Browserを使えば、下記のようにデータを見ることができます。

Realm Browserで確認1
Realm Browserで確認2

これからSQLiteよりもRealmの方がスタンダートな保存方法となることでしょう。
どんどん使い方を勉強していかなくては!!
と言ったところで本日はここまで。

Comments