rambler.ios #2: Введение в restkit

RestKit

Что такое RestKit?

• Фреймворк для взаимодействия с RESTful API



• Разрабатывается с 2011 года




• 7750 🌟 на GitHub




• 7750 🌟 на GitHub

• 4 коммита от Сергея Крапивенского 👸

Терминология

• mapping – преобразование данных из одного представления в другое



• source – объект, из которого производится мэппинг




• destination – объект, в который производится мэппинг




• destination – объект, в который производится мэппинг

• АПИ – лень выговаривать ЭйПиАй

Зачем он мне?


• API клиент и мэппинг в одном флаконе



• Упрощает жизнь при работе с плохим JSON




• Легкий мэппинг напрямую в Core Data





• Мэппинг можно прикрутить к другому сетевому стеку





• Мэппинг можно прикрутить к другому сетевому стеку

• Упрощает тестирование мэппинга

ОДНАКО

Минусы

• Много issues на GitHub

Минусы


• Сетевой слой использует AFNetworking 1.0

Минусы


• Сетевой слой использует AFNetworking 1.0

• Много задач на одну библиотеку

Составные части


• Object Mapping


• Object Mapping

• Network


• Object Mapping

• Network

• Core Data


• Object Mapping

• Network

• Core Data

• Testing

Object Mapping

RKMapping

RKObjectMapping

RKEntityMapping

RKDynamicMapping

RKObjectMapping

• класс объекта-назначения

• набор объектов типа RKPropertyMapping

RKPropertyMapping

• RKObjectMapping – контейнер для объектов класса RKPropertyMapping, описывающих мэппинг одного поля объекта-источника

RKPropertyMapping


• RKAttributeMapping – мэппинг простого значения (строка, число и т.д.)

RKPropertyMapping


• RKAttributeMapping – мэппинг простого значения (строка, число и т.д.)

• RKRelationshipMapping – мэппинг составных объектов

Пример

{ "applications": [ { "title": "Афиша-Рестораны","body": "Самый быстрый и удобный способ выбрать в какой ресторан

или бар пойти","author": "Илья Пучка","publication_date": "13/11/2014"

},{ "title": "Redigo","body": "Удобный компактный гид по странам мира от Австралии до

Японии в вашем телефоне","author": "Стас Цыганов","publication_date": "30/01/2015"

}]}

Пример

@interface Application: NSObject

@property (nonatomic, copy) NSString* title;

@property (nonatomic, copy) NSString* body;

@property (nonatomic, copy) NSString* author;

@property (nonatomic) NSDate* publicationDate;

@end

RKObjectMapping

RKObjectMapping* appMapping =

[RKObjectMapping mappingForClass:[Application class]];

[appMapping addAttributeMappingsFromDictionary:@{

@"title": @"title",

@"body": @"body",

@"author": @"author",

@"publication_date": @"publicationDate"

}];

RKObjectMapping

То же самое что и:

[appMapping addPropertyMapping:

[RKAttributeMapping attributeMappingFromKeyPath:@"title"

toKeyPath:@"title"]];


[RKAttributeMapping attributeMappingFromKeyPath:@"body"

toKeyPath:@"body"]];

и т.д.

Приведение типов

• NSString -> NSDate с помощью NSDateFormatter

• NSString -> NSURL

• NSString -> NSNumber

• NSString с булевыми значениями (YES, NO, false и тд) -> NSNumber

• NSNumber -> NSDate

• предустановленные NSDateFormatter’ы

• и многое другое (свое собственное преобразование можно задать блоком)

Связь запроса и мэппинга

• Для связи запроса с мэппингом есть специальный класс - RKResponseDescriptor

• Для сериализации объектов перед отправкой на сервер используется похожий класс RKRequestDescriptor

Параметры RKResponseDescriptor

• mapping


• mapping

• method - тип REST-метода


• mapping


• pathPattern – относительный URL запроса


• mapping



• keyPath


• mapping



• keyPath

• statusCodes – NSIndexSet статус-кодов


• mapping = appMapping

• method = RKRequestMethodAny

• pathPattern = nil

• keyPath = @”applications”

• statusCodes = RKStatusCodeIndexSetForClass(RKStatusCodeClassSuccessful)

RKResponseDescriptor

• [[RKObjectManager sharedManager] addResponseDescriptor:responseDescriptor];

• список дескрипторов анализируется при запросе

• после добавления дескриптора можно посылать запросы и обрабатывать ответ

Мэппинг графа объектов

{”applications": [

{"title": "Redigo","body": "Удобный компактный гид по странам мира от Австралии до

Японии в вашем телефоне","author": {

"name": "Стас Цыганов","email": "[email protected]"

},"publication_date": "30/01/2015"

}]

}


@interface Author : NSObject

@property (nonatomic, copy) NSString* name;

@property (nonatomic, copy) NSString* email;

@end

@interface Application: NSObject

@property (nonatomic, copy) NSString* title;

@property (nonatomic, copy) NSString* body;

@property (nonatomic) Author* author;

@property (nonatomic) NSDate* publicationDate;

@end


RKObjectMapping* authorMapping =

[RKObjectMapping mappingForClass:[Author class] ];

[authorMapping addAttributeMappingsFromArray:@[

@"name", @"email" ]];


RKObjectMapping* appMapping =

[RKObjectMapping mappingForClass:[Application class] ];


@"title": @"title",

@"body": @"body”,

@"publication_date": @"publicationDate”

}];

RKRelationshipMapping


[RKRelationshipMapping relationshipMappingFromKeyPath:@"author”

toKeyPath:@"author”

withMapping:authorMapping]];

Мэппинг кривого JSON


Мэппинг без KVC:

[{ "title": "Redigo",

"body": "Удобный компактный гид по странам мира от Австралии до Японии в вашем телефоне",

"author": {"name": "Стас Цыганов","email": "[email protected]"

},"publication_date": “30/01/2015"

}]


Что делать?

• у дескриптора сделать keyPath = nil

• PROFIT


NSIndexSet *success = RKStatusCodeIndexSetForClass(RKStatusCodeClassSuccessful);

RKResponseDescriptor *responseDescriptor =

[RKResponseDescriptor responseDescriptorWithMapping:appMapping

method:RKRequestMethodAny

pathPattern:@"/applications"

keyPath:nil

statusCodes:success];


Массив простых значений:

{ "developers":

["Егор Толстой",

"Герман Сапрыкин",

"Андрей Резанов"] }


@interface RamblerDeveloper: NSObject

@property (nonatomic, copy) NSString *name;

@end


RKObjectMapping *userMapping = [RKObjectMapping

mappingForClass:[RamblerDeveloper class]];

[userMapping addPropertyMapping:

[RKAttributeMapping attributeMappingFromKeyPath:nil

toKeyPath:@”name"]];


{

"first_name": "Егор",

"last_name": "Толстой",

"city": "Москва",

"country": "Россия",

"zip": 128405

}


@interface ExampleUser : NSObject

@property (nonatomic, copy) NSString *firstName;

@property (nonatomic, copy) NSString *lastName;

@property (nonatomic) ExampleAddress *address;

@end

@interface ExampleAddress : NSObject

@property (nonatomic, copy) NSString *city;

@property (nonatomic, copy) NSString *country;

@property (nonatomic, copy) NSNumber *zipCode;

@end


RKObjectMapping *addressMapping =

[RKObjectMapping mappingForClass:[ExampleAddress class]];

[addressMapping addAttributeMappingsFromDictionary:@{

@"city": @"city",

@”country": @"country",

@"zip": @"zipCode”

}];


RKObjectMapping *userMapping =

[RKObjectMapping mappingForClass:[ExampleUser class]];

[userMapping addAttributeMappingsFromDictionary:@{

@"first_name": @"firstName",

@"last_name": @"lastName“

}];


[userMapping addPropertyMapping:

[RKRelationshipMapping

relationshipMappingFromKeyPath:nil

toKeyPath:@"address"

withMapping:addressMapping]];


{

"Сергей": {

"email": "[email protected]",

"age": 28

}

}


@interface User : NSObject

@property (nonatomic, copy) NSString* email;

@property (nonatomic, copy) NSString* username;

@property (nonatomic, copy) NSNumber* age;

@end


RKObjectMapping* mapping =

[RKObjectMapping mappingForClass:[User class] ];

[mapping addAttributeMappingFromKeyOfRepresentationToAttribute:@"username"];

[mapping addAttributeMappingsFromDictionary:@{

@"(username).email": @"email",

@"(username).age": @"age”

}];

RKDynamicMapping

• заранее неизвестно какой мэппинг потребуется

RKDynamicMapping


• нужный RKObjectMapping подбирается при анализе полученных данных

RKDynamicMapping



• выбор осуществляется с помощью блока

RKDynamicMapping



• выбор осуществляется с помощью блока

• или при анализе аттрибута в JSON с помощью класса RKObjectMappingMatcher

Network

RKObjectRequestOperation

• наследуется от NSOperation



• управляет жизненным циклом HTTP-запроса



• управляет жизненным циклом HTTP-запроса

• обрабатывает ответ с помощью движка мэппинга


1) создаем NSURLRequest с нужным URL

NSURL *URL = [NSURL URLWithString:@"http://rambler.ru/applications"];

NSURLRequest *request = [NSURLRequest requestWithURL:URL];


2) создаем операцию с созданным реквестом и дескриптором

RKObjectRequestOperation *objectRequestOperation =

[[RKObjectRequestOperation alloc] initWithRequest:request

responseDescriptors:@[ responseDescriptor ]];


3) создаем блоки, вызываемые в случае успеха и в случае ошибки


4) запускаем операцию

[objectRequestOperation start];


NSURL *URL = [NSURL URLWithString:@"http://rambler.ru/applications"];

NSURLRequest *request = [NSURLRequest requestWithURL:URL];

RKObjectRequestOperation *objectRequestOperation = [[RKObjectRequestOperation alloc] initWithRequest:request responseDescriptors:@[ responseDescriptor ]];

[objectRequestOperation setCompletionBlockWithSuccess:^(RKObjectRequestOperation *operation, RKMappingResult *mappingResult)

{

NSLog(@"Loaded collection of applications: %@", mappingResult.array);

} failure:^(RKObjectRequestOperation *operation, NSError *error)

{

NSLog(@"Operation failed with error: %@", error);

}];

[objectRequestOperation start];

Цикл RKObjectRequestOperation

1) создается инстанс RKHTTPRequestOperation (сабкласс AFHTTPRequestOperation), эта операция запускается


2) в случае успеха инициализируется RKMapperResponseOperation и обрабатывает response. на вход ей подается:

• NSURLRequest

• NSHTTPURLResponse

• response data (NSData)

• массив дескрипторов


3) RKMapperResponseOperation составляет список дескрипторов, URL и HTTP method у которых подходят для обработки данного response


4) если объект можно десериализовать, то создается RKMapperOperation с полученным объектом и словарем, где ключом является keyPath, а значением – мэппинг

@{ "applications" : appMapping }


5) RKMapperOperation проходит по всем ключам в полученном словаре и вызывает у серверного объекта valueForKeyPath: с этим ключом

Пример

Исходный словарь:

{ "applications": [ { "title": "Афиша-Рестораны",

"body": "Самый быстрый и удобный способ выбрать в какой ресторан или бар пойти",

"author": "Илья Пучка","publication_date": "13/11/2014"

},{ "title": "Redigo",

"body": "Удобный компактный гид по странам мира от Австралии до Японии в вашем телефоне",

"author": "Стас Цыганов","publication_date": "30/01/2015"

}]}

Пример

После вызова у него valueForKeyPath:@"applications":

NSArray{

title = "Афиша-Рестораны”;body = "Самый быстрый и удобный способ выбрать в какой ресторан или бар

пойти”;author = "Илья Пучка";publication_date = "13/11/2014";

},{

title = "Redigo";body = "Удобный компактный гид по странам мира от Австралии до Японии в

вашем телефоне”;author = "Стас Цыганов";publication_date = "30/01/2015";

}


6) с полученным объектом, целевым объектом (Application) и мэппингом инициализируется RKMappingOperation


7) внутри RKMappingOperation по очереди обрабатываются все аттрибуты, указанные в мэппинге

RKObjectManager

• централизация настроек

RKObjectManager


• хэлперы для создания RKObjectRequestOperation

RKObjectManager



• хранение списка дескрипторов

RKObjectManager



• хранение списка дескрипторов

• роутеры

• и т.д.

RKObjectManager

[[RKObjectManager sharedManager] getObjectsAtPath:@"applications"

parameters:nil

success:successBlock

failure:failureBlock];

[[RKObjectManager sharedManager] postObject:someObject

path:nil

parameters:nil

success:successBlock

failure:failureBlock];

Core Data

Как мэппить в Core Data?

• создать стек Core Data средствами RestKit

Как мэппить в Core Data?

• создать стек Core Data средствами RestKit

• вместо RKObjectMapping использовать RKEntityMapping

Создание стека Core Data

NSURL *modelURL = /* model URL */;

NSManagedObjectModel *managedObjectModel =

[[NSManagedObjectModel alloc]

initWithContentsOfURL:modelURL];


RKManagedObjectStore *managedObjectStore =

[[RKManagedObjectStore alloc]

initWithManagedObjectModel:managedObjectModel];


[managedObjectStore createPersistentStoreCoordinator];

NSPersistentStore __unused *persistentStore =

[managedObjectStore addInMemoryPersistentStore:&error];

NSAssert(persistentStore, @"Failed to add persistent store: %@", error);


[managedObjectStore createManagedObjectContexts];

[RKManagedObjectStore setDefaultStore:managedObjectStore];


[NSPersistentStoreCoordinator

MR_setDefaultStoreCoordinator:managedObjectStore.persistentStoreCoordinat

or];

[NSManagedObjectContext

MR_setRootSavingContext:managedObjectStore.persistentStoreManagedObje

ctContext];

[NSManagedObjectContext

MR_setDefaultContext:managedObjectStore.mainQueueManagedObjectContext];

Мэппинг в Core Data

{ "applications": [

{ "title": "Афиша-Рестораны","body": "Самый быстрый и удобный способ выбрать

в какой ресторан или бар пойти","author": "Илья Пучка","publication_date": "13/11/2014","id": 12

}]

}

Мэппинг в Core Data

@interface Application: NSManagedObject

@property (nonatomic, retain) NSNumber* applicationID;

@property (nonatomic, retain) NSString* title;

@property (nonatomic, retain) NSString* body;

@property (nonatomic, retain) NSDate* publicationDate;

@end

RKEntityMapping

RKEntityMapping* appMapping =

[RKEntityMapping mappingForEntityForName:@"Application"

inManagedObjectStore:managedObjectStore];


@"id": @"applicationID",

@"title": @"title",

@"body": @"body",

@"publication_date": @"publicationDate"

}];

appMapping.identificationAttributes = @[ @"applicationID" ];

Connection

{ "applications": [

{ "appID": 12, "title": "Афиша-Рестораны" },

{ "appID": 11, "title": "Redigo" }

],

"users": [

{ "userID":101, "userName": "Стас Цыганов", "appID": 11 },

{ "userID":102, "userName": "Илья Пучка", "appID": 12 },

{ "userID":103, "userName": "Ash Furrow", "appID": 11 }

]

}

Connection

@interface Application: NSManagedObject

@property (nonatomic, retain) NSNumber* appID;

@property (nonatomic, retain) NSString* title;

@end

@interface User: NSManagedObject

@property (nonatomic, retain) NSNumber* userID;

@property (nonatomic, retain) NSString* userName;

@property (nonatomic, retain) NSNumber* appID;

@property (nonatomic, retain) Application* app;

@end

Connection

[userMapping addConnectionForRelationship:@"app"connectedBy:@{@"appID": @"appID"}];

RKManagedObjectRequestOperation

• создается с NSManagedObjectContext

RKManagedObjectRequestOperation

• создается с NSManagedObjectContext

• удаляет orphaned objects

Спасибо!

rambler.ios #2: Введение в restkit

Technology