Session 227 - Using iCloud with Core Data

Transcript

1. These are confidential sessions—please refrain from streaming, blogging, or taking pictures Session 227 Using iCloud with Core Data Adam Swift Senior Software Engineer
2. Introduction •Take app from idea to iCloud •Beyond the API •Real-world strategies
4. Sample Code https://developer.apple.com/wwdc/schedule/details.php?id=227
5. Before We Begin…
6. Core Data Persistent Store
7. Core Data Persistent Store Managed Object Context
8. Core Data + iCloud
9. Core Data + iCloud
10. Core Data + iCloud
11. Core Data iCloud Features •Per record conflict resolution •Three-way merge
12. Three-Way Merge Preserve changes between systems John Doe john@.com
13. Three-Way Merge Preserve changes between systems Johnny Doe john@.com John Doe john@.com
14. Three-Way Merge Preserve changes between systems Johnny Appleseed john@.com Johnny Doe john@.com John Doe john@.com
15. Three-Way Merge Preserve changes between systems John Doe johnny@.com Johnny Appleseed john@.com Johnny Doe john@.com John Doe john@.com
16. Three-Way Merge Preserve changes between systems John Doe johnny@.com Johnny Appleseed john@.com Johnny Doe john@.com John Doe john@.com Johnny Appleseed johnny@.com
17. Core Data iCloud Features •Transfer incremental changes •Asynchronous import •Lightweight schema migration
18. What You Need •Xcode and OS X/iOS SDK ▪ Core Data project template (or Sample Code) ▪ iCloud Entitlements
19. What You Need •Xcode and OS X/iOS SDK ▪ Core Data project template (or Sample Code) ▪ iCloud Entitlements •Provisioning Portal ▪ App ID for iCloud ▪ Provisioning Profile
20. Launch Lifecycle Design
21. Launch Lifecycle Design
22. User Expectations •What data in iCloud? •Consider the variables ▪ Network ▪ Account ▪ Data
23. Where Does the Data Go? •Different types of apps •Where does app data live? ▪ All in iCloud ▪ Some in iCloud, some local
24. Where Does the Data Go? •Different types of apps •Where does app data live? ▪ All in iCloud ▪ Some in iCloud, some local
25. •Data goes into iCloud What Goes into iCloud? Persistent Store
26. •Data goes into iCloud •Not Persistent Store file! What Goes into iCloud? Persistent Store Never open an SQLite database in iCloud
27. •Data goes into iCloud •Not Persistent Store file! •Data transferred as incremental changes via iCloud What Goes into iCloud? Persistent Store
28. Persistent Store as Cache •Data in iCloud •Access via Persistent Store •Rebuild from data in iCloud
29. Persistent Store as Cache •Data in iCloud •Access via Persistent Store •Rebuild from data in iCloud Persistent Store
30. Fallback Store
31. Fallback Store •No iCloud account? ▪ Provide seamless app experience ▪ Create local ‘fallback’ store
32. Fallback Store •No iCloud account? ▪ Provide seamless app experience ▪ Create local ‘fallback’ store •Existing store (pre-iCloud app version)
33. Fallback Store •No iCloud account? ▪ Provide seamless app experience ▪ Create local ‘fallback’ store •Existing store (pre-iCloud app version) •Move store data into iCloud when enabled
34. •Your decision •Determined by access needs ▪ Access requires iCloud account? ▪ Or, allow read-only access without account? iCloud-Enabled Store Location
35. Requires iCloud account for access Put Store in iCloud Container
36. Requires iCloud account for access Put Store in iCloud Container
37. Requires iCloud account for access Put Store in iCloud Container
38. Requires iCloud account for access Put Store in iCloud Container •In container, but .nosync not transferred to iCloud
39. Requires iCloud account for access Put Store in iCloud Container •In container, but .nosync not transferred to iCloud •Removed when the account changes ▪ Rebuild store from iCloud data
40. Requires iCloud account for access Put Store in iCloud Container •In container, but .nosync not transferred to iCloud •Removed when the account changes ▪ Rebuild store from iCloud data •Simple ▪ Guaranteed to match “ubiquitous content” ▪ No iCloud? No store
41. Keep Store in Sandbox Allows read-only access without account
42. Keep Store in Sandbox •Persistent store in App Sandbox, data in iCloud •Store file survives account changes •One store per-iCloud account •Read-only access without account! ▪ Use NSReadOnlyPersistentStoreOption ▪ Optionally move data to fallback store Allows read-only access without account
43. Partition Data •Two Persistent Stores ▪ One for local device data ▪ One enables data in iCloud •Use different models or configurations Local Store iCloud Enabled
44. •Subset of entities from a data model •Create store with configuration ▪ Includes only those entities •One context can access stores with different configurations (based on the same model) Model Configurations “LocalConfig” “CloudConfig”
45. •Subset of entities from a data model •Create store with configuration ▪ Includes only those entities •One context can access stores with different configurations (based on the same model) Model Configurations “LocalConfig” “CloudConfig”
46. Configurations in Data Model
47. Configurations in Data Model
48. Configurations in Data Model
49. Configurations in Data Model
50. Configurations in Data Model
51. Configurations in Code cloudStore = [psc addPersistentStoreWithType: NSSQLiteStoreType configuration: @”CloudConfig” URL: cloudStoreURL options: cloudOptions error: &error];
52. Configurations in Code cloudStore = [psc addPersistentStoreWithType: NSSQLiteStoreType configuration: @”CloudConfig” URL: cloudStoreURL options: cloudOptions error: &error];
53. Configurations in Code cloudStore = [psc addPersistentStoreWithType: NSSQLiteStoreType configuration: @”CloudConfig” URL: cloudStoreURL options: cloudOptions error: &error]; localStore = [psc addPersistentStoreWithType: NSSQLiteStoreType configuration: @”LocalConfig” URL: localStoreURL options: localOptions error: &error];
54. Summary •User expectations •Where data goes •Store location trade-offs
55. Design Launch Lifecycle Design
56. Design Launch Lifecycle Launch
57. Launch Steps •First launch? •New device, existing data
58. Goals •Get to full UI •Evaluate status ▪ Ready to go? ▪ Seed? ▪ Fallback? •Stay responsive
59. •Launch
60. •Launch App Launch
61. •Launch App Launch Launch UI
62. Check iCloud Status ? •Launch App Launch Launch UI
63. Signed In Check iCloud Status ? •Launch App Launch Launch UI
64. Background Queue Signed In Check iCloud Status ? •Launch App Launch Launch UI
65. Background Queue Add iCloud Store Seed Data Signed In Check iCloud Status ? •Launch Notify App Launch Launch UI
66. Background Queue Add iCloud Store Seed Data Signed In Check iCloud Status ? •Launch Notify App Launch Full UI Launch UI
67. Background Queue Add iCloud Store Seed Data Signed In Check iCloud Status ? •Launch Notify App Launch Full UI Launch UI
68. Background Queue Add iCloud Store Seed Data Signed In No Account Check iCloud Status ? •Launch Notify App Launch Full UI Launch UI
69. Background Queue Background Queue Add iCloud Store Seed Data Signed In No Account Check iCloud Status ? •Launch Notify App Launch Full UI Launch UI
70. Background Queue Background Queue Add Fallback Store Prep Fallback Store Add iCloud Store Seed Data Signed In No Account Check iCloud Status ? Notify •Launch Notify App Launch Full UI Launch UI
71. Background Queue Background Queue Add Fallback Store Prep Fallback Store Add iCloud Store Seed Data Signed In No Account Check iCloud Status ? Notify •Launch Notify App Launch Full UI Launch UI
72. •Launch •Check iCloud Status -init // Get token for iCloud user account id currentToken = [fileManager ubiquityIdentityToken]; isiCloudSignedIn = (currentToken != nil);
73. •Launch •Check iCloud Status -init // Get token for iCloud user account id currentToken = [fileManager ubiquityIdentityToken]; isiCloudSignedIn = (currentToken != nil);
74. •Launch •Check iCloud Status •Add Persistent Store - (void)loadPersistentStores { queue = dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0); dispatch_async(queue, ^(void) { [self asyncLoadPersistentStores]; }); } -loadPersistentStores
75. •Launch •Check iCloud Status •Add Persistent Store - (BOOL)loadiCloudStore { NSFileManager *fm = [[NSFileManager alloc] init]; _ubiquityURL = [fm URLForUbiquityContainerIdentifier:nil]; iCloudStoreURL = [self iCloudStoreURL]; iCloudDataURL = [ubiquityURL URLByAppendingPathComponent:@"iCloudData"]; ... NSDictionary *options = @{ NSPersistentStoreUbiquitousContentNameKey : @"iCloudStore" NSPersistentStoreUbiquitousContentURLKey : iCloudDataURL }; [psc addPersistentStoreWithType: NSSQLiteStoreType configuration: @”CloudConfig” URL: iCloudStoreURL options: options error: &localError]; -loadiCloudStore
76. •Launch •Check iCloud Status •Add Persistent Store - (BOOL)loadiCloudStore { NSFileManager *fm = [[NSFileManager alloc] init]; _ubiquityURL = [fm URLForUbiquityContainerIdentifier:nil]; iCloudStoreURL = [self iCloudStoreURL]; iCloudDataURL = [ubiquityURL URLByAppendingPathComponent:@"iCloudData"]; ... NSDictionary *options = @{ NSPersistentStoreUbiquitousContentNameKey : @"iCloudStore" NSPersistentStoreUbiquitousContentURLKey : iCloudDataURL }; [psc addPersistentStoreWithType: NSSQLiteStoreType configuration: @”CloudConfig” URL: iCloudStoreURL options: options error: &localError]; -loadiCloudStore
77. •Launch •Check iCloud Status •Add Persistent Store - (BOOL)loadiCloudStore { NSFileManager *fm = [[NSFileManager alloc] init]; _ubiquityURL = [fm URLForUbiquityContainerIdentifier:nil]; iCloudStoreURL = [self iCloudStoreURL]; iCloudDataURL = [ubiquityURL URLByAppendingPathComponent:@"iCloudData"]; ... NSDictionary *options = @{ NSPersistentStoreUbiquitousContentNameKey : @"iCloudStore" NSPersistentStoreUbiquitousContentURLKey : iCloudDataURL }; [psc addPersistentStoreWithType: NSSQLiteStoreType configuration: @”CloudConfig” URL: iCloudStoreURL options: options error: &localError]; -loadiCloudStore
78. •Launch •Check iCloud Status •Add Persistent Store - (BOOL)loadiCloudStore { NSFileManager *fm = [[NSFileManager alloc] init]; _ubiquityURL = [fm URLForUbiquityContainerIdentifier:nil]; iCloudStoreURL = [self iCloudStoreURL]; iCloudDataURL = [ubiquityURL URLByAppendingPathComponent:@"iCloudData"]; ... NSDictionary *options = @{ NSPersistentStoreUbiquitousContentNameKey : @"iCloudStore" NSPersistentStoreUbiquitousContentURLKey : iCloudDataURL }; [psc addPersistentStoreWithType: NSSQLiteStoreType configuration: @”CloudConfig” URL: iCloudStoreURL options: options error: &localError]; -loadiCloudStore
79. •Launch •Check iCloud Status •Add Persistent Store - (BOOL)loadiCloudStore { NSFileManager *fm = [[NSFileManager alloc] init]; _ubiquityURL = [fm URLForUbiquityContainerIdentifier:nil]; iCloudStoreURL = [self iCloudStoreURL]; iCloudDataURL = [ubiquityURL URLByAppendingPathComponent:@"iCloudData"]; ... NSDictionary *options = @{ NSPersistentStoreUbiquitousContentNameKey : @"iCloudStore" NSPersistentStoreUbiquitousContentURLKey : iCloudDataURL }; [psc addPersistentStoreWithType: NSSQLiteStoreType configuration: @”CloudConfig” URL: iCloudStoreURL options: options error: &localError]; -loadiCloudStore
80. •Launch •Check iCloud Status •Add Persistent Store - (BOOL)loadiCloudStore { NSFileManager *fm = [[NSFileManager alloc] init]; _ubiquityURL = [fm URLForUbiquityContainerIdentifier:nil]; iCloudStoreURL = [self iCloudStoreURL]; iCloudDataURL = [ubiquityURL URLByAppendingPathComponent:@"iCloudData"]; ... NSDictionary *options = @{ NSPersistentStoreUbiquitousContentNameKey : @"iCloudStore" NSPersistentStoreUbiquitousContentURLKey : iCloudDataURL }; [psc addPersistentStoreWithType: NSSQLiteStoreType configuration: @”CloudConfig” URL: iCloudStoreURL options: options error: &localError]; -loadiCloudStore
81. •Launch •Check iCloud Status •Add Persistent Store •Seed Initial Data - (void)asyncLoadPersistentStores { ... if ([self loadiCloudStore]) { ... [self seedPersistentStore:_iCloudStore withPersistentStoreAtURL:[self seedStoreURL] error:&error]; } } -asyncLoadPersistenStores
82. •Launch •Check iCloud Status •Add Persistent Store •Seed Initial Data •Notify Store Ready [[NSNotificationCenter defaultCenter] addObserver: rootViewController selector: @selector(reloadFetchedResults:) name: NSPersistentStoreCoordinatorStoresDidChangeNotification object: psc]; -application:didFinishLaunchingWithOptions:
83. •Launch •Check iCloud Status •Add Persistent Store •Seed Initial Data •Notify Store Ready [[NSNotificationCenter defaultCenter] addObserver: rootViewController selector: @selector(reloadFetchedResults:) name: NSPersistentStoreCoordinatorStoresDidChangeNotification object: psc]; -application:didFinishLaunchingWithOptions:
84. •Launch •Check iCloud Status •Add Persistent Store •Seed Initial Data •Notify Store Ready •Full UI!
85. Design Launch Lifecycle Launch
86. Design Launch Lifecycle Lifecycle
87. Application Lifecycle + iCloud
88. Application Lifecycle + iCloud •Seeding •Integrate changes •Responding to User Events •Performance •Debugging
89. Demo Sample application
90. Seeding Lifecycle
91. Seeding
92. Seeding
93. Seeding •Add Seed Store
94. Seeding NSPersistentStoreUbiquitousContentNameKey NSPersistentStoreUbiquitousContentURLKey •Add Seed Store
95. Seeding NSReadOnlyPersistentStoreOption NSPersistentStoreUbiquitousContentNameKey NSPersistentStoreUbiquitousContentURLKey -addPersistentStore: •Add Seed Store
96. Seeding •Add Seed Store •Migrate objects -seedPersistentStoreStore: withPersistentStoreAtURL: error: NSUInteger batchSize = 500; [fr setFetchBatchSize:batchSize]; seedObjs = [moc executeFetchRequest:fr error:&error];
97. Seeding •Add Seed Store •Migrate objects -seedPersistentStoreStore: withPersistentStoreAtURL: error: NSUInteger batchSize = 500; [fr setFetchBatchSize:batchSize]; seedObjs = [moc executeFetchRequest:fr error:&error]; for (NSManagedObject *obj in seedObjs) { [self addManagedObjectToiCloudStore:obj]; if (0 == (i % batchSize)) { if ([moc save:&error]) { [moc reset]; } } i++; }
98. Seeding •Add Seed Store •Migrate objects •Mark seed complete
99. Seeding •Add Seed Store •Migrate objects •Mark seed complete
100. Seeding •Add Seed Store •Migrate objects •Mark seed complete
101. Seeding •Add Seed Store •Migrate objects •Mark seed complete •Clean up
102. Seeding •Add Seed Store •Migrate objects •Mark seed complete •Clean up
103. Demo Seeding
104. Integrating Changes Lifecycle
105. Change Integration Managed Object Context Managed Object Context
106. Change Integration NSManagedObjectContextDidSaveNotification Managed Object Context Managed Object Context
107. Change Integration NSManagedObjectContextDidSaveNotification Managed Object Context Managed Object Context
108. Change Integration NSManagedObjectContextDidSaveNotification NSPersistentStoreDidImportUbiquitousContentChangesNotification Managed Object Context
109. Change Integration
110. Change Integration •NSManagedObjectContextDidSaveNotification ▪ NSManagedObjects
111. Change Integration •NSManagedObjectContextDidSaveNotification ▪ NSManagedObjects •NSPersistentStoreDidImportUbiquitousContentChangesNotification ▪ NSManagedObjectIDs
112. Integrating Changes
113. Integrating Changes
114. Integrating Changes Mom
115. Integrating Changes Mom Mom
116. Integrating Changes Mom Mom
117. Integrating Changes Mom Mom
118. Integrating Changes 2 Mom 1 Mom PK Contact Mom Mom
119. Uniquing •Find the Duplicates
120. Uniquing •Find the Duplicates select zemailaddress, count(zemailaddress) from zperson group by zemailaddress; -deDupe:
121. Uniquing •Find the Duplicates select zemailaddress, count(zemailaddress) from zperson group by zemailaddress; zemailddress count(zemailaddress) cd@wwdc.com 1 core@data.com 1 moc@save.com 256 -deDupe:
122. Uniquing •Find the Duplicates -deDupe:
123. Uniquing •Find the Duplicates NSExpression *countExpr = [NSExpression expressionWithFormat:@"count:(emailAddress)"]; -deDupe:
124. Uniquing •Find the Duplicates NSAttributeDescription *emailAttr; NSFetchRequest *fr; [fr setPropertiesToFetch:[NSArray arrayWithObjects:emailAttr, countExpr, nil]]; [fr setPropertiesToGroupBy:[NSArray arrayWithObject:emailAttr]]; NSExpression *countExpr = [NSExpression expressionWithFormat:@"count:(emailAddress)"]; -deDupe:
125. Uniquing •Find the Duplicates NSAttributeDescription *emailAttr; NSFetchRequest *fr; [fr setPropertiesToFetch:[NSArray arrayWithObjects:emailAttr, countExpr, nil]]; [fr setPropertiesToGroupBy:[NSArray arrayWithObject:emailAttr]]; NSExpression *countExpr = [NSExpression expressionWithFormat:@"count:(emailAddress)"]; [fr setResultType:NSDictionaryResultType]; -deDupe:
126. Uniquing •Find the Duplicates -deDupe:
127. Uniquing •Find the Duplicates 2012-06-04 15:41:38.736 SharedCoreData[26470:10d03] CoreData: sql: SELECT t0.ZEMAILADDRESS, COUNT( t0.ZEMAILADDRESS) FROM ZPERSON t0 GROUP BY t0.ZEMAILADDRESS NSArray *countDictionaries = [moc executeFetchRequest:fr error:&error]; -deDupe:
128. Uniquing •Find the Duplicates (lldb) po countDictionaries (NSArray *) $2 = 0x07c0cb80 <_PFArray 0x7c0cb80>( { count = 1; emailAddress = "cd@wwdc.com"; }, { count = 256; emailAddress = "moc@save.com"; }, { count = 1; emailAddress = "core@data.com"; }) 2012-06-04 15:41:38.736 SharedCoreData[26470:10d03] CoreData: sql: SELECT t0.ZEMAILADDRESS, COUNT( t0.ZEMAILADDRESS) FROM ZPERSON t0 GROUP BY t0.ZEMAILADDRESS NSArray *countDictionaries = [moc executeFetchRequest:fr error:&error]; -deDupe:
129. Uniquing •Find the Duplicates •Fetch Duplicate Objects -deDupe:
130. Uniquing •Find the Duplicates •Fetch Duplicate Objects p = [NSPredicate predicateWithFormat:@"emailAddress IN (%@)", emailsWithDupes]; [fr setPredicate:p]; -deDupe:
131. Uniquing •Find the Duplicates •Fetch Duplicate Objects emailSort = [NSSortDescriptor sortDescriptorWithKey:@"emailAddress" ascending:YES]; [fr setSortDescriptors:[NSArray arrayWithObject:emailSort]]; p = [NSPredicate predicateWithFormat:@"emailAddress IN (%@)", emailsWithDupes]; [fr setPredicate:p]; NSArray *dupes = [moc executeFetchRequest:fr error:&error]; -deDupe:
132. Uniquing •Find the Duplicates •Fetch Duplicate Objects •Choose a winner -deDupe:
133. Uniquing •Find the Duplicates •Fetch Duplicate Objects ▪ Ensure consistent merges across peers •Choose a winner -deDupe:
134. Uniquing •Find the Duplicates •Fetch Duplicate Objects ▪ Ensure consistent merges across peers ▪ Use a record UUID or timestamp •Choose a winner -deDupe:
135. Uniquing •Find the Duplicates •Fetch Duplicate Objects ▪ Ensure consistent merges across peers ▪ Use a record UUID or timestamp for (NSManagedObject *dupe in duplicates) { //choose winner if (0 == (i % batchSize)) { [moc save:&error]; } i++; } •Choose a winner -deDupe:
136. Demo Uniquing
137. User Events Lifecycle
138. User Events
139. User Events •Delete from Documents & Data
140. User Events •Delete from Documents & Data
141. User Events •Delete from Documents & Data
142. User Events •Delete from Documents & Data
143. User Events •Delete from Documents & Data
144. User Events •Delete from Documents & Data
145. User Events •Delete from Documents & Data
146. User Events •Delete from Documents & Data
147. User Events •Delete from Documents & Data
148. Documents & Data User Events
149. Documents & Data User Events -presentedItemURL MyDir/Data.nosync/MyFile NSFilePresenter
150. Documents & Data User Events -presentedItemURL MyDir/Data.nosync/iCloudStore.sqlite NSFilePresenter
151. Handling Account Changes User Events
152. Handling Account Changes User Events •NSFileManager API -iCloudAccountChanged:
153. Handling Account Changes User Events •NSFileManager API NSFileManager -ubiquityIdentityToken - (void)applicationDidBecomeActive:(UIApplication *)application { id token = [[NSFileManager defaultManager] ubiquityIdentityToken]; if (![self.currentUbiquityToken isEqual:token]) { [self iCloudAccountChanged:nil]; } } -iCloudAccountChanged:
154. Handling Account Changes User Events •NSFileManager API NSFileManager -ubiquityIdentityToken NSUbiquityIdentityDidChangeNotification [notificationCenter addObserver:self selector:@selector(iCloudAccountChanged:) name:NSUbiquityIdentityDidChangeNotification object:nil]; -iCloudAccountChanged:
155. - (void)iCloudAccountChanged:(NSNotification *)notification { NSError *error = nil; [_psc removePersistentStore:self.iCloudStore error:&error]; [self loadPersistentStores]; } Handling Account Changes User Events -iCloudAccountChanged:
156. Demo User events
157. Performance and Debugging Lifecycle
158. Performance
159. Performance •-save: •Coalesce changes as appropriate •Avoid storing raw sensor data ▪ CoreLocation @ 60Hz!
160. Persistent Store Performance
161. Persistent Store Performance •Memory Pressure
162. Persistent Store Performance •Memory Pressure NSFetchRequest -setFetchBatchSize: NSManagedObjectContext -save: NSManagedObjectContext -reset
163. Debugging
164. Debugging •Macs are greedy peers ▪ Run at least one iCloud-enabled app (TextEdit)
165. Debugging •Macs are greedy peers ▪ Run at least one iCloud-enabled app (TextEdit) •Removing data ▪ Coordinated write to delete every file inside container ▪ Be patient, it might take a while to propagate to all your devices
166. Debugging •Macs are greedy peers ▪ Run at least one iCloud-enabled app (TextEdit) •Removing data ▪ Coordinated write to delete every file inside container ▪ Be patient, it might take a while to propagate to all your devices •File great bugs
167. Filing great bugs Debugging
168. Filing great bugs Debugging •Sample Application •Ubiquity Container •Console logs ▪ -com.apple.coredata.ubiquity.logLevel # (1,2,3)
169. Demo Debugging
170. More Information Michael Jurewitz Technology Evangelist jury@apple.com Cocoa Feedback cocoa-feedback@apple.com Core Data Documentation Programming Guides, Examples, Tutorials http://developer.apple.com/ Apple Developer Forums http://devforums.apple.com
171. Related Sessions Advanced iCloud Document Storage Marina Thursday 3:15PM Core Data Best Practices Mission Wednesday 9:00AM iCloud Storage Overview Pacific Heights Tuesday 4:30PM
172. Labs Core Data Lab Developer Tools Lab A Thursday 9:00AM iCloud Storage Lab Essentials Lab B Thursday 4:30PM Core Data Lab Essentials Lab B Friday 9:00AM iCloud Storage Lab Essentials Lab B Friday 11:30AM
174. The last 3 slides after the logo are intentionally left blank for all presentations.
175. The last 3 slides after the logo are intentionally left blank for all presentations.
176. The last 3 slides after the logo are intentionally left blank for all presentations.