вторник, 17 августа 2010 г.

7/97: Опасайтесь повторного использования кода

Это перевод Beware the Share. Автор: Udi Dahan.

Из "97-ми вещей, которые должен знать каждый программист".

Это было моим первым проектом в компании. Я только что закончил своё обучение и жаждал проявить себя, оставаясь поздно ночью, чтобы копаться в коде. Когда я работал с первой порученной мне возможностью, я уделил много внимания всему, что я научился: комментирование, логгинг, повторное использование кода и т.д. Проверки кода (code review), к которым я чувствовал себя так готовым, пришли как горькое разочарование - они ругались на моё повторное использование кода!

Как же так? В колледже повторное использование постоянно считалось воплощением качества разработки программного обеспечения. Все статьи, что я читал, учебники, опытные специалисты, которые учили меня. Они все ошибались?

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

Контекст.

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

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

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

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

Опасайтесь разделения кода. Проверьте ваш контекст. И только затем продолжайте.

1 комментарий:

  1. Очень ценное замечание. Ещё бы как-нибудь научится грамотно отделять друг от друга различные контексты. =)

    ОтветитьУдалить

Можно использовать некоторые HTML-теги, например:

<b>Жирный</b>
<i>Курсив</i>
<a href="http://www.example.com/">Ссылка</a>

Вам необязательно регистрироваться для комментирования - для этого просто выберите из списка "Анонимный" (для анонимного комментария) или "Имя/URL" (для указания вашего имени и ссылки на сайт). Все прочие варианты потребуют от вас входа в вашу учётку (поддерживается OpenID).

Пожалуйста, по возможности используйте "Имя/URL" вместо "Анонимный". URL можно просто не указывать.

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