пятница, февраля 09, 2007

Quick and Dirty?

Есть такой специальный вид исправления ошибок, название которого (если исключить вопросительный знак) вынесено в заголовок. "Quick and dirty fix" - это такое исправление или решение, которое исправляет проблему в каком-то частном, узком конкретном случае, а не решает её целиком. Примеров подобных решений каждый программист может найти в своей практике множество. Предполагается, что такое вот временное решение будет существовать недолго, а как только появится возможность будет заменено на "правильное". Последнее иногда случается, а иногда нет - как повезёт.

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

Два подхода

Вообще, есть два подхода к написанию программ.

Один подход гласит - главное, чтобы программа была написана в пределах выделенных для неё сроков и работала соответственно спецификации(не будем придираться здесь к тому что такое сроки, что такое спецификация и как именно это самое соответствие проверять - считаем что все это известно). При этом подход утверждает, что если эти условия выполнены, то КАК написана программа, совершенно неважно.

Другой же подход всегда прибавляет к имеющимся условиям первого подхода ещё одно: что программа должна быть при этом написана "правильно". Под "правильностью" адепты второго подхода понимают обычно разные вещи, в большинстве своём плохо формализованные. Тем не менее, как и во многие других вопросах программирования здесь также хорошо помогает "программистская" интуиция. "Правильными" программами, я например, считаю программы, обладающие примерно таким набором признаков:

  • Код программы написан в "понятном" стиле
    "Написать код, понятный компьютеру, может каждый, но только хорошие программисты пишут код, понятный людям."М.Фаулер

  • Программа содержит в себе только необходимые элементы, ничего лишнего, "устаревшего", не использующегося и так далее

  • Код в программе подчиняется принципу DRY (DO NOT REPEAT YOURSELF), то есть каждая часть функциональности существует в единственном экземпляре, нет раскопированных кусков кода, которые делают одно и тоже

  • Все материалы, относящееся к данной версии программы, находится в системе контроля версий:
    • исходный код
    • картинки
    • документация - как пользовательская, так и техническая, включая документы по архитектуре и так далее
    • и так далее

  • Связи между независимыми компонентами программы минимизированы

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

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

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

Эта аргументация вполне понятна. Но, как и любая аргументация, она имеет границы применимости. Дело в том, что аргументация смотрит вперёд на один ближайший выпуск продукта. И с точки зрения этого ближайшего выпуска, она оптимизирует время так, чтобы ближайший выпуск состоялся вовремя.

А что если посмотреть вперёд? Будут ведь и ещё выпуски? Сколько их будет? Рассмотрим пример. Допустим, что для создания работающей автоматизированной процедуры построения продукта требуется 1 неделя (5 рабочих дней). После этого для сборки продукта будет требоваться 2 часа - время работы процедуры. Допустим также, что для того, чтобы собрать продукт руками опытному разработчику, знакомому с процедурой сборки требуется 1 день. Ясно, что в критериях измерения только "к ближайшему выпуску" предпочтение следует отдавать "ручному варианту". А что если впереди планируется ещё 10 выпусков? Давайте считать. Отлаженная процедура займёт 20 часов ( то есть три дня). "Ручная" же сборка займёт 10 дней. Заметим, при этом, что сборка обычно не происходит один раз - обязательно обнаруживается та или иная ошибка, продукт пересобирается и так далее. В "ручном" режиме это каждый раз трата одного дня.

Кроме того "процедура" автоматической сборки, будучи один раз отлаженной имеет гораздо больше шансов сработать и в последующие запуски, чем процедура "ручной" сборки. Также "ручная" сборка страдает тем, что её успешность привязана к конкретному человеку, который может в нужный момент отсутствовать, может заболеть или даже уволиться. И в этой ситуации придется заново "изобретать" процедуру ручной сборки.

Все зависит от критериев

На самом деле подход один. Понятно что всем хочется написать программу "получше". Просто вопрос в критериях качества. Считаем ли мы возможность удобной поддержки программы в будущем подобным критерием или нет? Думаем ли мы о том, что потом наш код увидят и должны будут в нем разобраться другие программисты (или мы сами через год - что почти тоже самое :-) ) ? Если мы пишем однодневку - то один подход, если мы смотрим в будущее, то другой. "Я так думаю"(с) Мимино.

P.S. Если мы в будущее смотрим, но времени у нас на "правильное" программирование не хватает - то это называется неправильным планированием. Тот, кто был ответственен за планирование не до конца все просчитал и не заложил больше времени.

P.P.S. (вольный перевод отсюда, имеет смысл только для программистов): Мы тратим большую часть жизни на разработку программ - стоит ли заниматься этим спустя рукава?

4 комментария:

paul комментирует...

На самом деле, у первого подхода есть и другая серьезная проблема - низкая мотивация разработчиков. Если не ошибаюсь, Стив Макконнелл в книге "Профессиональная разработка программного обеспечения" убедительно показывает, что для программиста самое главное в его работе (личный интерес) - это качество, "правильность" программы. Если качества нет, если совесть гложит, то пропадает всякая мотивация, и человек уже смотрит налево. Пользы проекту от него уже будет мало.

Alexey комментирует...

Цитата
"Под "правильностью" адепты второго подхода понимают обычно разные вещи, в большинстве своём плохо формализованные. Тем не менее, как и во многие других вопросах программирования здесь также хорошо помогает "программистская" интуиция."

Собственно да, но в данном случае "интуиция" рождается после получения достаточного опыта, а поскольку ее трудно формализовать - о ней не прочтешь в учебниках. А о best практиках хоть и можно прочесть, они не станут интуицией, пока не войдут в мозг костей.
Кстати, "интуиция" - он же опыт, являются тем критерием, что дает возможность мгновенно оценить первый и второй варианты и выбрать компромисс.

не могу не попридираться - цитата
"Заметим, при этом, что сборка обычно не происходит один раз - обязательно обнаруживается та или иная ошибка, продукт пересобирается и так далее. В "ручном" режиме это каждый раз трата одного дня."
- после 5 такого дня, это уже будет всеж не день, а две трети дня. Человек, как обучаемая машина, все ж начнет распараллеливать свои действия и обходить постоянные проблемы, их предвосхищая. Но конечно до 2 часов сборки не дотянется, наверно, никогда..

Alexey комментирует...

Кстати, я понял что у меня вертелось в голове - это не два подхода, это два крайних варианта действий, при различном ограничении начальных условий. Это НЕ ПОДХОДЫ..
Подход - это единственно верный компромисс между двумя крайностями, в зяаднных условиях (время, ресурсы, профессионализм, целеустремленность команды и пр. и пр.)
Все к нему, по идее, стремятся, но не всегда получается..

Лев Курц комментирует...

2paul: на самом деле, я с этим не вполне согласен. Не для всех программистов главным в работе является "правильность". Ведь мы под правильностью понимаем не то что программа неправильно работает, а то, что она, так сказать, плохо приспособлена для дальнейшей жизни. А программист может считать так - программа работает хорошо и сделана в срок, следовательно - она качественная. То есть грубо говоря критерии качества другие. Я же пытался рассматривать критерии с точки зрения "расходов" - какой из подходов оказывается в конечном счете "дороже" для компании?

2alexey: ну да, согласен, человек натренируется и будет собирать быстрее. Другое дело что на общий итог, при достаточно большом количестве билдов это все равно наверное не очень сильно повлияет. К тому же, проблема в том, что в случае если человек допустит хотя бы одну ошибку - все придется начинать сначала - вот что время съедает.