更新日: 2015年5月7日
Swift & iOS

MagicalRecordをSwiftで使う導入〜設定までの手順

iOS 開発における Core Data のラッパーライブラリである MagicalRecord を、Swift で使うための手順です。導入から設定までを一通り。MagicalRecord は Objective-C 製のライブラリであるため、Swift から使うには Bridging Header の設定等を行う必要があります。

— 環境 —
Swift version 1.2
Xcode Version 6.3.1
MagicalRecord 2.2

【お知らせ】英単語を画像イメージで楽に暗記できる辞書サイトを作りました。英語学習中の方は、ぜひご利用ください！

画像付き英語辞書 Imagict | 英単語をイメージで暗記
【開発記録】
英単語を画像イメージで暗記できる英語辞書サービスを作って公開しました

Xcode 新規プロジェクトの作成

Create a new Xcode project から Xcode のプロジェクトを新規作成。

Screen Shot 2015-05-01 at 16.52.32

Use Core Data にチェックしておきます。今回は、TodoApp というプロジェクト名にしました。

CocoaPods で MagicalRecord をインストール

CocoaPods で MagicalRecord を入れる。
CocoaPodsの使い方、iOSライブラリの管理ツール | EasyRamble


$ cd /path/to/XcodeProject/TodoApp
$ pod init
$ vi Podfile
platform :ios, '8.3'
 
target 'SwiftToDo' do
  pod 'MagicalRecord'
end
 
target 'SwiftToDoTests' do
 
end
$ pod install
$ open TodoApp.xcworkspace

$ cd /path/to/XcodeProject/TodoApp

$ pod init

$ vi Podfile

platform :ios, '8.3'

target 'SwiftToDo' do

pod 'MagicalRecord'

end

target 'SwiftToDoTests' do

end

$ pod install

$ open TodoApp.xcworkspace

Xcode を起動すると ? マークが付いているファイル・フォルダがある。これは Git で add されていないものなので、Git の管理下にします。Pods フォルダは Git 管理から除外。


$ echo "Pods" >> .gitignore
$ git add .
$ git commit -m "pod install MagicalRecord"

$ echo "Pods" >> .gitignore

$ git add .

$ git commit -m "pod install MagicalRecord"

Xcode 再起動。


$ open TodoApp.xcworkspace

$ open TodoApp.xcworkspace

はてなマークが消えるはずです。

Swift から MagicalRecord を使うための Bridging Header 設定

TodoApp を右クリック → New File からファイルを新規作成します。

Screen Shot 2015-05-01 at 17.09.30

iOS → Source → Header File を選択。

Screen Shot 2015-05-01 at 17.16.48

TodoApp-Bridging-Header.h とファイル名を入力して作成。

Screen Shot 2015-05-01 at 17.17.22

作成した TodoApp-Bridging-Header.h を以下の通り編集します。

TodoApp-Bridging-Header.h

#ifndef TodoApp_TodoApp_Bridging_Header_h
#define TodoApp_TodoApp_Bridging_Header_h

#import "CoreData+MagicalRecord.h"

#endif

#ifndef TodoApp_TodoApp_Bridging_Header_h

#define TodoApp_TodoApp_Bridging_Header_h

#import "CoreData+MagicalRecord.h"

#endif

続いて Bridging Header の設定です。

TodoApp プロジェクトを選択 → Targets で TodoApp を選択 → Build Settings → All → Swift Compiler – Code Generation → Objective-C Bridging Header に先ほど作成した TodoApp-Bridging-Header.h のフルパスを指定します。

Objective-C Bridging Header の右横 TodoApp の下をダブルクリックすると、入力用フィールドが表示されます。

Screen Shot 2015-05-01 at 17.22.49

Screen Shot 2015-05-01 at 17.23.13

TodoApp-Bridging-Header.h へのフルパスを入力します。

AppDelegate.swift で MagicalRecord 初期化の設定

AppDelegate.swift を以下のように編集します。編集するメソッドは2つ。

AppDelegate.swift

func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
    // for magical record - initialize coredata
    MagicalRecord.setupCoreDataStackWithAutoMigratingSqliteStoreNamed("TodoApp.sqlite")
    return true
}

func applicationWillTerminate(application: UIApplication) {
    // for magical record - clean up coredata
    MagicalRecord.cleanUp()
}

func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {

// for magical record - initialize coredata

MagicalRecord.setupCoreDataStackWithAutoMigratingSqliteStoreNamed("TodoApp.sqlite")

return true

}

func applicationWillTerminate(application: UIApplication) {

// for magical record - clean up coredata

MagicalRecord.cleanUp()

}

モデルのエンティティを作成

モデルのエンティティを作成。TodoApp.xcdatamodeld を選択し、下部の Add Entitiy をクリックして追加。モデル名を Todo にしました。また Attributes の下の＋をクリックして属性を追加、名前は item で、型は String を指定。

Screen Shot 2015-05-01 at 19.17.04

NSManagedObject Subclass 用のファイルを作成

TodoApp.xcdatamodeld を選択した状態で、Editor → Create NSManagedObject Subclass をクリック。以下画像の手順に従って進めます。

Screen Shot 2015-05-01 at 19.18.46

チェックが入っていることを確認。

Screen Shot 2015-05-01 at 19.19.22

チェックが入っていることを確認。

Screen Shot 2015-05-01 at 19.19.36

TodoApp の Group に作成。

Screen Shot 2015-05-01 at 19.20.47

モデル用ファイルである Todo.swift が作成されるので、確認して @objc(Todo) を追加する。

Todo.swift

import Foundation
import CoreData

@objc(Todo)
class Todo: NSManagedObject {

    @NSManaged var item: String

}

import Foundation

import CoreData

@objc(Todo)

class Todo: NSManagedObject {

@NSManaged var item: String

}

以上で、MagicalRecord から Todo という名前のモデルを操作できるようになります。MagicalRecord を使っての具体的な CRUD 操作（Create, Read, Update, Delete）についてはまたの機会。

Swift は次に習得したい言語No1です！

本気ではじめるiPhoneアプリ作り Xcode 7.x+Swift 2.x対応黒帯エンジニアがしっかり教える基本テクニック (ヤフー黒帯シリーズ)

詳解 Swift 改訂版

>> 次の記事 : SwiftのOptional型（Optional Type）に関するまとめ

<< 前の記事 : CocoaPodsの使い方、iOSライブラリの管理ツール