Пол — это Java
154 subscribers
13 photos
2 videos
2 files
26 links
Канал, в котором живет вымышленный на основе реальных событий разработчик Пол, и вместе с ним мы пробуем узнать, что такое Java и не только👨🏻‍💻

@polyackov_ot
Download Telegram
2️⃣ Устаревание документации
Много вопросов было про то, как бороться с устареванием документации и архитектуры.
Как я понимаю, тенденция ведет нас к принципу "Архитектура as code". А раз это код, значит на него нужно писать Юнит тесты 😁 Их очень воодушевляющий и уже работающий прототип (github) представил в докладе Руслан Сафин.

Это решение встраивается в GitLab-pipeline и сравнивает application.yaml, yaml конфигурацию K8S и plantUML диаграмму.

3️⃣ Единый Язык
Следующая неугасающая тенденция – единый язык (DDD). О нем на конференции также говорили много, но Евгений Хренов пошел дальше и представил всем в докладе свою простую и понятную методичку.

Важно не только качество конкретного имени, но и системность формирования всех имен

Вижу большую ценность, что благодаря предложенному Женей соглашению, можно не задумываться, как выбирать имена для сервисов, сущностей кубера, REST api, Kafka topics и баз данных. Таким соглашением легко могут пользоваться все команды независимо.

Единственный минус, это решение лишает возможности в кулачном поединке с ТехЛидом дать своему детищу имя super-puper-service-2000

Вердикт
Хоть в начале все было очень тухло, и организаторы явно оплошали с таймингами докладов, но конец последней лекции я встретил с восторженным ощущением приятно проведенного времени.
После этого мои мозги работали в режими 50 идей в секунду, генерируя от идеи того, что можно улучшить в текущем проекте, до идей собственного проекта и желания поконтрибьютить в опенсорс))

Буду рад вашим лайкам!

#arch #archday
@polyackov_ot
43👍3🤔2😢1
Всем привет
Знакомьтесь — это разработчик по имени Пол.
Пол — senior, junior, middle, principle, lead, который возможно еще что-то не знает или, наоборот, так давно в разработке, что уже что-то забыл. Именно к нему мы будем обращаться в попытке что-то объяснить, а, заодно, и разобраться самим.

Пол — это еще и сообщество, которое поможет подсветить пробелы, провести интересный диалог и поделиться личным опытом.

Добро пожаловать!
🔥113💯3
😱62🤩2
Привет, Пол — это мой первый опыт публичных выступлений.

Познакомься, это 15 новых лиц, которые присоединились к нашему комьюнити. И которые готовы вместе с тобой, мной и остальными подписчиками, все-таки, узнать что такое Java)

40 человек в пике, и 15 в онлайне после 5,5 часов. Звучит мощно, и это было действительно супер!

У нас не было плана, но была идея, и, чтобы с чего-то начать и растопить лёд, я спросил следующее:
1) Как можно к вам обращаться?
2) Какой опыт в Java от 0 до 3 ?
3) Что ожидаете от этой встречи?

Эти вопросы помогли мне взаимодействовать и делиться более релевантной для аудитории информацией.

Мы начали от базовых вопросов, затем перешли к TDD, затронули историю развития it и как это привело нас к микросервисам. А какие же микросервисы без DDD, поэтому обсудили еще и его.

Дополнительно попытались разобраться, что такое аналитика к задаче.
Обсудили наболевшее о том, как учиться, и как не выгорать.
Немного поговорили про то, кто такие архитекторы и стекхолдеры.
В самом конце даже успели на примере реальной задачи посмотреть лучшие практики работы с git.

Кажется, вышло продуктивно и полезно. Рад, что получился живой разговор на основе живого интереса. Уверен, что нужно продолжать и дальше, а всем присутствующим большое спасибо
👍10🔥52🤩2👏1
Привет Пол (и привет всем)
Хочу поделиться недавним комментом из Merge Request, который будет интересен и тебе.

Кратко опишу задачу:
Мне нужно было слушать топик в Kafka, где могут быть сообщения, которые моей системе не нужно обрабатывать.

Для этой задачи я реализовал фильтр, давай посмотрим мой код ниже:
@Bean
public ConcurrentKafkaListenerContainerFactory<String, String> filterNonCurrentSourceSystemResponse(ConsumerFactory<String, String> consumerFactory) {
var factory = new ConcurrentKafkaListenerContainerFactory<String, String>();
factory.setConsumerFactory(consumerFactory);
factory.setRecordFilterStrategy(record -> {
var sourceSystemHeader = record.headers().lastHeader(KafkaConstants.SOURCE_SYSTEM_HEADER);
var sourceSystemHeaderValue = new String(sourceSystemHeader.value());
return !SourceSystemName.isCurrentSourceSystem(sourceSystemHeaderValue);
});
return factory;
}


На самом деле весь код читать и понимать не нужно, нам интересен фидбек к конкретной строке:
new String(sourceSystemHeader.value());


Для начала давай разберемся, что же здесь происходит:
🔸 sourceSystemHeader.value() возвращает byte[]
🔸 при конвертации в String каждый раз будет создаваться новый объект в heap
🔸 т.к. количество вариантов SOURCE_SYSTEM_HEADER сильно ограничено, возможно, для оптимизации работы с памятью стоит добавить интернирование в String Pool

Я так и поступил.

Пол и все-все-все, что думаете, стоит ли так помогать GC?
Также мы будем рады увидеть в комментах другие способы оптимизации работы с памятью.

PS: Хотел бы поделиться ссылкой, в ней довольно подробно и с примерами уже описаны оптимизации и String Pool. Думаю, вы сможете за 10-15 минут получить неплохой базис, и, при необходимости, погрузиться в эту тему глубже.

#String
🔥622👍2🤔1🗿1
👋 Привет Пол (и привет всем)
Недавно я сходил на свою первую Java конференцию в Лондоне.

В кулуарах мы занимались типичными активностями — травили байки и мерились, кто тут самый старпер. Всех уел разраб, первой средой разработки которого была еще IBM VisualAge (что-то древнее, что умерло 20+ лет назад).

Но дальше он начал рассказывать про свой опыт использования 4х разных AI в написании кода, и мне порвало шаблон. Все вокруг начали наперебой делиться опытом , а мне же оставалось только шаркнуть ножкой 🤡 Получается, единственный старпер здесь я

По всем законам конформизма я задумался:
с чем же и мне может помочь AI

⚠️ Сегодня на проде у меня потерялся запрос. Как оказалось, причиной была самая популярная ошибка в Java.

Я получил сообщение c номером счета, а метод ниже должен был вернуть валюту счета:
public String getCurrencyName(String account) {
var currencyCode = account.substring(5, 8);
return currencyCodeNameMap.get(currencyCode);
}
// пример данных в currencyCodeNameMap
// 810, RUR
// 840, USD
// 826, GBP
}


Но так получилось, что счет пришел битый, с кодом, которого не было в currencyCodeNameMap. Поэтому .get() вернул null, а где-то позже все и сломалось.

💡 Хорошим решением было бы ловить такие ошибки на уровне валидации полученного сообщения. С вопросом о том, как это лучше сделать, я решил выйти не в Интернет, а написать Machinet AI.

Примерно за 10 минут, большая часть из которых ушла на объяснение, что account состоит из 3х групп и что есть enum CurrencyType с уже нужными кодами, я получил такое решение:
String accountRegex = "\\d{5}(810|840|826|)\\d{12}";


Ответ почти устроил, ведь регулярку будет легко добавить в @Pattern.
Но оставался риск забыть поправить и ее при добавлении значения в enum.

Сходу идей как решить данную проблему не было, и, уже вставая из-за рабочего стола, я подумал,
а было бы интересно задать те же вопросы GitHab Copilot и сравнить...


Успех! Повторил первые два промта и точно также попытался скормить ему enum. Получил почти готовое решение (итоговая версия будет в комментах).

Полнейший восторг! Вот, что я испытывал, глядя как строчка за строчкой проявляется решение. А в голове сам собой складывался план, как бы я шел к аналогичному результату.

За 10 минут я получил ответ, освежил в памяти regex, чуть лучше начал понимать, как использовать AI.

🧠 Как итог, Copilot оказался намного умнее:
1. С первого сообщения понял, как нужно исползовать enum
2. Без подсказок решил проблему консистентности
3. Выдал готовое решение меньше, чем за 1 минуту (против 10-15 у Machinet AI)

🪦 Из минусов:
Copilot умер и уже часов 8 не подает признаков жизни
Вместе со смертью потер всю историю запросов

По общим ощущениям показалось, что Copilot больше заточен на работу с кодом, поскольку для Machinet AI пришлось руками вырезать из enum коды валют, несколько раз переписывать весь промт, тк иначе он не мог понять, что нужно сделать. Но, главное, каждый AI дал возможность сгенерировать regex декларативно.

Ну, и, как мне раньше советовал ChatGPT
По окончании поста задайте вопросы для обсуждения. Это может помочь сгенерировать больше обратной связи и вовлечь ваших подписчиков.


Поделитесь своими любимыми способами использовать AI?
И, что вы думете, можно ли использовать технологию, которая каждый раз на один и тот же вопрос отвечает по-новому?
👏42🤔2
This media is not supported in your browser
VIEW IN TELEGRAM
👋 Привет Пол (и привет всем)

В комментах под прошлым постом мы затронули тему рисков использования AI асcистенов, и вспомнили про подкаст, где предлагались необычные кейсы использования Tor Browser.

В контексте темы хотел бы поделиться новым выпуском от той же студии подкастов — "От rename к intellij idea"

Почему выпуск понравился мне и возможно будет интересен и вам?

»» Во-первых, никогда не думал, что можно жить без Rename, но когда-то это был отдельный плагин для JBuilder.
Появление Rename было настолько значимым, что сам Мартин Фаулер написал в Crossing Refactoring's Rubicon, что программирование больше не будет прежним.

»» Во-вторых, было крайне интересно послушать от Макса Шафирова (ex-CEO JetBrains) историю роста JetBrains от 10 энтузиастов до корпорации, владеющей десятком лучших сред разработки для ключевых языков.
А еще понравились идеи об установке AI ассистентов в контуре и на серверах компаний, чтобы избежать юридических рисков у заинтересованных в использовании клиентов.
6👍5🆒4
👋 Привет Пол (и привет всем)

Последние несколько месяцев я проверяю работы студентов-джавистов на курсе по Clean Architecture.

Всё это оказалось очень любопытным и дало мне, надеюсь как и студентам, ряд новых инсайтов.
Например, я заметил, что у большинства студентов есть одинаковые зоны роста -- паттерны в написании кода, улучшив которые, можно повысить его качество.

Одна из таких зон роста – работа с Exception, а именно:

🔸 Использование более конкретного типа ошибки вместо абстрактного
🔸 Добавление детальной информации, текста о контексте ошибки
🔸 Написание качественного теста, который будет способен проверить оба пункта выше

Разберём шаг за шагом на примере, как можно улучшить код.

Дано ⬇️
if (coordinate < MIN_COORDINATE_VALUE || coordinate > MAX_COORDINATE_VALUE) {
throw new RuntimeException("wrong coordinate");
}


Что можно улучшить на основе выделенных выше пунктов:

1️⃣ Вместо абстрактного типа ошибки RuntimeException полезно воспользоваться более конкретным.

Мы видим, что в коде идёт речь про валидацию входных параметров, а потому имеет место более подходящий для ситуации тип IllegalArgumentException

Более конкретный тип ошибки, даже без текста, уже даёт частичное понимание контекста и снижает риск обработки другой ошибки, которая также является наследником базовой.

2️⃣ Выбрав тип ошибки, необходимо определиться, что важно написать в ее тексте.

Хороший message, отвечает на вопрос:
Почему произошла ошибка?


Чтобы ответить на данный вопрос, текст ошибки должен содержать описание -- нарушение чего приводит к возникновению подобной ошибки.

А также пояснение, что было передано в метод и привело к нежелательному результату:
Что я нарушил?
Как я нарушил?
Прочитав такой текст, смогу ли я поправить входные параметры без чтения кода?


После внесения улучшений из пункта 1 и 2 код может выглядеть следующим образом ⬇️
if (coordinate < MIN_COORDINATE_VALUE || coordinate > MAX_COORDINATE_VALUE) {
throw new IllegalArgumentException("Expected coordinate should be between '%d' and '%d'. Actual coordinate is '%d'."
.formatted(MIN_COORDINATE_VALUE, MAX_COORDINATE_VALUE, coordinate));
}


Замечу, что важно переиспользовать константы в формировании текста ошибки. Это защитит код от появления противоречий между их значениями и текстом ошибки при будущем рефакторинге.

Также стоит всегда писать текст ошибки на английском, так как код будет запускаться на проде, и будет неприятно получить
?????? ?????? ?????? ?????? ? ?????? ?? '1' ?? '10'. ?????? ?????? ? '0'.

3️⃣ Negative path не менее важен, чем happy path, поэтому хорошая ошибка и ее текст должны быть закреплены хорошим тестом.

@Test
void create_whenCoordinateIsNotCorrect_thenThrow() {
var actual = assertThrows(IllegalArgumentException.class, () -> Location.create(0, 2));


assertEquals("Expected coordinate should be between '1' and '10'. Actual coordinate is '0'.", actual.getMessage());
}


Буду благодарен, если вы поделитесь в комментариях, что на ваш взгляд должно быть или не быть в хорошей ошибке!

#exception
14🔥53🤔1🗿1
Channel photo updated
Привет Пол (и привет всем)

Последние месяцы мы с товарищами много обдумываем собственные проекты и мечту развития комьюнити.

Любовь к делу и принципы побуждают нас постоянно изучать новые подходы и рефлексировать старые практики, что, конечно, намного продуктивнее, богаче и в чем-то проще, если делать это не в одиночку, а с возможностью дискуссии и вдумчивого анализа в группе.

С начала года уже случилось много интересного, например, две Q&A сессии с внешними комьюнити разработчиков (про первую я рассказал тут). За организацию и моральную поддержку большое спасибо моем другу и коллеге @sliceoflife0101

Сейчас же мы с моим partner in crime @diakaiuti дорабатываем последние штрихи нескольких нетривиальных для меня образовательных и дискуссионных форматов, так что уже совсем скоро расскажем what we do in the shadows.

P.S. Фраза "Пол — это Java", обросшая внутренними шутками и смыслами, когда-то стала названием этого канала. Думаю, новое фото отлично отражает ее многомерность.
🔥113🤯3
Привет Пол (и привет всем)

В микросервисной архитектуре неочевидных вещей, конечно, немало, но согласованность данных в распределенных системах занимает отдельную позицию в "челленджах" для разобраться. А без понимания темы несомненно сложнее получить все преимущества и скомпенсировать все недостатки MSA.

Игорь Овчинин и Евгения Медникова, представляющие творческий тандем небезразличных аналитиков, тоже это понимают, а потому написали подробную статью, закрывающую основные вопросы простым и понятным языком.
А я помог наполнить ее good practice из своего прикладного опыта, но вовсе даже не поэтому рекомендую ее к прочтению.
9🔥64
👋 Привет Пол (и всем привет)

С Днем программиста! Пусть код становится чище, баги будут редкими, а Java – еще увлекательнее. Пол бы сказал, что идеальный код — миф, но каждый может сделать его лучше. Вперед к новым свершениям! 🎉
Please open Telegram to view this post
VIEW IN TELEGRAM
8👍6🔥4🤩2💯1
👋 Привет Пол (и все, кто интересуется улучшением процесса тестирования)

Сегодня я хочу поделиться с вами подходом к работе с тестовыми данными, который я активно использую каждый день. Я храню тестовые данные в JSON-файлах и написал библиотеку для работы с ними. Давайте разберёмся, почему это так удобно и как это может упростить вашу жизнь.

Преимущества подхода:

1️⃣ Наглядность данных
На мой взгляд, JSON-файлы гораздо нагляднее, чем использование билдеров в коде. Данные можно легко читать и редактировать.

2️⃣ Понятность данных для стейкхолдеров
Один из ключевых плюсов вытекает из предыдущего пункта: на прошлом проекте я мог прямо на встрече с бизнес-стейкхолдерами изменять тестовые данные в JSON-файле и после встречи начать править код.

3️⃣ Лаконичность тестов
В тестировании есть замечательное правило: "Тест должен охватываться одним взглядом", что дает возможность использовать тесты как спецификацию.

Вынесение данных в JSON позволяет свести их представление в тесте к одной строке. Такой подход помогает абстрагироваться от подготовки тестовых данных и сосредоточиться на главной ответственности тестов — непосредственном тестировании.

4️⃣ Работа с большими и сложными запросами
JSON позволяет хранить сложные структуры данных, которые максимально приближены к тем, что используются в боевой среде и без излишней громоздкости.

5️⃣ Легкость дебага
В случае необходимости можно взять JSON с боевой среды и использовать его для отладки проблемы прямо в юнит-тестах.

6️⃣ Интеграция с IDEA
Еще одно удобство заключается в том, что с помощью IntelliJ IDEA можно легко навигироваться из теста прямо в JSON-файл. Это значительно ускоряет работу, ведь вы можете быстро переходить к данным, менять их и сразу видеть результат в тесте. (Скрин приложу в комментариях)

Однако у такого подхода есть и свои недостатки:

Накопление неиспользуемых данных
Со временем в JSON-файлах могут накапливаться лишние поля, которые перестали использоваться в коде. Это усложнит чтение и поддержку таких тестов в дальнейшем.

Некорректные данные
Данные в JSON-файле могут не соответствовать актуальной валидации. Из-за этого есть риск потратить время зря на поиск проблемы в коде, хотя истинная проблема будет сокрыта в тестовых данных.

В следующем посте обещаю рассказать про свою библиотеку, которая как раз решает перечисленные недостатки и значительно упрощает мою работу по написанию хороших тестов уже несколько лет.
Please open Telegram to view this post
VIEW IN TELEGRAM
74🔥42
👋 Привет Пол (и все, кто интересуется улучшением процесса тестирования)

Как и обещал, рассказываю о своей библиотеке для работы с тестовыми данными в формате JSON, которая закрывает недостатки подхода, описанного ранее, и делает тестирование еще удобнее.
Когда-то она начиналась с 2х простых методов getJson и getObject, и я дорабатывал и улучшал ее на протяжение последних 3х лет, пока не пришел к формату, которым с удовольствием делюсь с вами.

Мой репозиторий: polyackov-test-util

Проблемы подхода, которые решает моя библиотека:

01. Накопление неиспользуемых данных
Со временем в JSON-файлах могут накапливаться лишние поля, которые перестали использоваться в коде. Библиотека помогает выявить такие лишние поля благодаря настройке:

mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, true);


02. Некорректные данные
Данные в JSON-файле могут не соответствовать актуальной валидации. В библиотеке есть методы getValid***, которые провалидируют данные перед их использованием, обеспечивая их корректность.

03. Локализация ошибок
Когда тесты ломаются из-за некорректных JSON-данных, они завершаются не как Failed (красные), а как Ignored (серые). Это помогает локализовать причину проблемы и точно указывает на ошибку в тестовых данных, а не в самом тесте.

*️⃣Дополнительно в репозитории можно найти тесты, которые демонстрируют ключевые особенности работы с библиотекой. Это позволит быстро познакомиться с ее возможностями и начать использовать в своих проектах.

Кроме того, даже если вы не используете Spring или Jackson, всегда можно адаптировать библиотеку, заменив компоненты на привычные.

Надеюсь, моя библиотека станет полезной вам в работе, так же, как стала полезной мне, и поможет сделать тесты понятными, а данные актуальными и корректными.

Буду благодарен, если поделитесь своим опытом и отзывами и покликаете на звездочку!
Please open Telegram to view this post
VIEW IN TELEGRAM
11🔥431
👋 Привет Пол (и все, кто любит чистый код)

Хочу обсудить с вами решение, которое, на мой взгляд, облегчает восприятие кода и улучшает его читаемость.

Дядюшка Боб в своих книгах неоднократно критикует такие подходы к именованию классов, как использование префикса I для интерфейсов и постфикса Impl для их реализаций:

Префикс I, столь распространенный в старом коде, в лучшем случае отвлекает, а в худшем — передает лишнюю информацию.


От префикса I я отказался довольно быстро, но отказаться от постфикса Impl, честно говоря, было куда труднее.

Лишь спустя время, когда я настроил цветовую схему в IntelliJ IDEA, я полностью перешел на более лаконичный подход без "синтаксических костылей".

Настройка цветовой схемы стала для меня must-have в разработке по следующим причинам:

01. Легкость восприятия кода

Используя цвета для разных типов классов, я сразу визуально понимаю, какой тип объекта передо мной. Это особенно удобно в больших проектах, где легко потеряться в многочисленных классах и интерфейсах. Цвета моментально привлекают внимание и позволяют "считывать" структуру кода без необходимости изучать его подробности.

02. Отказ от синтаксического сахара

Как мы уже обсудили ранее, префиксы I & Impl — это по сути избыточная информация, которая засоряет код. В идеале, имя класса должно быть самоочевидным. Но, будем честны, отличать интерфейсы, абстрактные классы и их реализации — это очень удобно. И вот тут как раз цвета приходят на помощь в виде компромиссного решения.

*️⃣ Дополнительное преимущество:

Если у вас больше нет возможности использовать I & Impl, это предотвращает возникновение таких имен, как Service & ServiceImpl. Вместо этого вы столкнетесь с ситуацией, где интерфейс и его реализация имеют одинаковые имена — например, Service & Service.

Такой подход еще раз напоминает про ответственность (Single Responsibility) классов. Благодаря этому вы назовете свои классы более точно или даже решите отказаться от избыточного интерфейса, задавшись вопросами:

— Правильно ли мы называем наши классы?
— Может быть интерфейс заслуживает более абстрактного названия, а реализация — более конкретного?


В следующем посте расскажу, как цветовая схема настроена у меня.
Please open Telegram to view this post
VIEW IN TELEGRAM
👍3🤔322
⚙️ Как настроить цветовую схему в IntelliJ IDEA

В предыдущем посте я делился своими выводами по преимуществам использования цветовых схем в коде.

Небольшой tutorial, как эти настройки применить:

» » Откройте Settings -> Editor -> Color Scheme -> Java.
» » Найдите разделы Interface, Abstract class и Enum.
» » Установите удобные вам цвета для каждого типа класса.

Моя цветовая схема:

Interface — #88E062 (зеленый оттенок)
Abstract class — #66A8E9 (голубой оттенок)
Enum — #EBC4FF (пастельно-фиолетовый)
Record — #FFB86C (янтарный/персиковый)


Со временем цветовая схема становится естественной частью процесса работы с кодом. Она упрощает чтение, и нам не нужно каждый раз вчитываться в названия или проваливаться в класс — мы просто ориентируемся по цветам.

А какие инструменты или фичи IntelliJ IDEA помогают вам? Делитесь в комментариях!

#intellijideafeature
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥74🆒3
👋 Привет Пол (и все, кто интересуется новыми архитектурными подходами)

Сегодня я хочу поделиться своими впечатлениями от статьи про Cell-Based Architecture.

Сell-based Architecture (CBA)
— это подход, при котором система делится на независимые ячейки (cells), каждая из которых полностью самодостаточна и выполняет определенную бизнес-логику.

Основная идея
— каждая ячейка содержит все необходимые ресурсы для своей работы, что упрощает масштабирование и изоляцию проблем.

Статья приводит список преимуществ такой архитектуры над Микросервисной (MSA), но ряд из них выглядит спорным, как, например, тезис про самодостаточность ячейки.

Самодостаточность ячейки, как свойство, кажется мне довольно похожим на самодостаточность микросервиса.
Однако в MSA самодостаточность сервисов направлена на устранение краеугольной проблемы — распределённых транзакций.
В CBA же сама концепция объединения нескольких сервисов в одну ячейку порождает эту самую проблему, что загадочно выставляется преимуществом, хотя она сгубила бессчетное число микросервисов.

Если рассматривать обе архитектуры в контексте запуска в Kubernetes кластере, то единственная разница — в MSA Helm будет контролировать только один сервис, а в CBA несколько.

Поэтому, если подытожить первое впечатление, то кажется, что CBA — скорее маркетинговый ход AWS, поскольку это оптимизация именно для самого AWS.

А как вам кажется, есть ли реальные преимущества Cell-Based Architecture по сравнению с Микросервисами?
🔥73👍3🤔1
ЧИСТЫЙ КОД (Part 1)

👋 Привет Пол (и все, кто задумывается о чистом коде)

Семь месяцев назад я сменил работу, и теперь одна из моих ключевых задач — обучать и делиться экспертизой. И за это время мне часто приходилось отвечать на вопросы, так или иначе связанные с чистотой кода.

Что такое чистый код?

Это самый базовый вопрос, на который, тем не менее, нет простого ответа. Нельзя просто следовать чек-листу и гарантировать, что код при этом станет чистым.

Сам подход подразумевает, что иногда важно придерживаться принципов, а иногда осознанно от них отходить.

В следующих постах мне хочется разобрать и порефлексировать, как именно я принимаю такие решения. Я покажу свою логику, постараюсь объяснить, на чем она основана, и между какими вариантами я привык выбирать в реальной разработке.

P.S. А еще оказалось, что многие вещи делаются настолько бессознательно и интуитивно, что при необходимости передачи знания приходится буквально воссоздавать с нуля алгоритм действий.

Поэтому я был бы очень рад и благодарен, если вы поделитесь в комментариях своим опытом или мнениями под грядущими постами!
7🔥4👍3
ЧИСТЫЙ КОД (Part 2)

👋 Привет Пол (и снова привет всем)

Обычно, когда говорят про чистый код, обсуждают размер методов, длину названий или форматирование. Но я убежден, что чистый код начинается задолго до того, как будет написана первая строка.

Перед тем как писать код, важно все же понять контекст, в котором он будет существовать. Для этого я задаю себе (и коллегам) несколько ключевых вопросов:

1️⃣ Кто наши стейкхолдеры (технические и бизнес)?

Стейкхолдеры, в свою очередь, помогут нам ответить на вопросы ниже.

2️⃣ Каковы архитектурные риски и ключевые качества системы?

Это понимание позволит валидировать каждое принимаемое решение.

Примером риска может являться утечка клиентских данных, а качеством системы в таком случае является безопасность.

3️⃣ Какой объем изменений ожидается в будущем?

Значительный → стоит искать более продуманное решение, которое позволит в будущем более удобно добавлять новые функции или изменять старые.
Малый → можно позволить себе решение более простое, прямолинейное и быстрое по срокам реализации.

4️⃣ Долгосрочная или краткосрочная ли ожидается поддержка?

Долгосрочная → код должен быть гибким и легко поддерживаемым.
Краткосрочная → можно принять больше компромиссов.

5️⃣ Насколько жесткие дедлайны?

Сжатые сроки → приходится делать упрощенные решения.
Гибкие сроки → можно уделить больше времени качеству.

Ответы на эти вопросы могут быть зафиксированы в аналитике к задаче или существовать только в головах команды. Но чем больше информации удастся собрать, тем лучше.

По итогу: чем выше уровень неопределенности, тем выше шанс принять некачественное и неподходящее решение.

P.S. В следующих постах я хотел бы разобрать разные вариации контекстов и поразмышлять, какие решения можно принять на их основе. Буду рад вашим мнениям!
6👍6🔥5
ЧИСТЫЙ КОД (Part 3)

Скажи свое мнение и беги: не откладывай на завтра то, что можно сделать послезавтра

Звучит как сомнительный совет, однако я убежден, что это один из ключевых принципов качественной архитектурной работы.

Под профессиональный контекст это можно перефразировать как
Откладывай принятие важных архитектурных решений как можно дольше.

Оно же верно и в концепции чистого кода.

Это не значит избегать решений и ответственности вовсе. Скорее наоборот, это значит принимать только те решения, без которых невозможно двигаться дальше прямо сейчас. Остальные же будет дальновиднее оставить на момент, когда появится больше данных о контексте задачи (про план сбора контекста я писал в посте выше).

Если к моменту принятия решения информации не прибавится, мы со спокойной душой возьмем в работу изначальные идеи. Но если контекст дополнится, новое решение будет осмысленнее и качественнее, что в долгосрочной перспективе окажется выгоднее.

P.S. А какие принципы у вас есть в работе?
👍83🔥21