Джедайские приёмы в разработке

Методика построения архитектуры, документирования, тестирования и рефакторинга малой кровью. Как сэкономить силы и время при рефакторинге и переменах, связанных с новыми бизнес-требованиями, а также при значительных изменениях в UI. Как удерживать код на плаву, спастись от обрастания костылями и велосипедами в непрерывном водовороте Agile, снизить количество багов в релизах и затраты на их исправление.

Transcript

1. Джедайские приёмы в разработке Сергей Митрофанов
2. Вне темы • Детали архитектуры UI (MVP, MVVM, MVI и др. MV*)
 • Технологии и библиотеки (Rx, LiveData, Architecture Components и др.)
 • Подходы в построении UI и навигации (активити, фрагменты, Conductor и пр.)
3. По теме • Убийцы идеального кода
 • Планы написания кода
 • «Дежурный» план для идеального кода
 • «Джедайский» план для идеального кода
4. Идеальный код ???
5. Идеальный код • Запускается и работает без багов
6. Идеальный код • Запускается и работает без багов
 • Понятный чистый
7. Идеальный код • Запускается и работает без багов
 • Понятный чистый
 • Четкая архитектура
8. Идеальный код • Запускается и работает без багов
 • Понятный чистый
 • Четкая архитектура
 • Покрыт тестами
9. Идеальный код • Запускается и работает без багов
 • Понятный чистый
 • Четкая архитектура
 • Покрыт тестами
 • Документирован
10. Убийцы идеального кода • Произвол в требованиях (к фичам)
 
 • Избыток полномочий
 (и ответственности в коде)
11. Архитектор
 от бога ?
12. Новая фича:
 
 Тут нужен рукомойник
13. Рефакторинг!!1!1!
14. Требования бизнеса Они меняются… Часто…
15. Это Agile, детка Альтернатива - waterfall
16. Убийцы идеального кода • Произвол в требованиях (к фичам)
 
 • Избыток полномочий
 (и ответственности в коде)
17. Сферический пример приложения в вакууме Приложение является вымышленным, любое совпадение с реально существующими приложениями случайно !
18. 1.Маршрут 2.Таймер 3.«Отмена» 4.«Где я?» 1.Марка 2.Госномер 3.Картинка 4.«Открыть» 5.«Моргать» 6.«Прогреть» 7.«Звонок» Карта Шторка
19. 1.Маршрут 2.Таймер 3.«Отмена» 4.«Где я?» 1.Марка 2.Госномер 3.Картинка 4.«Открыть» 5.«Моргать» 6.«Прогреть» 7.«Звонок» Карта Шторка
20. 1.Маршрут 2.Таймер 3.«Отмена» 4.«Где я?» 1.Марка 2.Госномер 3.Картинка 4.«Открыть» 5.«Моргать» 6.«Прогреть» 7.«Звонок» Карта Шторка
21. 1.Маршрут 2.Таймер 3.«Отмена» 4.«Где я?» 1.Марка 2.Госномер 3.Картинка 4.«Открыть» 5.«Моргать» 6.«Прогреть» 7.«Звонок» Карта Шторка
22. 1.Маршрут 2.Таймер 3.«Отмена» 4.«Где я?» 1.Марка 2.Госномер 3.Картинка 4.«Открыть» 5.«Моргать» 6.«Прогреть» 7.«Звонок» Карта Шторка
23. 1.Маршрут 2.Таймер 3.«Отмена» 4.«Где я?» 1.Марка 2.Госномер 3.Картинка 4.«Открыть» 5.«Моргать» 6.«Прогреть» 7.«Звонок» Карта Шторка
24. 1.Маршрут 2.Таймер 3.«Отмена» 4.«Где я?» 1.Марка 2.Госномер 3.Картинка 4.«Открыть» 5.«Моргать» 6.«Прогреть» 7.«Звонок» Карта Шторка
25. 1.Маршрут 2.Таймер 3.«Отмена» 4.«Где я?» 1.Марка 2.Госномер 3.Картинка 4.«Открыть» 5.«Моргать» 6.«Прогреть» 7.«Звонок» Карта Шторка
26. 1.Маршрут 2.Таймер 3.«Отмена» 4.«Где я?» 1.Марка 2.Госномер 3.Картинка 4.«Открыть» 5.«Моргать» 6.«Прогреть» 7.«Звонок» Карта Шторка
27. 1.Маршрут 2.Таймер 3.«Отмена» 4.«Где я?» 1.Марка 2.Госномер 3.Картинка 4.«Открыть» 5.«Моргать» 6.«Прогреть» 7.«Звонок» Карта Шторка
28. 1.Маршрут 2.Таймер 3.«Отмена» 4.«Где я?» 1.Марка 2.Госномер 3.Картинка 4.«Открыть» 5.«Моргать» 6.«Прогреть» 7.«Звонок» Карта Шторка
29. 1.Марка 2.Госномер 3.Картинка 4.«Открыть» 5.«Моргать» 6.«Прогреть» 7.«Звонок» Шторка Карта 1.Маршрут 2.Таймер 3.«Отмена» 4.«Где я?» 5.«Моргать»
30. Что попало под рефакторинг View карты View шторки представление карты Представление шторки Бизнес-логика карты Бизнес-логика шторки Data source карты Data sourceшторки
31. Что попало под рефакторинг View карты View шторки представление карты Представление шторки Бизнес-логика карты Бизнес-логика шторки Data source карты Data sourceшторки
32. Что попало под рефакторинг View карты View шторки представление карты Представление шторки Бизнес-логика карты Бизнес-логика шторки Data source карты Data sourceшторки
33. Что попало под рефакторинг View карты View шторки представление карты Представление шторки Бизнес-логика карты Бизнес-логика шторки Data source карты Data sourceшторки
34. Что попало под рефакторинг View карты View шторки представление карты Представление шторки Бизнес-логика карты Бизнес-логика шторки Data source карты Data sourceшторки
35. Что попало под рефакторинг View карты View шторки представление карты Представление шторки Бизнес-логика карты Бизнес-логика шторки Data source карты Data sourceшторки
36. Что попало под рефакторинг View карты View шторки представление карты Представление шторки Бизнес-логика карты Бизнес-логика шторки Data source карты Data sourceшторки
37. Что попало под рефакторинг View карты View шторки представление карты Представление шторки Бизнес-логика карты Бизнес-логика шторки Data source карты Data sourceшторки
38. Что попало под рефакторинг View карты View шторки представление карты Представление шторки Бизнес-логика карты Бизнес-логика шторки Data source карты Data sourceшторки
39. Планы сопротивления Радикальные, Дежурный, Джедайский
40. Радикальные планы разработки
41. Радикальные планы разработки Экстремизм до добра не доводит
42. Дежурный план 1.Изучаем ТЗ
43. Дежурный план 1.Изучаем ТЗ
 2.Пишем (одноразовый) код
 [качество напрямую зависит от опыта]
44. Дежурный план 1.Изучаем ТЗ
 2.Пишем (одноразовый) код
 3.Если код готов для staging, его можно покрыть тестами
 [зависит от соглашений в команде]
45. Дежурный план 1.Изучаем ТЗ
 2.Пишем (одноразовый) код
 3.Если код готов для staging, его можно покрыть тестами
 4.Если код выжил после релиза, планируем его рефакторинг в backlog
46. Дежурный план 1.Изучаем ТЗ
 2.Пишем (одноразовый) код
 3.Если код готов для staging, его можно покрыть тестами
 4.Если код выжил после релиза, планируем его рефакторинг в backlog
 5.После этого код можно документировать ?
47. Дежурные плюсы Скорость получения кода
48. Дежурные плюсы Скорость получения кода
 Гибкость в изменениях недорого
49. Дежурные плюсы Скорость получения кода
 Гибкость в изменениях недорого
 Нет лишних действий при разработке
50. 1.Изучаем ТЗ
 2.Пишем (одноразовый) код
 3.Если код готов для staging, его можно покрыть тестами
 4.Если код выжил после релиза, планируем его рефакторинг в backlog
 5.После этого код можно документировать Дежурный план
51. Дежурные минусы Множество багов по недосмотру
 [Сложно все предусмотреть]
52. Дежурные минусы Множество багов по недосмотру
 Долгие проверки работы кода на устройстве
 [Запуск в среднем 1-3 мин]
53. Дежурные минусы Множество багов по недосмотру
 Долгие проверки работы кода на устройстве
 Поддержка и изменения отнимают много сил и времени
 [Улыбаемся, и отлаживаем]
54. Дежурные минусы Множество багов по недосмотру
 Долгие проверки работы кода на устройстве
 Поддержка и изменения отнимают много сил и времени
 Копятся технические долги
 [тесты, рефакторинг, документирование]
55. 1.Изучаем ТЗ
 2.Пишем (одноразовый) код
 3.Если код готов для staging, его можно покрыть тестами
 4.Если код выжил после релиза, планируем его рефакторинг в backlog
 5.После этого код можно документировать Дежурный план
56. Делать или не делать? Не делать… ? ?
57. 1.Изучаем ТЗ
 2.Пишем (одноразовый) код
 3.Если код готов для staging, его можно покрыть тестами
 4.Если код выжил после релиза, планируем его рефакторинг в backlog
 5.После этого код можно документировать Дежурный план
58. 1.Изучаем ТЗ
 2.Пишем (одноразовый) код
 3.Если код готов для staging, его можно покрыть тестами
 4.Если код выжил после релиза, планируем его рефакторинг в backlog
 5.После этого код можно документировать Дежурный план 
 Долгий ящик
 ? ?
59. Джедайский план 1.Ознакомиться и уточнить тест-кейсы и ТЗ
 2.Максимально разграничить ответственность
 3.Описать бизнес-объекты и контракты компонентов
 4.Написать юнит-тесты
 5.Написать код
 6.Тюнинг-полировка кода
60. Ознакомление и уточнение ТЗ и тест-кейсов • Полностью ознакомиться с ТЗ и тест-кейсами • Выявить неоднозначности и ограничения
 [сеть, заряд, разрешения] • Разрешить неоднозначности вместе с Продактом, дизайнером и командой • Зафиксировать результат письменно
61. Джедайский план 1.Ознакомиться и уточнить тест-кейсы и ТЗ
 2.Максимально разграничить ответственность
 3.Описать бизнес-объекты и контракты компонентов
 4.Написать юнит-тесты
 5.Написать код
 6.Тюнинг-полировка кода
62. Разграничение ответственности Чем мельче детали, тем легче модифицировать
63. 1.Маршрут 2.Таймер 3.«Отмена» 4.«Где я?» Карта 1.Марка 2.Госномер 3.Картинка 4.«Открыть» 5.«Моргать» 6.«Прогреть» 7.«Звонок» Шторка
64. Максимальный SRP
 View карты View шторки Маршрут Маршрут Маршрут Таймер Таймер Таймер «Отмена» «Отмена» «Отмена» «Где я?» «Где я?» «Где я?» Машина Машина Машина «Открыть» «Открыть» «Открыть» «Моргать» «Моргать» «Моргать» «Прогреть» «Прогреть» «Прогреть» «Звонок» «Звонок» «Звонок» Представление Бизнес-логика Data-source
65. 1.Марка 2.Госномер 3.Картинка 4.«Открыть» 5.«Моргать» 6.«Прогреть» 7.«Звонок» Шторка 1.Маршрут 2.Таймер 3.«Отмена» 4.«Где я?» 5.«Моргать» Карта
66. View карты View шторки Маршрут Маршрут Маршрут Таймер Таймер Таймер «Отмена» «Отмена» «Отмена» «Где я?» «Где я?» «Где я?» Машина Машина Машина «Открыть» «Открыть» «Открыть» «Моргать» «Моргать» «Моргать» «Прогреть» «Прогреть» «Прогреть» «Звонок» «Звонок» «Звонок» Представление Бизнес-логика Data-source Что попало под рефакторинг
67. View карты View шторки Маршрут Маршрут Маршрут Таймер Таймер Таймер «Отмена» «Отмена» «Отмена» «Где я?» «Где я?» «Где я?» Машина Машина Машина «Открыть» «Открыть» «Открыть» «Моргать» «Моргать» «Моргать» «Прогреть» «Прогреть» «Прогреть» «Звонок» «Звонок» «Звонок» Представление Бизнес-логика Data-source Что попало под рефакторинг
68. View карты View шторки Маршрут Маршрут Маршрут Таймер Таймер Таймер «Отмена» «Отмена» «Отмена» «Где я?» «Где я?» «Где я?» Машина Машина Машина «Открыть» «Открыть» «Открыть» «Прогреть» «Прогреть» «Прогреть» «Звонок» «Звонок» «Звонок» Представление Бизнес-логика Data-source «Моргать» «Моргать» «Моргать» «Хитрый план»
69. View карты View шторки Маршрут Маршрут Маршрут Таймер Таймер Таймер «Отмена» «Отмена» «Отмена» «Где я?» «Где я?» «Где я?» Машина Машина Машина «Открыть» «Открыть» «Открыть» «Прогреть» «Прогреть» «Прогреть» «Звонок» «Звонок» «Звонок» Представление Бизнес-логика Data-source «Хитрый план» «Моргать» «Моргать» «Моргать»
70. View карты View шторки Маршрут Маршрут Маршрут Таймер Таймер Таймер «Отмена» «Отмена» «Отмена» «Где я?» «Где я?» «Где я?» Машина Машина Машина «Открыть» «Открыть» «Открыть» «Прогреть» «Прогреть» «Прогреть» «Звонок» «Звонок» «Звонок» Представление Бизнес-логика Data-source Ловкость рук и никакого… «Моргать» «Моргать» «Моргать»
71. Джедайский план 1.Ознакомиться и уточнить тест-кейсы и ТЗ
 2.Максимально разграничить ответственность
 3.Описать бизнес-объекты и контракты компонентов
 4.Написать юнит-тесты
 5.Написать код
 6.Тюнинг-полировка кода
72. Контракты (интерфейсы) есть везде • Любые публичные методы и поля классов
 • Для бизнес-объектов java-интерфейсы не обязательны
 • Помогают зафиксировать абстрактную архитектуру
 • Их нужно документировать
73. Бизнес-объект с документацией Это просто /** * Неизменная бизнес сущность геопозиции. Содержит в себе долготу, широту * и временной штамп своего получения. */ public class GeoLocation { private final double latitude; private final double longitude; private final long timestamp; public GeoLocation(double latitude, double longitude, long timestamp) { this.latitude = latitude; this.longitude = longitude; this.timestamp = timestamp; } public double getLatitude() { return latitude; } public double getLongitude() { return longitude; } public long getTimestamp() { return timestamp; } }
74. Интерфейс с документацией Piece of cake import android.support.annotation.NonNull; import com.cargopull.executor_driver.entity.GeoLocation; import io.reactivex.Flowable; /** * Гейтвей получения геопозиции пользователя. */ public interface GeoLocationGateway { /** * Возвращает текущие геопозиции пользователя. * * @param interval задержка между значениями. * @return {@link Flowable<GeoLocation>} полученные геопозиции. */ @NonNull Flowable<GeoLocation> getGeoLocations(long interval); }
75. Джедайский план 1.Ознакомиться и уточнить тест-кейсы и ТЗ
 2.Максимально разграничить ответственность
 3.Описать бизнес-объекты и контракты компонентов
 4.Написать юнит-тесты
 5.Написать код
 6.Тюнинг-полировка кода
76. Написание тестов (TDD/BDD) Страшно только на первый взгляд
77. Немного о тестах • Это не код, это - документация
 • Помогают разгрузить голову и предусмотреть баги
 • В десятки раз быстрее проверок на устройстве
 [1,5 тыс. тестов за 6 секунд]
 • Необходимо тестировать контракты (интерфейсы)
78. Тест бизнес-объекта Ничего сложного import static org.junit.Assert.assertEquals; import org.junit.Test; public class GeoLocationTest { /** * Проверяем конструктор и геттеры */ @Test public void testConstructorAndGetters() { // Given: GeoLocation geoLocation; // When: GeoLocation geoLocation = new GeoLocation(12.1, 14.5, 12309); // Then: assertEquals(geoLocation.getLatitude(), 12.1, 0); assertEquals(geoLocation.getLongitude(), 14.5, 0); assertEquals(geoLocation.getTimestamp(), 12309); } }
79. Тест интерфейса Чуть сложнее @RunWith(MockitoJUnitRunner.class) public class GeoLocationGatewayTest { private GeoLocationGateway gateway; @Mock private GeolocationCenter geolocationCenter; @Before public void setUp() { … } /* Проверяем взаимодействие с центром геолокации */ // Должен запросить у центра геолокации текущие геопозиции пользователя. @Test public void askGeolocationCenterForLocations() { … } /* Проверяем ответы на запрос геопозиций */ // Должен ответить ошибкой доступа. @Test public void answerSecurityError() { … } // Должен отвечать геопозициями. @Test public void answerWithGeoLocationData() { … } }
80. Джедайский план 1.Ознакомиться и уточнить тест-кейсы и ТЗ
 2.Максимально разграничить ответственность
 3.Описать бизнес-объекты и контракты компонентов
 4.Написать юнит-тесты
 5.Написать код
 6.Тюнинг-полировка кода
81. Пишем код и проверяем тестами Oh, Finally!
82. Джедайский план 1.Ознакомиться и уточнить тест-кейсы и ТЗ
 2.Максимально разграничить ответственность
 3.Описать бизнес-объекты и контракты компонентов
 4.Написать юнит-тесты
 5.Написать код
 6.Тюнинг-полировка кода
83. Тюнингуем и полируем до блеска Совершенству нет предела
84. Лайфхак: последовательность разработки архитектуры View маршрута представление маршрута Бизнес-логика маршрута Data source
 маршрута Бизнес-объект маршрута DTO и маппер маршрута объекты состояний
 UI маршрута
85. Лайфхак: последовательность разработки архитектуры View маршрута представление маршрута Бизнес-логика маршрута Data source
 маршрута Бизнес-объект маршрута DTO и маппер маршрута объекты состояний
 UI маршрута 1. 2. 3. 4. 5.
86. Джедайские плюсы Документация «из коробки»
87. Джедайские плюсы Документация «из коробки» Тесты «из коробки»
 [Проверка работы кода в разы быстрее]
88. Джедайские плюсы Документация «из коробки» Тесты «из коробки» Стабильность кода
 [большинство багов и деградация исключены тестами]
89. Джедайские плюсы Документация «из коробки» Тесты «из коробки» Стабильность кода Гибкость в композиции дешево
90. Джедайские плюсы Документация «из коробки» Тесты «из коробки» Стабильность кода Гибкость в композиции дешево Разработку легко делегировать на большую команду
91. Джедайские плюсы Документация «из коробки» Тесты «из коробки» Стабильность кода Гибкость в композиции дешево Разработку легко делегировать на большую команду Код компонентов короткий и простой
 [Меньше поведения - меньше вариаций]
92. 1.Маршрут 2.Таймер 3.«Отмена» 4.«Где я?» Карта 1.Марка 2.Госномер 3.Картинка 4.«Открыть» 5.«Моргать» 6.«Прогреть» 7.«Звонок» Шторка
93. Джедайские плюсы Документация «из коробки» Тесты «из коробки» Стабильность кода Гибкость в композиции дешево Разработку легко делегировать на большую команду Код компонентов короткий и простой F**K YEA.
94. Джедайские минусы Написание кода занимает немного больше времени
 [Теряем на написании тестов, но выигрываем на проверках работы кода]
95. Джедайские минусы Написание кода занимает немного больше времени
 Порог вхождения выше
 [Требуется дисциплина и воля]
96. Джедайские минусы Написание кода занимает немного больше времени
 Порог вхождения выше
 Есть опасность оверинжинирига
97. Джедайские минусы Написание кода занимает немного больше времени
 Порог вхождения выше
 Есть опасность оверинжинирига
 После полного освоения трудно работать по-старому
98. Джедайские минусы Написание кода занимает немного больше времени
 Порог вхождения выше
 Есть опасность оверинжинирига
 После полного освоения трудно работать по-старому
99. Заключение
100. Заключение • Произвол в требованиях (к фичам) • Избыток полномочий (и ответственности в коде) Убийцы идеального кода
101. Заключение 1.Изучаем ТЗ 2.Одноразовый код 3.Код staging покрыть тестами* 4.Код релиза под рефакториинг* 5.Код документируем* • Произвол в требованиях (к фичам) • Избыток полномочий (и ответственности в коде) Убийцы идеального кода
102. Заключение 1.Уточняем ТЗ и тест-кейсы 2.Максимальный SRP 3.бизнес-объекты и контракты 4.Пишем юнит-тесты 5.Пишем код по тестам 6.Тюнинг-полировка • Произвол в требованиях (к фичам) • Избыток полномочий (и ответственности в коде) Убийцы идеального кода 1.Изучаем ТЗ 2.Одноразовый код 3.Код staging покрыть тестами* 4.Код релиза под рефакториинг* 5.Код документируем*
103. Ссылки на полезные ресурсы • https://soundcloud.com/podlodka/podlodka-27-obektno-orientirovannoe-programmirovanie - Подкаст обсуждения ООП • https://soundcloud.com/podlodka/podlodka-34-mikroservisnaya-arkhitektury - Подкаст обсуждения микросервисной архитектуры • https://www.youtube.com/watch?v=3OTg3_q18qs - Доклад «Жизнь без QA» Александра Смирнова • https://martinfowler.com - Блог Мартина Фаулера • https://blog.cleancoder.com - Блог Роберта Мартина • https://www.google.com - если этого мало =)
104. Вопросы?
105. Спасибо
 за внимание Сергей Митрофанов @G0retZ goretz.m@gmail.com https://speakerdeck.com/g0retz