Экологически чистая разработка

Сергей Михайлов

Transcript

1. Экологически чистая разработка Сергей Михайлов (iOS/C++ developer)
2. О чем пойдет речь
3. О чем пойдет речь
4. О чем пойдет речь
5. О чем пойдет речь
6. О чем пойдет речь
7. О чем пойдет речь
8. Экологически чистая разработка
9. Экологически чистая разработка
10. Экологически чистая разработка
11. Экологически чистая разработка
12. Но что не так с таким проектом?
13. Что же это за признаки
14. Что же это за признаки - Отсутствие тестов
15. Что же это за признаки - Отсутствие тестов - Отсутствие инженерной документации
16. Что же это за признаки - Отсутствие тестов - Отсутствие инженерной документации - Отсутствие единого стиля кодирования (code conventions)
17. Что же это за признаки
18. WTF?
19. How it works?
20. Давайте пройдемся по каждому из этих аспектов отдельно
21. Тесты
22. Тесты - Зачем нужны?
23. Тесты - Зачем нужны? - Убедиться, что ничего не сломал(а) в результате изменений
24. Тесты - Зачем нужны? - Убедиться, что ничего не сломал(а) в результате изменений
25. Тесты - Зачем нужны? - Убедиться, что ничего не сломал(а) в результате изменений - Уменьшение времени на “поверхностное” тестирование
26. Тесты - Зачем нужны? - Убедиться, что ничего не сломал(а) в результате изменений - Уменьшение времени на “поверхностное” тестирование - Показатель качества процесса разработки
27. Тесты - Зачем нужны? - Убедиться, что ничего не сломал(а) в результате изменений - Уменьшение времени на “поверхностное” тестирование - Показатель качества процесса разработки - Не страшно делать рефакторинги и оптимизации
28. Тесты - Зачем нужны? - Убедиться, что ничего не сломал(а) в результате изменений - Уменьшение времени на “поверхностное” тестирование - Показатель качества процесса разработки - Не страшно делать рефакторинги и оптимизации - Позволяет держать экосистему проекта на уровне “не ниже чем”
29. Тесты - Зачем нужны? - Убедиться, что ничего не сломал(а) в результате изменений - Уменьшение времени на “поверхностное” тестирование - Показатель качества процесса разработки - Не страшно делать рефакторинги и оптимизации - Позволяет держать экосистему проекта на уровне “не ниже чем” - Проект с тестами не стыдно передать следующим поколениям
30. Тесты
31. Тесты - Стоимость - Возможно не нужны на проектах класса MVP и prototype
32. Тесты - Стоимость - Возможно не нужны на проектах класса MVP и prototype - +20% ко времени разработки
33. Тесты - Стоимость - Возможно не нужны на проектах класса MVP и prototype - +20% ко времени разработки (TDD)
34. Тесты - На какие части продукта писать тесты
35. Тесты - На какие части продукта писать тесты - Протокол взаимодействия с РЕАЛЬНЫМ сервером
36. Тесты - На какие части продукта писать тесты - Протокол взаимодействия с РЕАЛЬНЫМ сервером. И это ОБЯЗАННОСТЬ разработчика мобильного приложения
37. Тесты - На какие части продукта писать тесты - Протокол взаимодействия с РЕАЛЬНЫМ сервером. И это ОБЯЗАННОСТЬ разработчика мобильного приложения - Математика
38. Тесты - На какие части продукта писать тесты - Протокол взаимодействия с РЕАЛЬНЫМ сервером. И это ОБЯЗАННОСТЬ разработчика мобильного приложения - Математика - ViewModel/Presenter
39. Тесты - На какие части продукта писать тесты - Протокол взаимодействия с РЕАЛЬНЫМ сервером. И это ОБЯЗАННОСТЬ разработчика мобильного приложения - Математика - ViewModel/Presenter - Persistence (CoreData)
40. Тесты - На какие части продукта НЕ писать тесты
41. Тесты - На какие части продукта НЕ писать тесты - UI
42. Тесты - Какие инструменты использовать
43. Тесты - Какие инструменты использовать - XCode, XCTest
44. Стиль кодирования (coding conventions)
45. Стиль кодирования (coding conventions) - (NSString *)legacyIDWithStorageID:(NSString *)withStorageID itemID:(NSString *)itemID { return [IALegacyID legacyIDWithStorageID:withStorageID itemID:itemID]; } - (NSString *) makeSha1From:(NSString *)string { return [string sha1]; } - (NSString*) cleansedFilename: (NSString*) name { return [name cleansedFilename]; }
46. Стиль кодирования (coding conventions) - (NSString *)legacyIDWithStorageID:(NSString *)withStorageID itemID:(NSString *)itemID { return [IALegacyID legacyIDWithStorageID:withStorageID itemID:itemID]; } - (NSString *) makeSha1From:(NSString *)string { return [string sha1]; } - (NSString*) cleansedFilename: (NSString*) name { return [name cleansedFilename]; }
47. Стиль кодирования (coding conventions) - (NSString *)legacyIDWithStorageID:(NSString *)withStorageID itemID:(NSString *)itemID { return [IALegacyID legacyIDWithStorageID:withStorageID itemID:itemID]; } - (NSString *) makeSha1From:(NSString *)string { return [string sha1]; } - (NSString*) cleansedFilename: (NSString*) name { return [name cleansedFilename]; }
48. Стиль кодирования (coding conventions) - (NSString *)legacyIDWithStorageID:(NSString *)withStorageID itemID:(NSString *)itemID { return [IALegacyID legacyIDWithStorageID:withStorageID itemID:itemID]; } - (NSString *) makeSha1From:(NSString *)string { return [string sha1]; } - (NSString*) cleansedFilename: (NSString*) name { return [name cleansedFilename]; }
49. Стиль кодирования (coding conventions) - (NSString *)legacyIDWithStorageID:(NSString *)withStorageID itemID:(NSString *)itemID { return [IALegacyID legacyIDWithStorageID:withStorageID itemID:itemID]; } - (NSString *) makeSha1From:(NSString *)string { return [string sha1]; } - (NSString*) cleansedFilename: (NSString*) name { return [name cleansedFilename]; }
50. Стиль кодирования (coding conventions) - (NSString *)legacyIDWithStorageID:(NSString *)withStorageID itemID:(NSString *)itemID { return [IALegacyID legacyIDWithStorageID:withStorageID itemID:itemID]; } - (NSString *) makeSha1From:(NSString *)string { return [string sha1]; } - (NSString*) cleansedFilename: (NSString*) name { return [name cleansedFilename]; }
51. Стиль кодирования (coding conventions) - (NSString *)legacyIDWithStorageID:(NSString *)withStorageID itemID:(NSString *)itemID { return [IALegacyID legacyIDWithStorageID:withStorageID itemID:itemID]; } - (NSString *) makeSha1From:(NSString *)string { return [string sha1]; } - (NSString*) cleansedFilename: (NSString*) name { return [name cleansedFilename]; }
52. Стиль кодирования (coding conventions) - (NSString *)legacyIDWithStorageID:(NSString *)withStorageID itemID:(NSString *)itemID { return [IALegacyID legacyIDWithStorageID:withStorageID itemID:itemID]; } - (NSString *) makeSha1From:(NSString *)string { return [string sha1]; } - (NSString*) cleansedFilename: (NSString*) name { return [name cleansedFilename]; }
53. Стиль кодирования (coding conventions) - (NSString *)legacyIDWithStorageID:(NSString *)withStorageID itemID:(NSString *)itemID { return [IALegacyID legacyIDWithStorageID:withStorageID itemID:itemID]; } - (NSString *) makeSha1From:(NSString *)string { return [string sha1]; } - (NSString*) cleansedFilename: (NSString*) name { return [name cleansedFilename]; }
54. Стиль кодирования (coding conventions) - (NSString*) legacyIDWithStorageID:(NSString*) withStorageID itemID:(NSString*) itemID { return [IALegacyID legacyIDWithStorageID:withStorageID itemID:itemID]; } - (NSString*) makeSha1From:(NSString*) string { return [string sha1]; } - (NSString*) cleansedFilename:(NSString*) name { return [name cleansedFilename]; }
55. Стиль кодирования (coding conventions)
56. Стиль кодирования (coding conventions) private func batchCopy(_ items: [StorageItem], _ mdriver: StorageDriverInternal & SupportingBatchOperations, _ folder: FolderItem) -> Observable<GroupStorageTask<StorageItem>> { return Observable .from(items) .flatMap { self.resolve(item: $0) } .toArray() .flatMap { mdriver.copy(items: $0, to: folder) } .map { $0.result } .filterNil() .flatMap { items -> Observable<StorageTask<StorageItem>> in let result = items .map { StorageTask<StorageItem>(item: $0, progress: 1.0, result: $0) } .map { Observable.just($0) } return Observable.from(result).concat() } .scan(GroupStorageTask(count: items.count)) { group, task in return group.updated(with: task) } }
57. Стиль кодирования (coding conventions) private func batchCopy(_ items: [StorageItem], _ mdriver: StorageDriverInternal & SupportingBatchOperations, _ folder: FolderItem) -> Observable<GroupStorageTask<StorageItem>> { return Observable .from(items) .flatMap { self.resolve(item: $0) } .toArray() .flatMap { mdriver.copy(items: $0, to: folder) } .map { $0.result } .filterNil() .flatMap { items -> Observable<StorageTask<StorageItem>> in let result = items .map { StorageTask<StorageItem>(item: $0, progress: 1.0, result: $0) } .map { Observable.just($0) } return Observable.from(result).concat() } .scan(GroupStorageTask(count: items.count)) { group, task in return group.updated(with: task) } }
58. Стиль кодирования (coding conventions) private func batchCopy(_ items: [StorageItem], _ mdriver: StorageDriverInternal & SupportingBatchOperations, _ folder: FolderItem) -> Observable<GroupStorageTask<StorageItem>> { return Observable .from(items) .flatMap { self.resolve(item: $0) } .toArray() .flatMap { mdriver.copy(items: $0, to: folder) } .map { $0.result } .filterNil() .flatMap { items -> Observable<StorageTask<StorageItem>> in let result = items .map { StorageTask<StorageItem>(item: $0, progress: 1.0, result: $0) } .map { Observable.just($0) } return Observable.from(result).concat() } .scan(GroupStorageTask(count: items.count)) { group, task in return group.updated(with: task) } }
59. Стиль кодирования (coding conventions) private func batchCopy(_ items: [StorageItem], _ mdriver: StorageDriverInternal & SupportingBatchOperations, _ folder: FolderItem) -> Observable<GroupStorageTask<StorageItem>> { return Observable .from(items) .flatMap { self.resolve(item: $0) } .toArray() .flatMap { mdriver.copy(items: $0, to: folder) } .map { $0.result } .filterNil() .flatMap { items -> Observable<StorageTask<StorageItem>> in let result = items .map { StorageTask<StorageItem>(item: $0, progress: 1.0, result: $0) } .map { Observable.just($0) } return Observable.from(result).concat() } .scan(GroupStorageTask(count: items.count)) { group, task in return group.updated(with: task) } }
60. Стиль кодирования (coding conventions) private func batchCopy(_ items: [StorageItem], _ mdriver: StorageDriverInternal & SupportingBatchOperations, _ folder: FolderItem) -> Observable<GroupStorageTask<StorageItem>> { return Observable .from(items) .flatMap { self.resolve(item: $0) } .toArray() .flatMap { mdriver.copy(items: $0, to: folder) } .map { $0.result } .filterNil() .flatMap { items -> Observable<StorageTask<StorageItem>> in let result = items .map { StorageTask<StorageItem>(item: $0, progress: 1.0, result: $0) } .map { Observable.just($0) } return Observable.from(result).concat() } .scan(GroupStorageTask(count: items.count)) { group, task in return group.updated(with: task) } }
61. Стиль кодирования (coding conventions)
62. Стиль кодирования (coding conventions) Completion blocks
63. Стиль кодирования (coding conventions) typealias CompletionBlock = () -> Void private func doSomething(completion: @escaping CompletionBlock) { doSomethingImpl(completion: completion) }
64. Стиль кодирования (coding conventions) typealias CompletionBlock = () -> Void private func doSomething(completion: @escaping CompletionBlock) { doSomethingImpl(completion: completion) } private func doSomethingImpl(completion: @escaping CompletionBlock) { doEvenMore(completion: completion) }
65. Стиль кодирования (coding conventions) typealias CompletionBlock = () -> Void private func doSomething(completion: @escaping CompletionBlock) { doSomethingImpl(completion: completion) } private func doSomethingImpl(completion: @escaping CompletionBlock) { doEvenMore(completion: completion) } private func finallyDoSomething(completion: @escaping CompletionBlock) { // Perform some work completion() }
66. Стиль кодирования (coding conventions) typealias CompletionBlock = () -> Void private func doSomething(completion: @escaping CompletionBlock) { doSomethingImpl(completion: completion) } private func doSomethingImpl(completion: @escaping CompletionBlock) { doEvenMore(completion: completion) } private func finallyDoSomething(completion: @escaping CompletionBlock) { // Perform some work completion() } doSomething { // Handle completion }
67. Стиль кодирования (coding conventions) typealias CompletionBlock = () -> Void private func doSomething(completion: @escaping CompletionBlock) { doSomethingImpl(completion: completion) } private func doSomethingImpl(completion: @escaping CompletionBlock) { doEvenMore(completion: completion) } private func finallyDoSomething(completion: @escaping CompletionBlock) { // Perform some work completion() } doSomething { // Handle completion } outerCode >>> doSomething >>> doSomethingImpl >>> finallyDoSomething
68. Стиль кодирования (coding conventions) typealias CompletionBlock = () -> Void private func doSomething(completion: @escaping CompletionBlock) { doSomethingImpl(completion: completion) } private func doSomethingImpl(completion: @escaping CompletionBlock) { doEvenMore(completion: completion) } private func finallyDoSomething(completion: @escaping CompletionBlock) { // Perform some work completion() } doSomething { // Handle completion } outerCode >>> doSomething >>> doSomethingImpl >>> finallyDoSomething outerCode <<< doSomething <<< doSomethingImpl <<< finallyDoSomething
69. Стиль кодирования (coding conventions) typealias CompletionBlock = () -> Void private func doSomething(completion: @escaping CompletionBlock) { doSomethingImpl(completion: completion) } private func doSomethingImpl(completion: @escaping CompletionBlock) { doEvenMore(completion: completion) } private func finallyDoSomething(completion: @escaping CompletionBlock) { // Perform some work completion() } doSomething { // Handle completion } outerCode >>> doSomething >>> doSomethingImpl >>> finallyDoSomething outerCode <<< finallyDoSomething
70. Стиль кодирования (coding conventions) typealias CompletionBlock = () -> Void private func doSomething(completion: @escaping CompletionBlock) { doSomethingImpl(completion: completion) } private func doSomethingImpl(completion: @escaping CompletionBlock) { doEvenMore(completion: completion) } private func finallyDoSomething(completion: @escaping CompletionBlock) { // Perform some work completion() } doSomething { // Handle completion } outerCode >>> doSomething >>> doSomethingImpl >>> finallyDoSomething outerCode <<< doSomething <<< doSomethingImpl <<< finallyDoSomething
71. Стиль кодирования (coding conventions) typealias CompletionBlock = () -> Void private func doSomething(completion: @escaping CompletionBlock) { doSomethingImpl { completion() } } private func doSomethingImpl(completion: @escaping CompletionBlock) { doEvenMore { completion() } } private func finallyDoSomething(completion: @escaping CompletionBlock) { // Perform some work completion() } doSomething { // Handle completion }
72. Стиль кодирования (coding conventions) typealias CompletionBlock = () -> Void private func doSomething(completion: @escaping CompletionBlock) { doSomethingImpl { // Invoke completion block explicitly to ease-up debugging. completion() } } private func doSomethingImpl(completion: @escaping CompletionBlock) { doEvenMore { // Invoke completion block explicitly to ease-up debugging. completion() } } private func finallyDoSomething(completion: @escaping CompletionBlock) { // Perform some work completion() } doSomething { // Handle completion }
73. Стиль кодирования (coding conventions)
74. Стиль кодирования (coding conventions) Access Control
75. Стиль кодирования (coding conventions) class MyClass { var flag1: Bool var flag2: Bool var someValue: Int var someCalculatedProperty: Int { return 10 } init() { } func doSomething() { } func doAnotherMagic() { } deinit { } }
76. Стиль кодирования (coding conventions) internal class MyClass { var flag1: Bool var flag2: Bool var someValue: Int var someCalculatedProperty: Int { return 10 } init() { } func doSomething() { } func doAnotherMagic() { } deinit { } }
77. Стиль кодирования (coding conventions) internal class MyClass { public var flag1: Bool public var flag2: Bool private var someValue: Int public var someCalculatedProperty: Int { return 10 } public init() { } public func doSomething() { } private func doAnotherMagic() { } deinit { } }
78. Стиль кодирования (coding conventions) internal class MyClass { public var flag1: Bool public var flag2: Bool private var someValue: Int public var someCalculatedProperty: Int { return 10 } public init() { } public func doSomething() { } private func doAnotherMagic() { } deinit { } }
79. Стиль кодирования (coding conventions)
80. Стиль кодирования (coding conventions) internal class MyClass { public var flag1: Bool public var flag2: Bool public var someCalculatedProperty: Int { return 10 } public init() { } public func doSomething() { } deinit { } private func doAnotherMagic() { } private var someValue: Int }
81. Стиль кодирования (coding conventions) internal class MyClass { public var flag1: Bool public var flag2: Bool public var someCalculatedProperty: Int { return 10 } public init() { } public func doSomething() { } deinit { } private func doAnotherMagic() { } private var someValue: Int }
82. Стиль кодирования (coding conventions)
83. Стиль кодирования (coding conventions) internal class MyClass { public var flag1: Bool public var flag2: Bool public init() { } deinit { } public var someCalculatedProperty: Int { return 10 } public func doSomething() { } private func doAnotherMagic() { } private var someValue: Int }
84. Стиль кодирования (coding conventions) // Class description internal class MyClass { // MARK: - Public methods and properties public var flag1: Bool public var flag2: Bool public init() { } public var someCalculatedProperty: Int { return 10 } public func doSomething() { } // MARK: - Internal methods and properties private func doAnotherMagic() { } // MARK: - Internal fields private var someValue: Int }
85. Recap
86. Recap - Тесты
87. Recap - Тесты - Ускорить разработку в среднесрочной и долгосрочной перспективе
88. Recap - Тесты - Ускорить разработку в среднесрочной и долгосрочной перспективе - Получить более структурированный код
89. Recap - Тесты - Ускорить разработку в среднесрочной и долгосрочной перспективе - Получить более структурированный код - Получить примеры использования кода, которые потом можно вставлять в документацию
90. Recap - Тесты - Ускорить разработку в среднесрочной и долгосрочной перспективе - Получить более структурированный код - Получить примеры использования кода, которые потом можно вставлять в документацию - Предоставить дополнительную психологическую уверенность, что все не развалилось, хотя гарантий нет
91. Recap - Тесты - Ускорить разработку в среднесрочной и долгосрочной перспективе - Получить более структурированный код - Получить примеры использования кода, которые потом можно вставлять в документацию - Предоставить дополнительную психологическую уверенность, что все не развалилось, хотя гарантий нет - Coding conventions
92. Recap - Тесты - Ускорить разработку в среднесрочной и долгосрочной перспективе - Получить более структурированный код - Получить примеры использования кода, которые потом можно вставлять в документацию - Предоставить дополнительную психологическую уверенность, что все не развалилось, хотя гарантий нет - Coding conventions - Делают код приятным для сопровождения
93. Recap
94. Recap
95. Recap
96. Документация
97. Документация … в следующем сезоне