AWA with Realm (iOS)

೾ށ ༐ೋ [Yuji Hato] INTRODUCTION ࣗݾ঺հ System Engineerͱͯ͠SIerΛܦͯɺ2011೥αΠ όʔΤʔδΣϯτʹೖࣾɻ ෳ਺ͷAmebaαʔϏεʹͯɺαʔόαΠυ/ Android/iOSΛ୲౰͠ɺݱࡏ͸AWAͷiOSΤϯδ χΞɻ Engineer 5XJUUFSIUUQTUXJUUFSDPNEFLBUPUPSP (JU)VCIUUQTHJUIVCDPNEFLBUPUPSP

ࠓ೔͸ Realmʹؔͯ͠ͷ࢖͍ํ΍Tips͸༷ʑͳํ͕঺ հ͍ͯ͠ΔͷͰɺRealmΛ࢖ͬͨΞϓϦέʔ γϣϯશମͷઃܭͷ঺հΛ͠·͢

Agenda ɾRealmΛ࢖͏໨త ɾApplication Architecture ɾͳͥRealm͔ ɾAWAͱ͸ ɾCoding Topics ɾOther Topics

No content

༸ָɾ๜ָ໰Θͣɺ͍ͭͰ΋Ͳ͜Ͱ΋޷͖ͳָ͚ͩ͠Ή͜ͱ͕Ͱ͖Δ ֹ݄ఆ੍ֹͷԻָετϦʔϛϯάαʔϏε

ͳͥRealm͔

ͳͥ3FBMN͔

ͳͥ3FBMN͔ ɾϞσϧ/ϦϨʔγϣϯ͕ΫϥεఆٛͰΒ͘ ɾύϑΥʔϚϯε͕Α͍ ɾΫϩεϓϥοτϑΥʔϜͰAndroid ɹಉ͡ઃܭ͕Ͱ͖Δ ɾRealm࢖ͬͯΔͱ͔ͬ͜Αͦ͞͏ ɾυΩϡϝϯτͷॆ࣮ & αϙʔτ

RealmΛ࢖͏໨త

3FBMNΛ࢖͏໨త ɾετϨεϑϦʔͳUI/UXͷ࣮ݱ ɾ௨৴ྔͷ࡟ݮ ɾදࣔ଎౓/ύϑΥʔϚϯεͷ޲্

Application Architecture

αʔόʔ ΫϥΠΞϯτ ΫϥΠΞϯτͱαʔό ͷσʔλಉظ Application Architecture

αʔόʔ ΫϥΠΞϯτ Dataͷࠩ෼ߋ৽/ มߋνΣοΫ Application Architecture ࠩ෼ͷΈ

αʔόʔ ΫϥΠΞϯτ ΦϯσϚϯυอଘ Application Architecture ඞཁʹͳͬͨΒ औಘ

Application Design

ͦͷ·͑ʹ… AWA͸Objective-CͰ࣮૷͍ͯ͠·͢ ઈࢍSwiftॻ͖׵͑த ※Bolts-iOSΛ࢖༻͍ͯ͠·͢

Application Design API Server Realm View ViewController Service

Models Modelͷఆٛ

Models @interface EntityHoge : RLMObject @property NSString *hogeId; @property NSString *name; @property NSInteger updatedAt; @property NSInteger storedAt; // Finders + (EntityHoge *) findById: (NSString *) hogeId; @end @implementation EntityHoge + (NSString *)primaryKey { return @"hogeId"; } + (EntityHoge *) findById:(NSString *)hogeId { RLMRealm *realm = [RealmManager realm]; EntityHoge *hoge = [self objectInRealm:realm forPrimaryKey:hogeId]; return hoge; } @end ModelΫϥεʹFinderͳͲ΋ఆ͓ٛͯ͘͠ͱศརɻ

Service RealmObjectΛѻ͏ServiceΛఆٛ

Service @implementation HogeService - (EntityHoge *)read: (NSString *)hogeId { [[RealmManager realm] refresh]; return [EntityHoge findById:hogeId]; } - (BFTask *)fetch:(NSString *)hogeId withModifiedSince:(NSInteger)modifiedSince { return [[APIClient hogeData:hogeId modifiedSince:modifiedSince] continueWithExecutor: [RealmManager writeExecutor] withSuccessBlock:^id(BFTask *task) { // APIͷ໭ΓΛνΣοΫͯࠩ͠෼ΛRealmʹॻ͖ࠐΈ EntityHoge *hoge = [DataConverter toHoge:task.result]; [RealmManager commit:^(RLMRealm *realm) { [realm addOrUpdateObject:hoge]; }]; }]; } @end ServiceʹreadɺfetchͳͲܾ·ͬͨIFΛ༻ҙ͢Δ͜ͱͰѻ͍΍͘͢ͳΔɻ ߋ৽೔࣌Λ౉͢͜ͱͰAPI͔Β͸มߋ/ࠩ෼σʔλͷΈΛऔಘͯ͠Realmʹอଘɻ read͸εϨουΛލ͙͜ͱΛߟྀͯ͠ຖճrefreshΛݺͼग़͔ͯ͠Βऔಘɻ

ViewController ViewController͔Β͸ServiceΛ௨ͯ͠ RealmΛૢ࡞

ViewController @property (nonatomic, strong) EntityHoge *hoge; - (void)loadFromRealm { self.hoge = [[HogeService shared] read:self.hogeId]; if (!self.hoge) { // no cache return; } // Show cache } - (void)loadFromAPI { NSInteger modifiedSince = (self.hoge) ? self.hoge.updatedAt : 0; [[[HogeService sharedService] fetch:self.hogeId withModifiedSince:modifiedSince] continueWithExecutor:[BFExecutor mainThreadExecutor] withBlock:^id(BFTask *task) { // Realm͔Βऔಘ͠௚ͯ͠ViewΛߋ৽ [self loadFromRealm]; return nil; }]; } Realmʹσʔλ͕͋Δ৔߹͸ɺAPIʹมߋ೔Λ౉ͯ͠มߋ/ࠩ෼σʔλͷΈऔಘͯ͠ ߋ৽͕͋ͬͨσʔλͷΈViewΛߋ৽͢Δɻ Bolts͸ඇಉظॲཧΛϝιουνΣʔϯͰهड़Ͱ͖ɺThread΋ࢦఆͰ͖ΔͷͰRealmΛ ѻ͍΍͍͢ɻNotification͸࢖ͬͯͳ͍ɻ

Other Topics

RLMRealm 3FBMNͷQBUIɺॳظԽɺ3FBMNΠϯελϯεͷऔಘɺ.JHSBUJPOɺ8SJUF༻ εϨουRVFVFऔಘͳͲ͸XSBQQFSDMBTTΛ࡞ͬͯవΊ͓ͯ͘ͱΑ͍ … + (void)prepareRealms { static dispatch_once_t once; dispatch_once(&once, ^{ defaultDataPath = [RealmManager dataRealmPath:kRealmDataFileName]; defaultCachePath = [RealmManager cacheRealmPath:kRealmCacheFileName]; [RLMRealm setDefaultRealmPath:defaultCachePath]; [RLMRealm setDefaultRealmSchemaVersion:kCurrentSchemeVersion withMigrationBlock:^(RLMMigration *migration, uint64_t oldSchemaVersion) { }]; [RLMRealm defaultRealm]; }); } + (RLMRealm *) realm { return [RLMRealm defaultRealm]; } …

Notifications Realmͷσʔλมߋ࣌ʹॲཧ͕Ͱ͖·͕͢ Notificationsͷৄࡉ৘ใ͕ͳ͍ͷͰɺ͖Ίࡉ΍ ͔ͳUI੍ޚ͕Ͱ͖ͳ͍ͨΊ࢖͍ͬͯͳ͍ @property(nonatomic, strong) RLMNotificationToken *token; … self.token = [[LVPRealms realm] addNotificationBlock:^(NSString *note, RLMRealm * realm) { // updateUI }];

Migration ςʔϒϧ࠶ߏஙॲཧ͔͔ͳ͍ͱ͍͚ͳ͍ͷͰɺ Ϟσϧ͕େ෯ʹมߋʹͳΔΑ͏ͳ৔߹͸ͭΒ ͍… ࠓͷͱ͜ΖSchemaVersion্͛Δ͚ͩͰࡁΜͰ ͍Δ

Compaction ϝϞϦܥͷCrashϩά͕૿Ճ͖ͯͨ͠ͷͰதؒ ςʔϒϧͷංେԽΛݒ೦ ̍೔Ҏ্ܦ͍ͬͯͨΒCompactionΛ࣮ߦ͍ͯ͠Δ

·ͱΊ ɾෳࡶͳσʔλΛେྔʹѻ͏ΞϓϦͰΩϟο ɹγϡ༻్ͱͯ͠૬ੑ͕ྑ͍ ɾRealm ͱ Bolts ͸ҙ֎ʹ૬ੑ͕Α͍ ɾΫϥΠΞϯτʹσʔλอଘ͢Δ৔߹͸ ɹαʔόؚΊͨΞϓϦέʔγϣϯશମͷ ɹઃܭ͕େࣄ ɾRealmνʔϜͷαϙʔτ͕ް͍

THANK YOU!