rest/json/coredata example code - a tour

github.com/carlbrown/SeismicJSON Carl BrownTwitter: @CarlBrwnEmail: CarlB@PDAgent.com

REST/JSON/CoreData Example Code

1Turn on Camera and ScreenFlow!!

Asynchronous iOS Programming Rules

•Threads are bad

•Use Queues instead

•Apple's Concurrency Programming Guide*:

• Page 10: "The Move Away from Threads"

• Page 74: "Migrating Away from Threads"

• Page 74: "Replacing Threads with Dispatch Queues"* http://developer.apple.com/library/ios/#documentation/General/Conceptual/ConcurrencyProgrammingGuide/Introduction/Introduction.html

Some things aren't thread-safe

•Any UIAnything in iOS

•CoreData

UI tasks Must be on the Main Thread

Often called the "UI" thread for that reason4

CoreData Contexts and Objects are tied to a thread

• Never share a CoreData object between threads

• Never share a CoreData object between contexts

• Pass objects only by ID and fetch them again

• Always notify other contexts when you've made changes

Don't cross the threads•Use the same serial queue to stay on the same thread

•Use dispatch_get_main_queue() or [NSOperationQueue mainQueue] to get to the Main Thread.

SeismicJSONThe only project we'll be working with today

Feel free to run it and play with it for a couple of minutes

Also on github so you can see how it was written.

First Exercise:Follow the Code

This is a vital skill to have. We don't expect people to write in English without reading a lot of English first, but programmers consistently spend more time writing code than reading it while learning a new language.

Please Open MasterViewController.mThis is pretty much a tableViewController like you've seen before.

Ignore the #if conditionals this run-through

MasterViewController• Cell labels filled in from Model Object

• custom XIB for TableViewCell

• dateFormatter in viewDidLoad

• segmentedController sets FRC sorting

• actionSheet for adding rows (you can figure out)

• some iPad stuff (not Rocket Science)

• #if conditional stuff (for later)

should be mostly familiar

DetailViewController•Really simple

•simpler than the tableViewCell

•Just a bunch of labels

•nothing to discuss here

ActivityIndicatingImageViewThis has a UIActivityIndicatorView, implements a new custom @protocol and refers to a NetworkManager.

So openActivityIndicatingImageView.m

Start Spinner upon waking

-(void) awakeFromNib { _activityIndicator = [[UIActivityIndicatorView alloc] initWithActivityIndicatorStyle:UIActivityIndicatorViewStyleGray]; [_activityIndicator setFrame:self.frame]; [_activityIndicator setHidesWhenStopped:YES]; [self addSubview:_activityIndicator]; [_activityIndicator startAnimating];}

Stop it when we get image

-(void) setImage:(UIImage *)image { [super setImage:image]; if (image) { [self.activityIndicator stopAnimating]; } else { [self.activityIndicator startAnimating]; }}

setImageFileName 1/3

-(void) setImageFileName:(NSString *)imageFileName {

_imageFileName = imageFileName;

if (_imageFileName==nil) { [self setImage:nil]; return; }

//If the file already exists, don't bother to fetch it again NSString *fullFilePath = [[[NetworkManager sharedManager]

cachedImageDirectory] stringByAppendingPathComponent:_imageFileName];

if ([[NSFileManager defaultManager] fileExistsAtPath:fullFilePath]) {

[self imageDidBecomeAvailableAtPath:fullFilePath]; return; }

[[NetworkManager sharedManager] fetchImagewithFilename:

imageFileName andNotifyTarget:self]; }

OK, now we're getting somewhere

-(void) fetchImagewithFilename:(NSString *) filename andNotifyTarget:(NSObject <ImageFetchDelegate> *) target { //Stuff we've seen before ImageFetchOperation *imageFetchOperation =

[[ImageFetchOperation alloc] init];

[imageFetchOperation setUrlToFetch:[self imageURLForImageFileName:filename]];

[imageFetchOperation setNotificationTarget:target];

[self.fetchQueue addOperation:imageFetchOperation];

ImageFetchOperation.m

connectionDidFinishLoading (abridged)

- (void)connectionDidFinishLoading:(NSURLConnection *)connection { if (self.response.statusCode==200) { NSError *error=nil; NSString *filename = [self.urlToFetch lastPathComponent]; NSString *fullFilePath = [

[[NetworkManager sharedManager] cachedImageDirectory] stringByAppendingPathComponent:filename];

NSLog(@"About to write file: %@",fullFilePath); if (![self.fetchedData writeToFile:fullFilePath

options:NSDataWritingAtomic error:&error]) { NSLog(@"error occurred writing file: %@",

[error localizedDescription]); } if (self.notificationTarget) { [self.notificationTarget

imageDidBecomeAvailableAtPath:fullFilePath]; } }}

Only save if no error

Get filename/path

Save File

Let the View Know

[control]-[⌘]-Jback to ActivityIndicatingImageView

imageDidBecomeAvailableAtPath1/2

-(void) imageDidBecomeAvailableAtPath:(NSString *) path { if (![[path lastPathComponent]

isEqualToString:self.imageFileName]) { NSLog(@"Warning: notified of incorrect file:

%@, should have been %@",[path lastPathComponent],self.imageFileName);

//try again [self setImageFileName:self.imageFileName]; return; }

Only load the file we're expecting (race condition checking)

imageDidBecomeAvailableAtPath2/2

//load image off the main queue UIImage *imageToLoad=[UIImage imageWithContentsOfFile:path]; dispatch_async(dispatch_get_main_queue(), ^{ [self setImage:imageToLoad]; [self setNeedsDisplay]; });}

Set our image with the file now on disk

Summary of ActivityIndicatingImageView

• Start the view with a spinner telling the user we are working on something

• See if the file is already on disk, and use it if so.

• If not, we ask the Network Manager to get the file for us

• The Network Manager creates an operation to get our file (presumably from the network) and write it to disk

• The Network Manager tells us the file is ready

• We load the file into our image property

• Now that we have an image, the spinner hides

Networking Strategy•Always* load the UI from local storage

•Core Data or local file or something

•Always* put network data in local storage

•Then tell the UI to refresh itself

•Put up a placeholder if no data

Carl's Recommended

*Except with live web pages or HTTP streaming30

Some people argue with me about this, but it's served me well for years

Why do it that way?•Separates network code from UI code

•Easier to test

•Much faster response if previous data

•Much better user experience offline

Why wouldn't you?•Pointless if the network is infinitely fast and infinitely reliable*

•More effort than "Unbreakable Glass" loading screens

*c.f. http://en.wikipedia.org/wiki/Fallacies_of_Distributed_Computing32

NSOperations and GCD

NSOperation•Been around since the first iPhone OS SDK

•Way to encapsulate the pieces of a task in one place

•Can be queried, suspended or canceled

•Simple selector call or block variants

•NSOperations are placed in NSOperationQueues

NSOperationQueue• Long-lived (presumably) queue that can contain

numerous operations

• Can be serial or concurrent

• Can be suspended or canceled

• Nice (but verbose) Objective-C syntax

• Will stay on the same thread, if serial

• [NSOperationQueue mainQueue] is always on the Main Thread

Dispatch Queues•C-style (concise) syntax

•quicker to use in-place

•much less typing than declaring an NSOperation and adding to Queue

•Harder to manage or cancel

Which to use?• No hard-and-fast rules, but...

• I tend to use NSOperations for:

• things I'm going to do several times

• things that have non-trivial complexity

• I tend to use dispatch_async() for things:

• with less than 10 or so lines of code

• done only once in the App

• that won't need to change when spec changes

Waiting in Cocoa•Don't Sleep

•Don't use locks

•Yield to the RunLoop

•See the FetchOperation for example

•Sleeping or Locking Freezes the Thread

Be Nice to Threads•POSIX Threads are a finite resource

•The system will spin up more if tasks are waiting

•But when no more can start, things will hang

•See: WWDC2012 Session Session 712 - Asynchronous Design Patterns with Blocks, GCD, and XPC

Back to our Application

Please OpenNotificationOrParentContext.h

Project Variations

//Make this a 1 to show notifications, and a 0 to show parent contexts#define kUSE_NSNOTIFICATIONS_FOR_CONTEXT_MERGE 0//if using notifications, set this to 1 to have them in the App Delegate#define kNSNOTIFICATIONS_HANDLED_IN_APPDELEGATE 0

Note: I'm not usually a fan of this kind of conditionalcompilation, but for this case, I thought it would

let you play with project in the debugger in acleaner way than with traditional if's.

OK, to theAppDelegate.m

Open Source Control View

Click the TimeMachine45

Pick the Initial Commit Scroll in the center of the screen

Got rid of some Xcode 4.4-isms

Removed Observer48

applicationWillResignActive:!(UIApplication *) application

•Happens when user gets Texts, notifications, Alerts, phone calls or hits the home button

•Here I'm removing the notification observer so we won't try to get notifications while not Active

Added Observer50

Kicked off Network Fetch

applicationDidBecomeActive:(UIApplication *)application

•Happens when App becomes full-focus

•After launch

•Or after returning from dealing with alert

•Or after dealing with "most recently used apps" along bottom of screen

•Here I'm adding a notification observer

This Runs "changesSaved:"

[[NSNotificationCenter defaultCenter] addObserver:selfselector:@selector(changesSaved:) name:NSManagedObjectContextDidSaveNotification

object:nil];

Handler Code

- (void)changesSaved:(NSNotification *)notification { if (![NSThread isMainThread]) { dispatch_async(dispatch_get_main_queue(), ^{ [self changesSaved:notification]; }); return; } if ([notification object] != self.managedObjectContext) { [self.managedObjectContext

mergeChangesFromContextDidSaveNotification:notification]; }}

If not on Main, go there

Merge changes

Queue Concurrency Type

Reset DB each run58

Back to normal view now

NetworkManager.m

Singleton Pattern

+ (NetworkManager *)sharedManager { static dispatch_once_t pred; dispatch_once(&pred, ^{ sharedManager = [[self alloc] init]; //Initialization Stuff }); return sharedManager;}

Kicked off from AppDelegate

-(void) startMainPageFetch { [self setHostReach:[Reachability

reachabilityWithHostName:[self.baseURL host]]]; [self.hostReach startNotifier];

[self queuePageFetchForRelativePath:@"/earthquakes/feed/geojson/significant/month"];

Inform users of network status or be Rejected

Just do it. If you want to understand it, read Apple's writeup

Start fetch of first batch

Make NSOp & Queue it

-(void) queuePageFetchForRelativePath:(NSString *) relativePath { EarthquakeFetchOperation *earthquakeFetchOperation =

[[EarthquakeFetchOperation alloc] init]; [earthquakeFetchOperation setUrlToFetch:

[self urlForRelativePath:relativePath]]; [earthquakeFetchOperation setMainContext:self.mainContext]; [earthquakeFetchOperation setDelegate:self]; [self.fetchQueue addOperation:earthquakeFetchOperation];}

EarthquakeFetchOperation.h

#import <Foundation/Foundation.h>#import "BaseFetchOperation.h"

@interface EarthquakeFetchOperation : BaseFetchOperation@property (nonatomic, weak) NSManagedObjectContext *mainContext;

BaseFetchOperation.h

@interface BaseFetchOperation : NSOperation <NSURLConnectionDataDelegate>

@property (nonatomic, strong) NSURL *urlToFetch;@property (nonatomic, strong) NSMutableData *fetchedData;@property (nonatomic, assign, getter=isDone) BOOL done;@property (nonatomic, assign) NSURLConnection *connection;@property (nonatomic, retain) NSHTTPURLResponse *response;

@property (nonatomic, weak) NSObject<FetchNotifierDelegate> *delegate;

-(void) finish;

@protocol FetchNotifierDelegate <NSObject>-(void) fetchDidFailWithError:(NSError *) error;-(void) incrementActiveFetches;-(void) decrementActiveFetches;@end

Methods needed for URL fetching

BaseFetchOperation.m

Entry Point

- (void)main { if ([self isCancelled]) { return; } if (!_urlForJSONData) { NSLog(@"Cannot start without a URL"); return; } [self setFetchedData:[NSMutableData data]]; //Initialize NSURLRequest *request =

[NSURLRequest requestWithURL:[self urlToFetch]]; if (self.delegate) { [self.delegate incrementActiveFetches]; } [self setConnection:[NSURLConnection

connectionWithRequest:request delegate:self]]; CFRunLoopRun();}

Sanity Check

Make request

Inform user we're active

Start Connection

Give Up Control of thread

Finish

-(void) finish { [self setDone:YES]; if (self.delegate) { [self.delegate decrementActiveFetches]; } CFRunLoopStop(CFRunLoopGetCurrent());}

Inform user we're done

Stop the runloop & get off

Other methods there

• didReceiveResponse

• remember response

• truncate data

• (can get more than one response)

• didReceiveData

• append data

• didFailWithError

• report error to our delegate80

EarthquakeFetchOperation

connectionDidFinishLoading 1/n

- (void)connectionDidFinishLoading:(NSURLConnection *)connection { if ([self isCancelled]) { [self finish]; return; } if (self.response.statusCode==200) {

Sanity Check/Housekeeping

Don't parse bad response

id objectFromJSON = [NSJSONSerialization JSONObjectWithData:self.fetchedData options:0 error:&error];

if (objectFromJSON) {#if kUSE_NSNOTIFICATIONS_FOR_CONTEXT_MERGE NSManagedObjectContext *context = [[NSManagedObjectContext alloc] init]; [context setPersistentStoreCoordinator:

self.mainContext.persistentStoreCoordinator];#else

NSManagedObjectContext *context = [[NSManagedObjectContext alloc] initWithConcurrencyType:NSMainQueueConcurrencyType];

[context setParentContext:[self mainContext]];#endif

Parse JSON

If the JSON was good

Make new ManagedObjectContext

NSDictionary *jsonDict = (NSDictionary *) objectFromJSON;

if (jsonDict) { NSArray *events = [jsonDict objectForKey:@"features"]; if (events) { for (NSDictionary *eventDict in events) {

If we got a dictionary

Get Array of Earthquakes

If Array/JSON is valid

Iterate over it

NSString *eventLocation = [eventDict valueForKeyPath:@"properties.place"];

NSDate *eventDate = [NSDate dateWithTimeIntervalSince1970:[[eventDict valueForKeyPath:@"properties.time"] doubleValue]];

NSNumber *eventLong = [NSNumber numberWithDouble:[[[eventDict valueForKeyPath:@"geometry.coordinates"] objectAtIndex:0]

doubleValue]];NSNumber *eventLat =[NSNumber numberWithDouble:[[[eventDict

valueForKeyPath:@"geometry.coordinates"] objectAtIndex:1] doubleValue]];

NSNumber *eventMagnitude = [NSNumber numberWithFloat:[[eventDict valueForKeyPath:@"properties.mag"] floatValue]];

NSString *eventWebPath = [@"http://earthquake.usgs.gov" stringByAppendingPathComponent:[eventDict valueForKeyPath:@"properties.url"]];

Extract values from eventDict

Using keyPaths

and/or Array elements

NSFetchRequest *fetchRequest = [NSFetchRequest fetchRequestWithEntityName:

NSStringFromClass([Earthquake class])];[fetchRequest setFetchLimit:1];NSPredicate *eventInfo =

[NSPredicate predicateWithFormat:@"location = %@ AND date = %@",

eventLocation, eventDate];[fetchRequest setPredicate:eventInfo];NSError *fetchError=nil;NSArray *existingEventsMatchingThisOne =

[context executeFetchRequest:fetchRequest error:&fetchError];

Make a fetch request

matching our event

And run it

if ([existingEventsMatchingThisOne count]==0) { //Didn't find one already, make a new one NSManagedObject *newManagedObject =

[NSEntityDescription insertNewObjectForEntityForName:NSStringFromClass([Earthquake class])

inManagedObjectContext:context]; [newManagedObject setValue:eventLocation forKey:@"location"]; [newManagedObject setValue:eventDate forKey:@"date"]; [newManagedObject setValue:eventLat forKey:@"latitude"]; [newManagedObject setValue:eventLong forKey:@"longitude"]; [newManagedObject setValue:eventMagnitude forKey:@"magnitude"]; [newManagedObject setValue:eventWebPath forKey:@"webLinkToUSGS"];}

If there isn't already one

Make a new Object

Set all its attributes

// Save the context.error = nil;if (![context save:&error]) { // stuff NSLog(@"Unresolved error %@, %@", error, [error userInfo]); abort();}

Save and check for errors

// Save the context.error = nil;if (![context save:&error]) { // stuff NSLog(@"Unresolved error %@, %@", error, [error userInfo]); abort();}

#if kUSE_PARENT_CONTEXTS_FOR_CONTEXT_MERGE dispatch_sync(dispatch_get_main_queue(), ^{ NSError *error = nil; if (![self.mainContext save:&error]) { // Stuff NSLog(@"Unresolved error %@, %@", error,

[error userInfo]); abort(); } });#endif

If we're merging via Parent

On the Main Thread

Tell the main context to save

Review

• Asynchronous programming

• NSOperations

• Grand Central Dispatch (GCD)

• More Blocks

• Notifications

• App Lifecycle

• Network I/O (HTTP/REST)

• JSON parsing112

Questions?Now, Or Later:CarlB@PDAgent.com@CarlBrwn (Twitter/App.net)

Today's App was: https://github.com/carlbrown/SeismicJSON

rest/json/coredata example code - a tour

Technology

[short talk] o poder das apis - rest, json e além

oracle database 12c json document store - nocoug database...

emc captiva rest services · captiva rest services supports...

sharepoint 2013 – rest, json and sharepoint designer

energycap online json rest-based api

beautiful rest + json apis · • apis, rest & json •...

using json web tokens for rest authentication

sharepoint 2013 – rest, json and sharepoint designer

integração de serviços cloud com rest/json

criando e consumindo web service rest com php e json

json – ajax - rest javascript object notation

rest, json and rss with wcf 3.5

integración de servicios en la nube con rest/json

connecting json, rest and angularjs - intersystems · 1 |...

rest and json in wcf

arcgis geoevent extension for server: best practicesreceive...

design beautiful rest + json apis

16 coredata

rest/json vs soap/xml · 2018-12-05 · rest/json vs...

integrando sua app ao mundo via rest/json