Rambler.iOS #2: Введение в RestKit (Крапивенский Сергей) Rambler.iOS - митапы iOS-разработчиков, организуемые компанией Rambler&Co.

1. RestKit

2. Что такое RestKit?
• Фреймворк для взаимодействия с RESTful API

3. Что такое RestKit?
• Фреймворк для взаимодействия с RESTful API
• Разрабатывается с 2011 года

4. Что такое RestKit?
• Фреймворк для взаимодействия с RESTful API
• Разрабатывается с 2011 года
• 7750 🌟 на GitHub

5. Что такое RestKit?
• Фреймворк для взаимодействия с RESTful API
• Разрабатывается с 2011 года
• 7750 🌟 на GitHub
• 4 коммита от Сергея Крапивенского 👸

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

7. Терминология
• mapping – преобразование данных из одного
представления в другое
• source – объект, из которого производится
мэппинг

8. Терминология
• mapping – преобразование данных из одного
представления в другое
• source – объект, из которого производится
мэппинг
• destination – объект, в который производится
мэппинг

9. Терминология
• mapping – преобразование данных из одного
представления в другое
• source – объект, из которого производится
мэппинг
• destination – объект, в который производится
мэппинг
• АПИ – лень выговаривать ЭйПиАй

10. Зачем он мне?

11. Зачем он мне?
• API клиент и мэппинг в одном флаконе

12. Зачем он мне?
• API клиент и мэппинг в одном флаконе
• Упрощает жизнь при работе с плохим JSON

13. Зачем он мне?
• API клиент и мэппинг в одном флаконе
• Упрощает жизнь при работе с плохим JSON
• Легкий мэппинг напрямую в Core Data

14. Зачем он мне?
• API клиент и мэппинг в одном флаконе
• Упрощает жизнь при работе с плохим JSON
• Легкий мэппинг напрямую в Core Data
• Мэппинг можно прикрутить к другому сетевому
стеку

15. Зачем он мне?
• API клиент и мэппинг в одном флаконе
• Упрощает жизнь при работе с плохим JSON
• Легкий мэппинг напрямую в Core Data
• Мэппинг можно прикрутить к другому сетевому
стеку
• Упрощает тестирование мэппинга

16. ОДНАКО

17. Минусы
• Много issues на GitHub

18. Минусы
• Много issues на GitHub
• Сетевой слой использует AFNetworking 1.0

19. Минусы
• Много issues на GitHub
• Сетевой слой использует AFNetworking 1.0
• Много задач на одну библиотеку

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

21. Составные части
• Object Mapping

22. Составные части
• Object Mapping
• Network

23. Составные части
• Object Mapping
• Network
• Core Data

24. Составные части
• Object Mapping
• Network
• Core Data
• Testing

25. Object Mapping
RKMapping
RKObjectMapping
RKEntityMapping
RKDynamicMapping

26. RKObjectMapping
• класс объекта-назначения
• набор объектов типа RKPropertyMapping

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

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

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

30. Пример
{ "applications": [
{ "title": "Афиша-Рестораны",
"body": "Самый быстрый и удобный способ выбрать в какой ресторан
или бар пойти",
"author": "Илья Пучка",
"publication_date": "13/11/2014"
},
{ "title": "Redigo",
"body": "Удобный компактный гид по странам мира от Австралии до
Японии в вашем телефоне",
"author": "Стас Цыганов",
"publication_date": "30/01/2015"
}]
}

31. Пример
@interface Application: NSObject
@property (nonatomic, copy) NSString* title;
@property (nonatomic, copy) NSString* body;
@property (nonatomic, copy) NSString* author;
@property (nonatomic) NSDate* publicationDate;
@end

32. RKObjectMapping
RKObjectMapping* appMapping =
[RKObjectMapping mappingForClass:[Application class]];
[appMapping addAttributeMappingsFromDictionary:@{
@"title": @"title",
@"body": @"body",
@"author": @"author",
@"publication_date": @"publicationDate"
}];

33. RKObjectMapping
То же самое что и:
[appMapping addPropertyMapping:
[RKAttributeMapping attributeMappingFromKeyPath:@"title"
toKeyPath:@"title"]];
[appMapping addPropertyMapping:
[RKAttributeMapping attributeMappingFromKeyPath:@"body"
toKeyPath:@"body"]];
и т.д.

34. Приведение типов
• NSString -> NSDate с помощью NSDateFormatter
• NSString -> NSURL
• NSString -> NSNumber
• NSString с булевыми значениями (YES, NO,
false и тд) -> NSNumber
• NSNumber -> NSDate
• предустановленные NSDateFormatter’ы
• и многое другое (свое собственное
преобразование можно задать блоком)

35. Связь запроса и мэппинга
• Для связи запроса с мэппингом есть
специальный класс - RKResponseDescriptor
• Для сериализации объектов перед
отправкой на сервер используется похожий
класс RKRequestDescriptor

36. Параметры RKResponseDescriptor
• mapping

37. Параметры RKResponseDescriptor
• mapping
• method - тип REST-метода

38. Параметры RKResponseDescriptor
• mapping
• method - тип REST-метода
• pathPattern – относительный URL запроса

39. Параметры RKResponseDescriptor
• mapping
• method - тип REST-метода
• pathPattern – относительный URL запроса
• keyPath

40. Параметры RKResponseDescriptor
• mapping
• method - тип REST-метода
• pathPattern – относительный URL запроса
• keyPath
• statusCodes – NSIndexSet статус-кодов

41. Параметры RKResponseDescriptor
• mapping = appMapping
• method = RKRequestMethodAny
• pathPattern = nil
• keyPath = @”applications”
• statusCodes =
RKStatusCodeIndexSetForClass(RKStatusCode
ClassSuccessful)

43. RKResponseDescriptor
• [[RKObjectManager sharedManager]
addResponseDescriptor:responseDescriptor];
• список дескрипторов анализируется при запросе
• после добавления дескриптора можно посылать
запросы и обрабатывать ответ

44. Мэппинг графа объектов
{
”applications": [
{
"title": "Redigo",
"body": "Удобный компактный гид по странам мира от Австралии до
Японии в вашем телефоне",
"author": {
"name": "Стас Цыганов",
"email": "secretStasEmail@rambler-co.ru"
},
"publication_date": "30/01/2015"
}
]
}

45. Мэппинг графа объектов
@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

46. Мэппинг графа объектов
RKObjectMapping* authorMapping =
[RKObjectMapping mappingForClass:[Author class] ];
[authorMapping addAttributeMappingsFromArray:@[
@"name", @"email" ]];

47. Мэппинг графа объектов
RKObjectMapping* appMapping =
[RKObjectMapping mappingForClass:[Application class] ];
[appMapping addAttributeMappingsFromDictionary:@{
@"title": @"title",
@"body": @"body”,
@"publication_date": @"publicationDate”
}];

48. RKRelationshipMapping
[appMapping addPropertyMapping:
[RKRelationshipMapping relationshipMappingFromKeyPath:@"author”
toKeyPath:@"author”
withMapping:authorMapping]];

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

50. Мэппинг кривого JSON
Мэппинг без KVC:
[
{ "title": "Redigo",
"body": "Удобный компактный гид по странам мира от
Австралии до Японии в вашем телефоне",
"author": {
"name": "Стас Цыганов",
"email": "secretStasEmail@rambler-co.ru"
},
"publication_date": “30/01/2015"
}
]

51. Мэппинг кривого JSON
Что делать?
• у дескриптора сделать keyPath = nil
• PROFIT

52. Мэппинг кривого JSON
NSIndexSet *success = RKStatusCodeIndexSetForClass(RKStatusCodeClassSuccessful);
RKResponseDescriptor *responseDescriptor =
[RKResponseDescriptor responseDescriptorWithMapping:appMapping
method:RKRequestMethodAny
pathPattern:@"/applications"
keyPath:nil
statusCodes:success];

53. Мэппинг кривого JSON
Массив простых значений:
{ "developers":
["Егор Толстой",
"Герман Сапрыкин",
"Андрей Резанов"] }

54. Мэппинг кривого JSON
@interface RamblerDeveloper: NSObject
@property (nonatomic, copy) NSString *name;
@end

55. Мэппинг кривого JSON
RKObjectMapping *userMapping = [RKObjectMapping
mappingForClass:[RamblerDeveloper class]];
[userMapping addPropertyMapping:
[RKAttributeMapping attributeMappingFromKeyPath:nil
toKeyPath:@”name"]];

56. Мэппинг кривого JSON
{
"first_name": "Егор",
"last_name": "Толстой",
"city": "Москва",
"country": "Россия",
"zip": 128405
}

57. Мэппинг кривого JSON
@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

58. Мэппинг кривого JSON
RKObjectMapping *addressMapping =
[RKObjectMapping mappingForClass:[ExampleAddress class]];
[addressMapping addAttributeMappingsFromDictionary:@{
@"city": @"city",
@”country": @"country",
@"zip": @"zipCode”
}];

59. Мэппинг кривого JSON
RKObjectMapping *userMapping =
[RKObjectMapping mappingForClass:[ExampleUser class]];
[userMapping addAttributeMappingsFromDictionary:@{
@"first_name": @"firstName",
@"last_name": @"lastName“
}];

60. Мэппинг кривого JSON
[userMapping addPropertyMapping:
[RKRelationshipMapping
relationshipMappingFromKeyPath:nil
toKeyPath:@"address"
withMapping:addressMapping]];

61. Мэппинг кривого JSON
{
"Сергей": {
"email": "sergeyEmail@rambler-co.ru",
"age": 28
}
}

62. Мэппинг кривого JSON
@interface User : NSObject
@property (nonatomic, copy) NSString* email;
@property (nonatomic, copy) NSString* username;
@property (nonatomic, copy) NSNumber* age;
@end

63. Мэппинг кривого JSON
RKObjectMapping* mapping =
[RKObjectMapping mappingForClass:[User class] ];
[mapping addAttributeMappingFromKeyOfRepresentationToAttribute:@"username"];
[mapping addAttributeMappingsFromDictionary:@{
@"(username).email": @"email",
@"(username).age": @"age”
}];

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

65. RKDynamicMapping
• заранее неизвестно какой мэппинг
потребуется
• нужный RKObjectMapping подбирается при
анализе полученных данных

66. RKDynamicMapping
• заранее неизвестно какой мэппинг
потребуется
• нужный RKObjectMapping подбирается при
анализе полученных данных
• выбор осуществляется с помощью блока

67. RKDynamicMapping
• заранее неизвестно какой мэппинг
потребуется
• нужный RKObjectMapping подбирается при
анализе полученных данных
• выбор осуществляется с помощью блока
• или при анализе аттрибута в JSON с
помощью класса RKObjectMappingMatcher

68. Network

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

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

71. RKObjectRequestOperation
• наследуется от NSOperation
• управляет жизненным циклом HTTP-
запроса
• обрабатывает ответ с помощью движка
мэппинга

72. RKObjectRequestOperation
1) создаем NSURLRequest с нужным URL
NSURL *URL = [NSURL URLWithString:@"http://rambler.ru/applications"];
NSURLRequest *request = [NSURLRequest requestWithURL:URL];

73. RKObjectRequestOperation
2) создаем операцию с созданным реквестом и
дескриптором
RKObjectRequestOperation *objectRequestOperation =
[[RKObjectRequestOperation alloc] initWithRequest:request
responseDescriptors:@[ responseDescriptor ]];

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

75. RKObjectRequestOperation
4) запускаем операцию
[objectRequestOperation start];

76. RKObjectRequestOperation
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];

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

78. Цикл RKObjectRequestOperation
2) в случае успеха инициализируется
RKMapperResponseOperation и обрабатывает response. на
вход ей подается:
• NSURLRequest
• NSHTTPURLResponse
• response data (NSData)
• массив дескрипторов

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

80. Цикл RKObjectRequestOperation
4) если объект можно десериализовать, то создается
RKMapperOperation с полученным объектом и словарем, где
ключом является keyPath, а значением – мэппинг
@{ "applications" : appMapping }

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

82. Пример
Исходный словарь:
{ "applications": [
{ "title": "Афиша-Рестораны",
"body": "Самый быстрый и удобный способ выбрать в какой ресторан или бар
пойти",
"author": "Илья Пучка",
"publication_date": "13/11/2014"
},
{ "title": "Redigo",
"body": "Удобный компактный гид по странам мира от Австралии до Японии в
вашем телефоне",
"author": "Стас Цыганов",
"publication_date": "30/01/2015"
}]
}

83. Пример
После вызова у него valueForKeyPath:@"applications":
NSArray
{
title = "Афиша-Рестораны”;
body = "Самый быстрый и удобный способ выбрать в какой ресторан или бар
пойти”;
author = "Илья Пучка";
publication_date = "13/11/2014";
},
{
title = "Redigo";
body = "Удобный компактный гид по странам мира от Австралии до Японии в
вашем телефоне”;
author = "Стас Цыганов";
publication_date = "30/01/2015";
}

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

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

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

87. RKObjectManager
• централизация настроек
• хэлперы для создания
RKObjectRequestOperation

88. RKObjectManager
• централизация настроек
• хэлперы для создания
RKObjectRequestOperation
• хранение списка дескрипторов

89. RKObjectManager
• централизация настроек
• хэлперы для создания
RKObjectRequestOperation
• хранение списка дескрипторов
• роутеры
• и т.д.

90. RKObjectManager
[[RKObjectManager sharedManager] getObjectsAtPath:@"applications"
parameters:nil
success:successBlock
failure:failureBlock];
[[RKObjectManager sharedManager] postObject:someObject
path:nil
parameters:nil
success:successBlock
failure:failureBlock];

91. Core Data

92. Как мэппить в Core Data?
• создать стек Core Data средствами RestKit

93. Как мэппить в Core Data?
• создать стек Core Data средствами RestKit
• вместо RKObjectMapping использовать
RKEntityMapping

94. Создание стека Core Data
NSURL *modelURL = /* model URL */;
NSManagedObjectModel *managedObjectModel =
[[NSManagedObjectModel alloc]
initWithContentsOfURL:modelURL];

95. Создание стека Core Data
RKManagedObjectStore *managedObjectStore =
[[RKManagedObjectStore alloc]
initWithManagedObjectModel:managedObjectModel];

96. Создание стека Core Data
[managedObjectStore createPersistentStoreCoordinator];
NSPersistentStore __unused *persistentStore =
[managedObjectStore addInMemoryPersistentStore:&error];
NSAssert(persistentStore, @"Failed to add persistent store: %@", error);

97. Создание стека Core Data
[managedObjectStore createManagedObjectContexts];
[RKManagedObjectStore setDefaultStore:managedObjectStore];

98. Создание стека Core Data
[NSPersistentStoreCoordinator
MR_setDefaultStoreCoordinator:managedObjectStore.persistentStoreCoordinat
or];
[NSManagedObjectContext
MR_setRootSavingContext:managedObjectStore.persistentStoreManagedObje
ctContext];
[NSManagedObjectContext
MR_setDefaultContext:managedObjectStore.mainQueueManagedObjectConte
xt];

99. Мэппинг в Core Data
{
"applications": [
{ "title": "Афиша-Рестораны",
"body": "Самый быстрый и удобный способ выбрать
в какой ресторан или бар пойти",
"author": "Илья Пучка",
"publication_date": "13/11/2014",
"id": 12
}
]
}

100. Мэппинг в 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

101. RKEntityMapping
RKEntityMapping* appMapping =
[RKEntityMapping mappingForEntityForName:@"Application"
inManagedObjectStore:managedObjectStore];
[appMapping addAttributeMappingsFromDictionary:@{
@"id": @"applicationID",
@"title": @"title",
@"body": @"body",
@"publication_date": @"publicationDate"
}];
appMapping.identificationAttributes = @[ @"applicationID" ];

103. 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 }
]
}

104. 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

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

106. RKManagedObjectRequestOperation
• создается с NSManagedObjectContext

107. RKManagedObjectRequestOperation
• создается с NSManagedObjectContext
• удаляет orphaned objects

108. Спасибо!