Егор Тафланиди (Redmadrobot) Доклад будет включать в себя рассмотрения стека бизнес-логики, построенного с помощью автоматически сгенерированного кода, и сопряжение этого стека с сервером по всем REST'овым правилам. Вилка к розетке

1. REST-SOA-Controller-View:
Проектирование обмена данными
Егор Тафланиди19/03/2016
et@redmadrobot.com

2. Агенда
- Опрос аудитории
- Слои
- Сервер
- Протокол
- Мобильное приложение
- Пример
01

3. 02
Опрос аудитории

4. 03
Польза

5. Агенда
- Опрос аудитории
- Слои
- Сервер
- Протокол
- Мобильное приложение
- Пример
04

6. Агенда
- Опрос аудитории
- Слои
- Сервер
- Протокол
- Мобильное приложение
- Пример
04

7. - Domain-Specific Language
- DSL-интерфейс
- Обмен модельными объектами
Слои
05
СВОЙСТВА
Entity
• id { get set }
/* no logic */

8. Агенда
- Опрос аудитории
- Слои
- Сервер
- Протокол
- Мобильное приложение
- Пример
06
Entity
• id { get set }!

9. - База данных
Сервер
07
СТРУКТУРА
Table: User
id name surname
1 Иван Иванов
2 Сидор Сидоров

10. - База данных
Сервер
07
СТРУКТУРА
Table: User
name surname
Иван Иванов
Сидор Сидоров
id
1
2

11. - База данных
Сервер
08
СТРУКТУРА
Table: User
name surname
Иван Иванов
Сидор Сидоров
id
1
2
=>
User
• id
• name
• surname

12. - ORM вычитывает объект из базы
- DAO транслирует ORM-объект в POJO
Сервер
09
СТРУКТУРА: ПУТЕШЕСТВИЕ ENTITY
User
• id
• name
• surname
ORM
Database
DAO
ORM Object
Business
Logic
Object

13. Сервер
10
User
• id
• name
• surname
Business
Logic
Serialiser
Object
Transport
DT Object
- ORM вычитывает объект из базы
- DAO транслирует ORM-объект в POJO
- Бизнес-логика транслирует POJO в DTO
СТРУКТУРА: ПУТЕШЕСТВИЕ ENTITY

14. Сервер
11
User
• id
• name
• surname
Transport HTTP
JSON
Mobile
App
JSON
…
- ORM вычитывает объект из базы
- DAO транслирует ORM-объект в POJO
- Бизнес-логика транслирует POJO в DTO
- Транспорт транслирует DTO в JSON
- JSON передаётся на фронт
СТРУКТУРА: ПУТЕШЕСТВИЕ ENTITY

15. Сервер
12
СТРУКТУРА: TYPE STACK
User
ORM
Database
DAO
Business
Logic
Serialiser
Transport
…
Product
ORM
Database
DAO
Business
Logic
Serialiser
Transport
…
Message
ORM
Database
DAO
Business
Logic
Serialiser
Transport
…
…

16. Сервер
13
СЕРВИСЫ
User
Product
Message
} Набор
Web-сервисов

17. 14
Протокол
REST

18. Протокол
15
RESOURCE
Resource R is a temporally varying membership
function MR(t), which for time t
maps to a set of entities
/ Representational State Transfer, dissertation /
http://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm

19. Протокол
16
ENTITY & URL ENDPOINT
/entities
(resource)
Array(Entity)
Entity
• id { get set }

20. Протокол
16
ENTITY & WEB SERVICE
: REntity
POST /entities
GET /entities
GET /entities/{id}
PATCH /entities/{id}
DELETE /entities/{id}
/entities
(resource)
Entity
• id { get set }

21. Протокол
17
C.R.U.D.
POST /entities
GET /entities
GET /entities/{id}
PATCH /entities/{id}
DELETE /entities/{id}
Create
Read
Update
Delete
Entity
• id { get set }∀

22. Протокол
18
ВЛОЖЕННОСТЬ. ДОВЕРИЕ К СЕРВЕРУ
User
• id: Long
• name: String
PATCH /users/{id}/name
User
• id: Long
• name: String
/* name patched */

23. Агенда
- Опрос аудитории
- Слои
- Сервер
- Протокол
- Мобильное приложение
- Пример
19

24. 20
Мобильное приложение
SDK MVC

25. Мобильное приложение
- Тип данных = ключевая сущность
- Разница в логике = набор полей
21
SERVICE-ORIENTED ARCHITECTURE
Entity
ORM
Database
DAO
Business
Logic
Serialiser
Transport
…

26. 22
Мобильное приложение
SERVICE-ORIENTED ARCHITECTURE
SERVICE

27. 22
SERVICE
TRANSPORT
Мобильное приложение
SERVICE-ORIENTED ARCHITECTURE

28. 22
SERVICE
TRANSPORT
SERIALIZERPARSER
Мобильное приложение
SERVICE-ORIENTED ARCHITECTURE

29. 22
SERVICE
TRANSPORT
SERIALIZERPARSER
Мобильное приложение
SERVICE-ORIENTED ARCHITECTURE

30. 22
SERVICE
DATABASE
Мобильное приложение
SERVICE-ORIENTED ARCHITECTURE
DAO

31. 22
Мобильное приложение
SERVICE-ORIENTED ARCHITECTURE
SERVICESERVICE SERVICE

32. 22
SERVICESERVICE SERVICE
SERVICE LAYER
Мобильное приложение
SERVICE-ORIENTED ARCHITECTURE

33. 22
SERVICESERVICE SERVICE
SERVICE LAYER
Мобильное приложение
SERVICE-ORIENTED ARCHITECTURE
CONTROLLER

34. 23
Интерлюдия: многопоточность
CALLBACK HELL

35. Callback Hell
24

36. 24
T1
T2
T3
T4
Callback Hell

37. 24
T1
T2
T3
T4
CONTROLLER
Callback Hell

38. 24
T1
T2
T3
T4
CONTROLLER SERVICE
Callback Hell

39. 24
T1
T2
T3
T4
CONTROLLER SERVICE SERIALIZER
Callback Hell

40. 24
T1
T2
T3
T4
CONTROLLER SERVICE SERIALIZER SERVICE
Callback Hell

41. 24
T1
T2
T3
T4
CONTROLLER SERVICE SERIALIZER SERVICE TRANSPORT
Callback Hell

42. 24
T2
T1
T3
T4
CONTROLLER SERVICE SERIALIZER SERVICE TRANSPORT
Callback Hell

43. 24
T2
T1
T3
T4
CONTROLLER SERVICE SERIALIZER SERVICE TRANSPORT PARSER
Callback Hell

44. 24
T2
T1
T3
T4
CONTROLLER SERVICE SERIALIZER SERVICE TRANSPORT PARSER
Callback Hell

45. 24
T2
T1
T3
T4
CONTROLLER SERVICE SERIALIZER SERVICE TRANSPORT DBPARSER
Callback Hell

46. 24
T2
T1
T3
T4
CONTROLLER SERVICE SERIALIZER SERVICE TRANSPORT DBPARSER
Callback Hell

47. 24
T2
T1
T3
T4
CONTROLLER SERVICE SERIALIZER SERVICE TRANSPORT …PARSER DB
Callback Hell

48. 24
T2
T1
T3
T4
SERVICE TRANSPORT PARSER DBSERVICE SERVICE SERVICE
Callback Hell

49. 24
T2
T1
T3
T4
SERVICE TRANSPORT PARSER DBSERVICE SERVICE SERVICE
RESULT
Callback Hell

50. 24
T2
T1
SERVICE PARSERSERVICE SERVICE DB SERVICE …TRANSPORT
Callback Hell

51. 24
T2
T1
SERVICE PARSERSERVICE SERVICE DB SERVICE …TRANSPORT
OPERATION
Callback Hell

52. Operation
25
id result = transport.obtain(parameters)
id object = parser.parse(result)
db.save(object)
return object

53. Operation
26
dispatch_async(background_queue, ^{
id result = transport.obtain(parameters)
id object = parser.parse(result)
db.save(object)
dispatch_async(main_queue, ^{
completionBlock(object)
})
})

54. Operation
27
– (void)main {
id result = transport.obtain(parameters)
id object = parser.parse(result)
db.save(object)
completionBlock(object)
}
@interface Operation : NSOperation
…
@implementation Operation

55. Агенда
- Опрос аудитории
- Слои
- Сервер
- Протокол
- Мобильное приложение
- Пример
28

56. 00
Пример
SERVICE LAYER

57. 01
Transport

58. 02
Transport
- CRUD ~ URL endpoint + HTTP method + parameters
- ~ Web service base URL
- Семафор в качестве «выпрямителя» потоков
SYNCHRONOUS

59. 03
/**
Операция «Получить коллекцию сущностей».
Пример:
GET http://api.customer.com/v1/entitites
$headers
@param parameters - параметры запроса. @see TransportationParameters
@return Возвращает результат выполнения операции.
*/
- (TransportationResult *)obtainAllWithParameters:(TransportationParameters *)parameters;
Transport
SYNCHRONOUS

60. 03
/**
Операция «Обновить значение свойства сущности».
Пример:
PATCH http://api.customer.com/v1/entitites/{entityId}/{property}
$headers
{ $body_parameters }
@param entityId - идентификатор сущности;
@param property - название свойства сущности;
@param parameters - параметры запроса. @see TransportationParameters
@return Возвращает результат выполнения операции.
*/
- (TransportationResult *)updateWithId:(NSString *)entityId
property:(NSString *)property
parameters:(TransportationParameters *)parameters;
Transport
SYNCHRONOUS

61. 04
Parser

62. 05
Parser
- Наличие объекта = наличие всех его обязательных
полей
- Для пользователя ошибки «парсер не смог
распознать данные» и «данные не пришли» будут
иметь одинаковые последствия
- Не стоит городить непробиваемую «оборону»
- Приложению нужны объекты, а не топология
BLIND

63. 06
Parser
BLIND
@interface Parser<__covariant Entity> : NSObject
- (NSArray *)parseAll:(id)json;
- (BOOL)parsable:(NSDictionary *)json;
- (Class)objectClass;
- (NSDictionary *)mapping;
- (Entity)sanitize:(Entity)object;
- (Entity)fulfill:(Entity)object
from:(NSDictionary *)json;
@end

64. 07
Parser
EXAMPLE
{
"id": 1,
"dict":{
"id": "3",
"text":"annotation"
},
"array":[
{
"id":4,
"text":"description",
"note":"FYI"
}
]
}
Entity
• id
• text
• note

65. 08
Parser
EXAMPLE
@interface Parser<__covariant Entity> : NSObject
- (NSArray *)parseAll:(id)json;
- (BOOL)parsable:(NSDictionary *)json;
- (Class)objectClass;
- (NSDictionary *)mapping;
- (Entity)sanitize:(Entity)object;
- (Entity)fulfill:(Entity)object
from:(NSDictionary *)json;
@end

66. – parseAll:
09
Parser
EXAMPLE
{
"id": 1,
"dict":{
"id": "3",
"text":"annotation"
},
"array":[
{
"id":4,
"text":"description",
"note":"FYI"
}
]
}

67. – parseAll:
10
Parser
EXAMPLE
{
"id": 1,
"dict":{
"id": "3",
"text":"annotation"
},
"array":[
{
"id":4,
"text":"description",
"note":"FYI"
}
]
}

68. 11
Parser
EXAMPLE
@interface Parser<__covariant Entity> : NSObject
- (NSArray *)parseAll:(id)json;
- (BOOL)parsable:(NSDictionary *)json;
- (Class)objectClass;
- (NSDictionary *)mapping;
- (Entity)sanitize:(Entity)object;
- (Entity)fulfill:(Entity)object
from:(NSDictionary *)json;
@end

69. – parseable:
12
Parser
EXAMPLE
{
"id": 1,
"dict":{
"id": "3",
"text":"annotation"
},
"array":[
{
"id":4,
"text":"description",
"note":"FYI"
}
]
}

70. – parseable:
12
Parser
EXAMPLE
{
"id": 1,
"dict":{
"id": "3",
"text":"annotation"
},
"array":[
{
"id":4,
"text":"description",
"note":"FYI"
}
]
}

71. – parseable:
12
Parser
EXAMPLE
{
"id": 1,
"dict":{
"id": "3",
"text":"annotation"
},
"array":[
{
"id":4,
"text":"description",
"note":"FYI"
}
]
}

72. – parseAll:
12
Parser
EXAMPLE
{
"id": 1,
"dict":{
"id": "3",
"text":"annotation"
},
"array":[
{
"id":4,
"text":"description",
"note":"FYI"
}
]
}

73. – parseAll:
12
Parser
EXAMPLE
{
"id": 1,
"dict":{
"id": "3",
"text":"annotation"
},
"array":[
{
"id":4,
"text":"description",
"note":"FYI"
}
]
}

74. 12
Parser
EXAMPLE
{
"id": 1,
"dict":{
"id": "3",
"text":"annotation"
},
"array":[
{
"id":4,
"text":"description",
"note":"FYI"
}
]
}
– parseAll:

75. 12
Parser
EXAMPLE
{
"id": 1,
"dict":{
"id": "3",
"text":"annotation"
},
"array":[
{
"id":4,
"text":"description",
"note":"FYI"
}
]
}
– parseAll:

76. 12
Parser
EXAMPLE
{
"id": 1,
"dict":{
"id": "3",
"text":"annotation"
},
"array":[
{
"id":4,
"text":"description",
"note":"FYI"
}
]
}
– parseable:

77. 12
Parser
EXAMPLE
{
"id": 1,
"dict":{
"id": "3",
"text":"annotation"
},
"array":[
{
"id":4,
"text":"description",
"note":"FYI"
}
]
}
– parseable:

78. 13
Parser
EXAMPLE
@interface Parser<__covariant Entity> : NSObject
- (NSArray *)parseAll:(id)json;
- (BOOL)parsable:(NSDictionary *)json;
- (Class)objectClass;
- (NSDictionary *)mapping;
- (Entity)sanitize:(Entity)object;
- (Entity)fulfill:(Entity)object
from:(NSDictionary *)json;
@end

79. 14
Parser
EXAMPLE
{
"id": 1,
"dict":{
"id": "3",
"text":"annotation"
},
"array":[
{
"id":4,
"text":"description",
"note":"FYI"
}
]
}
– parseable:
Entity
• id = "3"
• text = "annotation"
• note = nil

80. 14
Parser
EXAMPLE
{
"id": 1,
"dict":{
"id": "3",
"text":"annotation"
},
"array":[
{
"id":4,
"text":"description",
"note":"FYI"
}
]
}
Entity
• id = "3"
• text = "annotation"
• note = nil
– sanitize:

81. 14
Parser
EXAMPLE
{
"id": 1,
"dict":{
"id": "3",
"text":"annotation"
},
"array":[
{
"id":4,
"text":"description",
"note":"FYI"
}
]
}
Entity
• id = "3"
• text = "annotation"
• note = nil
– sanitize:

82. 14
Parser
EXAMPLE
{
"id": 1,
"dict":{
"id": "3",
"text":"annotation"
},
"array":[
{
"id":4,
"text":"description",
"note":"FYI"
}
]
}
Entity
• id = 3
• text = "annotation"
• note = nil
– sanitize:

83. 14
Parser
EXAMPLE
{
"id": 1,
"dict":{
"id": "3",
"text":"annotation"
},
"array":[
{
"id":4,
"text":"description",
"note":"FYI"
}
]
}
Entity
• id = 3
• text = "annotation"
• note = nil
– fulfill:

84. – parseAll:
15
Parser
EXAMPLE
{
"id": 1,
"dict":{
"id": "3",
"text":"annotation"
},
"array":[
{
"id":4,
"text":"description",
"note":"FYI"
}
]
}

85. – parseAll:
15
Parser
EXAMPLE
{
"id": 1,
"dict":{
"id": "3",
"text":"annotation"
},
"array":[
{
"id":4,
"text":"description",
"note":"FYI"
}
]
}

86. 15
Parser
EXAMPLE
{
"id": 1,
"dict":{
"id": "3",
"text":"annotation"
},
"array":[
{
"id":4,
"text":"description",
"note":"FYI"
}
]
}
– parseAll:

87. 15
Parser
EXAMPLE
{
"id": 1,
"dict":{
"id": "3",
"text":"annotation"
},
"array":[
{
"id":4,
"text":"description",
"note":"FYI"
}
]
}

88. 15
Parser
EXAMPLE
{
"id": 1,
"dict":{
"id": "3",
"text":"annotation"
},
"array":[
{
"id":4,
"text":"description",
"note":"FYI"
}
]
}
=> [Entity]

89. 16
DAO
ШАБЛОН ПРОЕКТИРОВАНИЯ

90. 17
DAO
- Взаимодействие с DAO посредством
модельных объектов (Entity : NSObject) => изоляция
- Инжектируемость
- Потокобезопасность
- «Соединение» с базой данных
- Транзакционность
ИДЕОЛОГИЯ

91. 18
DAO
- persist(Entity) -> BOOL
- persistAll(Array<Entity>) -> BOOL
- read(ID) -> Entity
- readAll() -> Array<Entity>
- erase(ID) -> BOOL
- eraseAll() -> BOOL
ИНТЕРФЕЙС

92. 19
Entity Translator
ШАБЛОН ПРОЕКТИРОВАНИЯ

93. 20
Entity Translator
Entity
• id
• text
• note
=>
<=
{
"id":4,
"text":"description",
"note":"FYI"
}
EntityDTO : NSDictionary

94. 20
Entity Translator
Entity
• id
• text
• note
=>
<=
ORMEntity
• id
• text
• note

95. 21
DAO TRANSLATOR
Entity Translator
@interface RealmTranslator : NSObject
- (RLMEntry *)toEntry:(id <Persistable>)entity;
- (id<Persistable>)toEntity:(RLMEntry *)entry;
- (NSString *)entryClass;
@end

96. 22
DAO TRANSLATOR
Entity Translator
{
let dao: DAO = RealmDAO(translator: translator)
}

97. 23
Entity Translator
КОДОГЕНЕРАЦИЯ

98. 24
Entity Translator
КОДОГЕНЕРАЦИЯ
/**
Последняя транзакция.
@json last_transaction
@mandatory
@realm lastTransaction
*/
@property (…) Transaction *lastTransaction;

99. 25
Service

100. 26
Service
- Инстанциирование утилит (?)
- Набор виртуальных конструкторов
- Координация данных между утилитами
- Многопоточность, инстанциирование операций
- Асинхронный интерфейс для верхнего слоя UI
ОТВЕТСТВЕННОСТЬ

101. 27
Service Layer
ИНВЕРТЕР ЗАВИСИМОСТЕЙ

102. 28
Service Layer
- Инстанциирование сервисов
- Инжектирование сервисов
- Инжектирование очередей запросов
ОТВЕТСТВЕННОСТЬ

103. Итоги
- REST
- SOA
- Многопоточность = зло
- Пример реализации сервисного уровня

104. ВОПРОСЫ ЕСТЬ?ВОПРОСОВ НЕТ!
Егор Тафланиди
et@redmadrobot.com