Разработка
Григорий Петров: YAGNI: «Синдром Хомяка» у программистов
Название этого принципа разработки является аббревиатурой от английского «You Aren’t Gonna Need It», что означает «Вам это не понадобится». В соответствии с принципом, крайне не рекомендуется писать код «про запас», в надежде, что он когда-нибудь пригодится.
В разработке программ существует множество правил, принципов и методик. Достаточно посмотреть вот этот неполный список, чтобы проникнуться накопленной нами мудростью. А софтостроительные проекты, тем не менее, как проваливались, так и проваливаются. Я традиционно списываю это на молодость отрасли и отсутствие фундаментальной базы знаний. Но нет ли здесь противоречия? Как может отсутствовать фундаментальная база знаний, когда в Википедии есть сотни статей про принципы разработки, а в каждом втором институте присутствует курс по «Информационным технологиям»?
Знания — специфическая штука. Из-за кошелька Миллера и ряда других ограничений (кстати, рекомендую статью коллеги из Microsoft, который по кошельку проехался качественно и в деталях), большинство людей не могут просто пролистать два десятка учебников по математике от школы до университета и сказать, что они знают кунг-фу. Мы строим свои знания, начиная с фундамента простейших вещей. Освоившись с ними, мы используем уже усвоенное, чтобы изучить и понять более сложные вещи. И так далее — каждое следующее знание опирается на предыдущие.
В обучении разработке программ я не вижу такого подхода. На бедного разработчика вываливают огромную кучу слабо связанных между собой знаний: языки программирования, математика, фреймворки, алгоритмы, практики, инструментарий и множество других вещей. После чего говорят — «Вот же, все есть. Иди и пиши второй фейсбук!». В интернете действительно есть все. Подозреваю, что даже рецепт эликсира бессмертия. Но вот разобраться в этом бесконечном потоке информации, особенно для начинающего разработчика, задача нетривиальная.
В этой колонке я ставлю перед собой простую задачу: сложить в одном месте систематизированные знания о том, как организовать разработку программ и управлять этим процессом. Первый десяток статей обрисовал фундамент, специфичный для нашей индустрии, как я его вижу. Опираясь на этот фундамент, во втором десятке статей я рассказал о ряде любопытных закономерностей, которые, надеюсь, будут полезны многим разработчиками и менеджерам. И только теперь, когда колонка разменяла третий десяток, я считаю фундамент достаточно прочным, чтобы рассказать про один из принципов программирования чуть лучше, чем «делайте так и не спрашивайте почему».
Встречайте: Yagni
Название этого принципа разработки является аббревиатурой от английского «You Aren’t Gonna Need It», что означает «Вам это не понадобится». В соответствии с принципом, крайне не рекомендуется писать код «про запас», в надежде, что он когда-нибудь пригодится. В Википедии принцип подробно описан и снабжен солидным списком проблем, которые случаются, если ему не следовать.
Но я не просто так уделил половину колонки вступлению. Обоснования, приведенные в Википедии — они правильные. И как разработчик с многолетним опытом, я с ними абсолютно согласен. Но как консультант и менеджер я считаю, что они не очень полезны. Их понимание требует солидного багажа знаний и практического опыта. Начинающий программист, ознакомившись с таким обоснованием, скажет: «конечно, я всегда об этом знал» и забудет о принципе через пару часов. Потому что написанное в Википедии никак не связано с его текущим опытом. Это чужие грабли.
В рамках этой статьи я расскажу о Yagni с другой стороны, воспользуюсь уже имеющимся фундаментом. Как выглядит код, который пишут «про запас»? Самая, на мой взгляд, распространенная ситуация, когда программист начинает решать «мета задачи». То есть вместо решения задачи он начинает создавать инструменты для ее решения. Такой подход замечательно проиллюстрирован в мультфильме со сценой «лучше полдня потерять, а потом за полчаса долететь». Часто разработчик, вместо решения конкретной задачи, создает универсальный код для решения любых задач «такого класса», в надежде затем использовать созданный код повторно. Можно вспомнить предварительную оптимизацию, я много раз видел, как разработчики тратили недели, чтобы написать дополнительный код «для того, чтобы все быстро и эффективно работало». Чаще всего через полгода этот код либо выкидывался после изменения архитектуры, либо оставался в проекте неиспользуемым «мертвым грузом».
Что объединяет все эти случаи? Почему разработчик вместо того, чтобы писать минимум кода для решения поставленной задачи, готов тратить дни, недели и месяцы на «вспомогательный» код? Многие считают, что опытные разработчики таким образом стараются заложить в архитектуру достаточную гибкость, предвидя потенциальные проблемы с расширяемостью кода. Такое действительно, бывает. Но намного чаще я слышал от разработчиков, что общий код «выглядит логичнее и больше им нравится».
Страх перед сложностью
Рассказывая на тренингах и консультациях о принципе YAGNI, я формулирую проблему следующим образом: чем больше у разработчика опыт борьбы со сложностью, тем больше он старается защититься от нее. Никому не нравится, когда написанный неделю назад код не может понять сам автор. Опытный программист, видя скопление сложности, инстинктивно пытается ее уменьшить. При этом мало кто знает обо всем ассортименте доступных способов борьбы. Чаще всего со сложностью сражаются самыми простыми способами: заливают код комментариями или дробят его на мелкие части. И если с комментариями все более-менее понятно, то неудачные попытки декомпозиции служат одним из основных источников хомячьих запасов кода.
Происходит это следующим забавным способом. Программист инстинктивно чувствует, что сложность кода повысилась и надо что-то делать. Из двух знакомых ему методов, комментарии и разделение кода, выбирается второй. Но так как делает это разработчик не очень осознанно, то ему нужно оправдание своему поведению. И мозг тут же придумывает такое оправдание — «я выношу общий случай в отдельный код!». Все. «Объяснивший» себе это программист радостно хватается на соломинку и начинает усердно писать код «общего случая» или «дополнительный инструментарий». Чтобы, в первую очередь, доказать себе, что он все правильно сделал.
Эта гипотеза объясняет многие закономерности. Например то, что многие программисты с удовольствием тратят недели на написание инструментария и «общих библиотек», чтобы потом «за пять минут решить задачу». Нередко до решения самой задачи дело уже не доходит. Программист чувствует сложность кода, необходимого для решения задачи, и всеми силами старается эту сложность понизить, перенести ее куда-нибудь в другое место. Сама по себе это замечательная практика, но ее фанатичное и неосознанное применение способно принести проекту больше вреда, чем самое страшное скопление сложности в одном месте. За подробностями можно обратиться к статье в Википедии, там все со вкусом и в деталях описано.
Как с этим жить?
Колонка у нас менеджерская, поэтому кроме моих любимых общих слов и не менее любимых стройных гипотез, я поделюсь практическими наработками.
- Знание — сила. Чем больше команда знает про сложность и методы борьбы с ней, тем меньше шансов, что они начнут «окапываться» в самый неподходящий момент.
- В борьбе с YAGNI очень хорошо помогает утренний стендап и правило «любая задача должна занимать не больше рабочего дня». В случае если разработчик фанатично закопался в возведение оборонительных сооружений — это сразу всплывает на стендапе, достаточно обращать на это внимание.
- Тим лиду крайне важно уметь отделять общий код, написанный «со страху» от кода, который призван сделать архитектуру достаточно гибкой. Делать это удобно на code review, помня о том, что серебряной пули традиционно нет. Если отказаться от универсального кода, то архитектура проекта начнет «костенеть» и очень быстро потеряет гибкость. Верно и обратное — фанатизм в решении «общего случая» и построение редутов против сложности может съедать недели и месяцы работы, оставляя после себя залежи «не пригодившегося» кода.
- Не менее важно разделять YAGNI и «ползучий фичеризм» — отдельную беду, о которой я подробно расскажу в одной из следующих колонок.
Следование принципу YAGNI ложится одним из многих грузов на плечи тим лида. Он и обучает команду, и проводит утренние стендапы, и организует ревью кода. Следит за соблюдением баланса в архитектуре и не допускает перегиба ни в одну, ни в другую сторону. Наличие такого бойца в команде — одна из важнейших менеджерских задач при управлении разработкой, о чем я обязательно расскажу в одной из следующих колонок.