Проектирование — это когда чувствуешь, а не какие-то там циферки, Николай Хитров, PythoNN

Transcript

1. Проектирование — это когда чувствуешь, а не какие-то там циферки 

2. Николай Хитров Спикер, тимлид, душнила, jsonоукладчик, бЛоГеР
 Рассказываю как писать enterprise 
 на python за пинту пива Делаю митапы и конференции Работаю в Точке, отвечаю за сервис управления задолженностями Кто я? 

3. О чем доклад Чем мы можем померить качество кода Чем чаще пользуются 
 или не пользуются 
 ❶ ❷
4. Для кого Кто хочет в архитектуру кода, 
 но не умеет выбирать между решениями Кто обмазан техдолгом и не знает, откуда начать разгребать Кто любит цифры и не любит людей ❶ ❷ ❸
5. Зачем вообще  метрики?
6. У вас есть телеграм ботик. 
 Простой такой, мемы раз в сутки присылает
7. У вас есть телеграм ботик. 
 Простой такой, мемы раз в сутки присылает вы его поднимете на одном сервере?
8. У вас есть телеграм ботик. 
 Простой такой, мемы раз в сутки присылает вы его поднимете на одном сервере?  а может лучше на двух серверах?
9. У вас есть телеграм ботик. 
 Простой такой, мемы раз в сутки присылает вы его поднимете на одном сервере?  а может лучше на двух серверах?  и в разных стойках?

10. У вас есть телеграм ботик. 
 Простой такой, мемы раз в сутки присылает вы его поднимете на одном сервере?  а может лучше на двух серверах?  и в разных стойках?  и в разных дата центрах? 

11. Одного сервера хватит, зачем усложнять…
12. Но почему?
13. а как же заложиться на будущее? Но почему?
14. а как же заложиться на будущее? вдруг на него нагрузка вырастет? Но почему?
15. а как же заложиться на будущее? вдруг на него нагрузка вырастет? или вдруг сервер ляжет 
 и че нам тогда делать? 
 Но почему?
16. Хорошо, давайте рассмотрим  все варианты
17. Арендовать один VDS 
 за 1к рублей ❶
18. Арендовать один VDS 
 за 1к рублей Арендовать три VDS 
 по 1к рублей за штуку ❶ ❷
19. Арендовать один VDS 
 за 1к рублей Арендовать три VDS 
 по 1к рублей за штуку Купить «малинку»
 и поставить дома
 ❶ ❷ ❸
20. Арендовать один VDS 
 за 1к рублей Арендовать три VDS 
 по 1к рублей за штуку Купить «малинку»
 и поставить дома Купить «мощный» сервер 
 и поставить дома 
 
 ❶ ❷ ❸ ❹
21. Арендовать один VDS 
 за 1к рублей Арендовать три VDS 
 по 1к рублей за штуку Купить «малинку»
 и поставить дома Купить «мощный» сервер 
 и поставить дома Купить N «мощных» серверов 
 и арендовать помещение

 
 
 ❶ ❷ ❸ ❹ ❺
22. Арендовать один VDS 
 за 1к рублей Арендовать три VDS 
 по 1к рублей за штуку Купить «малинку»
 и поставить дома Купить «мощный» сервер 
 и поставить дома Купить N «мощных» серверов 
 и арендовать помещение

 
 
 Купить N «мощных» серверов, арендовать помещение 
 и нанять одного админа
 
 ❶ ❻ ❷ ❸ ❹ ❺
23. Арендовать один VDS 
 за 1к рублей Арендовать три VDS 
 по 1к рублей за штуку Купить «малинку»
 и поставить дома Купить «мощный» сервер 
 и поставить дома Купить N «мощных» серверов 
 и арендовать помещение

 
 
 Купить N «мощных» серверов, арендовать помещение 
 и нанять одного админа Купить N «мощных» серверов, арендовать помещение 
 и нанять M админов
 
 
 ❶ ❻ ❼ ❷ ❸ ❹ ❺
24. Арендовать один VDS 
 за 1к рублей Арендовать три VDS 
 по 1к рублей за штуку Купить «малинку»
 и поставить дома Купить «мощный» сервер 
 и поставить дома Купить N «мощных» серверов 
 и арендовать помещение

 
 
 Купить N «мощных» серверов, арендовать помещение 
 и нанять одного админа Купить N «мощных» серверов, арендовать помещение 
 и нанять M админов … и нанять одного HR 
 
 
 ❶ ❻ ❼ ❽ ❷ ❸ ❹ ❺
25. Арендовать один VDS 
 за 1к рублей Арендовать три VDS 
 по 1к рублей за штуку Купить «малинку»
 и поставить дома Купить «мощный» сервер 
 и поставить дома Купить N «мощных» серверов 
 и арендовать помещение

 
 
 Купить N «мощных» серверов, арендовать помещение 
 и нанять одного админа Купить N «мощных» серверов, арендовать помещение 
 и нанять M админов … и нанять одного HR … нанять двух HR
 
 
 
 ❶ ❻ ❼ ❽ ❾ ❷ ❸ ❹ ❺
26. Арендовать один VDS 
 за 1к рублей Арендовать три VDS 
 по 1к рублей за штуку Купить «малинку»
 и поставить дома Купить «мощный» сервер 
 и поставить дома Купить N «мощных» серверов 
 и арендовать помещение

 
 
 Купить N «мощных» серверов, арендовать помещение 
 и нанять одного админа Купить N «мощных» серверов, арендовать помещение 
 и нанять M админов … и нанять одного HR … нанять двух HR … построить HR департамент 
 

 
 ❶ ❻ ❼ ❽ ❾ ❿ ❷ ❸ ❹ ❺
27. Неявные затраты 
 Явные затраты 

28. Проблемы начинаются, 
 когда мы «не можем» посчитать неявные
29. Или не хотим…
33. Узнавать в эти моменты 
 уже СЛИШКОМ ПОЗДНО 

34. Что может помочь нам измерить архитектуру кода
35. Что можно попробовать измерить 
 Сложность функций ❶
36. Что можно попробовать измерить 
 Сложность функций Сложность (связность) классов ❶ ❷
37. Что можно попробовать измерить 
 Сложность функций Сложность (связность) классов Слои приложения ❶ ❷ ❸
38. Что можно попробовать измерить 
 Сложность функций Сложность (связность) классов Слои приложения Контексты 
 ❶ ❷ ❸ ❹
39. Сложность  функций
42. LOC — Lines Of Code Cyclomatic Complexity ❶ ❷
43. LOC — Lines Of Code Cyclomatic Complexity Cognitive Complexity Halstead Maintainability Index 
 ❶ ❷ ❸ ❹ ❺
44. LOC — Lines Of Code Cyclomatic Complexity Cognitive Complexity Halstead Maintainability Index 
 ❶ ❷ ❸ ❹ ❺
45. Cognitive Complexity • 
 • 


 • каждый оператор это 
 +1 балл сложности за вложенность докидывается еще несколько с учетом глубины за else тоже накидывают, 
 но без учета вложенности if process_order(order):
 if order.is_valid(): # +1 for 'if'
 if order.has_discount(): # +2 for nested 'if'
 if order.customer.is_premium(): # +3 for nested 'if'
 apply_premium_discount(order)
 else: # +1 for 'else'
 apply_standard_discount(order)
 else: # +1 for 'else'
 if order.is_expedited(): # +2 for nested 'if'
 process_expedited(order)
 else: # +1 for 'else'
 process_standard(order)
 else: # +1 for 'else'
 log_invalid_order(order) 
 https://redirect.sonarsource.com/doc/ cognitive-complexity.html 

46. Halstead Программа — набор токенов из операндов (данных) и операторов (действий) 
 Словарь программы 
 (Program Vocabulary) n = + Длина программы 
 (Program Length) N = + n1 n2 N1 N2 
 n1 — уникальных операторов — уникальных операндов — всего операторов — всего операндов 
 n2 N1 N2
47. Halstead Формула объема умственных усилий для понимания программы Объем (Volume): V = *log2( ) N n N — длина программы — минимальное количество 
 бит для кодирования “словаря” 
 n
48. Maintainability Index

 
 MI = MAX(0, (171 — 5.2*ln( ) — 0.23* — 16.2*ln( ))*100/171) 
 HV LoC Cycl. Complexity Коэффициенты как-то подбирали эмпирически для C++ в 90-ых В «новой» версии формулы сделали нормализацию от 0 до 100 В оригинальной было кол-во комментариев, но потом выкинули 

49. Несмотря на «магические» константы из прошлого 
 все еще пользуемся этими формулами ❶ Итого про метрики сложности функций 

50. Несмотря на «магические» константы из прошлого 
 все еще пользуемся этими формулами Не скажут, что кусок кода идеальный, но скажут, 
 что он хуже другого куска ❶ ❷ Итого про метрики сложности функций 

51. Несмотря на «магические» константы из прошлого 
 все еще пользуемся этими формулами Не скажут, что кусок кода идеальный, но скажут, 
 что он хуже другого куска Могут приврать, но если использовать сразу несколько, точность повышается ❶ ❷ ❸ Итого про метрики сложности функций 

52. Несмотря на «магические» константы из прошлого 
 все еще пользуемся этими формулами Не скажут, что кусок кода идеальный, но скажут, 
 что он хуже другого куска Могут приврать, но если использовать сразу несколько, точность повышается Удобно задавать границу, когда уже ну совсем ну точно ну 100% это плохо  
 ❶ ❷ ❸ ❹ Итого про метрики сложности функций 

53. Сложность  классов
54. Depth of Inheritance Tree (DIT): Глубина дерева наследования.
 Слишком глубокое наследование усложняет понимание потока выполнения Вариантов. Довольно. Много.
55. Depth of Inheritance Tree Number of Children (DIT): Глубина дерева наследования.
 Слишком глубокое наследование усложняет понимание потока выполнения (NOC): Количество непосредственных подклассов 
 Высокий NOC может указывать на неправильное использование наследования Вариантов. Довольно. Много.
56. Depth of Inheritance Tree Number of Children Response For a Class (DIT): Глубина дерева наследования.
 Слишком глубокое наследование усложняет понимание потока выполнения (NOC): Количество непосредственных подклассов 
 Высокий NOC может указывать на неправильное использование наследования (RFC): Все методы, которые могут быть вызваны 
 из методов класса Вариантов. Довольно. Много.
57. Depth of Inheritance Tree Number of Children Response For a Class Weighted Method per Class (DIT): Глубина дерева наследования.
 Слишком глубокое наследование усложняет понимание потока выполнения (NOC): Количество непосредственных подклассов 
 Высокий NOC может указывать на неправильное использование наследования (RFC): Все методы, которые могут быть вызваны 
 из методов класса (WMC): Сумма сложностей всех методов класса 
 Чаще всего считается как просто количество методов. Высокий WMC — 
 признак «Божественного объекта» Вариантов. Довольно. Много.
58. Depth of Inheritance Tree Number of Children Response For a Class Weighted Method per Class Lack of Cohesion in Methods (DIT): Глубина дерева наследования.
 Слишком глубокое наследование усложняет понимание потока выполнения (NOC): Количество непосредственных подклассов 
 Высокий NOC может указывать на неправильное использование наследования (RFC): Все методы, которые могут быть вызваны 
 из методов класса (WMC): Сумма сложностей всех методов класса 
 Чаще всего считается как просто количество методов. Высокий WMC — 
 признак «Божественного объекта» (LCOM): Измеряет, насколько методы класса связаны через использование полей
 Высокий LCOM — признак того, что класс, возможно, стоит разделить 
 Вариантов. Довольно. Много.
60. Coupling https://tellmeabout.tech/essential-arch- course-code-477b92fb6ba7 
 Stable Abstraction Principle
61. Lack of Cohesion in Methods (LCOM) 
 Кол-во методов без пар 
 на один атрибут показывают, что методы 
 надо разносить 
 в отдельные классы Не стоит использовать 
 на классах без поведения, логики. Например, DTO 

62. Coupling Stable Dependencies Principle https://tellmeabout.tech/essential- arch-course-code-477b92fb6ba7 

63. Выглядит, все хорошо, но…
64. l = 1/(1+1) = 0,5 1st Complex service 
 One More service 
 2nd 
 l = 1/(1+1) = 0,5 
 Не очень 
 стабильный l = 7/(3+7) = 0,7 
 Мега стабильный l = 0 

65. Какая-то неправдоподобная картина.  Давайте попробуем иначе
66. За каждый публичный метод класса +1 балл Каждая зависимость через конструктор 
 или прямой вызов в методе добавляет вес 
 этой зависимости 
 Заменим количество на веса 

67. Веса зависимостей = 31
 Веса методов = 3 
 1st
 [34] Complex service
 [31] 2 3 4 4 4 4 5 One More service
 [3] 2nd
 [5] Веса зависимостей = 0
 Веса методов = 3 
 Веса зависимостей = 26
 Веса методов = 5 
 Веса зависимостей = 3
 Веса методов = 5 

68. Вес класса = кол-во публичных методов + вес зависимостей 
 Визуализация зависимостей классов 
 кружки – классы
 стрелки – зависимости
 цвет = сложность 



69. Слои приложения
71. Слои приложения Количество слоев определяется сложностью проекта: •

 •
 никаких слоев 
 просто пишем код в лоб 
 как угодно Transactional script 
 контроллеры + все остальное • 

 •
 трехзвенная, гексагональная — представление
 — логика
 — хранение данных DDD, чистая архитектура — представление
 — логика приложения
 — логика домена
 — инфраструктура (адаптеры)
72. Контексты
75. Сложность бизнес логики и уникальное преимущество разделяют поддомены на 3 типа 
 core generic generic/
 supporting 
 supporting Business logic complexity 
 Business differentiation 

76. •



 •

 •


 •
 По типам доменов можно определить, какие вещи требуют больше сил 
 и внимание, а какие можно отдать «под заказ» Можно использовать формулу стабильности классов Можно заметить, что тип зависимости-поддомена влияет на стабильность 
 и учесть это в формуле Кол-во неправильно направленных зависимостей можно использовать 
 при оценке техдолга
77. На этом у меня все,  давайте подводить итоги
78. Многие штуки можно конвертировать 
 в цифры, но далеко не все из них 
 полезны в использовании Нет никакого смысла тратить силы 
 на вылизывание до идеальных цифр — 
 но полезно знать, где есть проблемные места Если метрика не помогает в прогнозировании пути к своей цели — смело выкидывайте ее, 
 она для вас бесполезна 

79. Вопросы? 
 @NKHITROV @NKHITROV_BLOG