Главная - Литература

0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 [184] 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294

капсуляции, изменив характер отношений между подклассом и базовым классом с «является» на «содержит»: преобразуйте базовый класс в данные-члены бывшего подкласса и откройте доступ только к тем методам бывшего подкласса, которые по-настоящему нужны.

Сложный код объясняется при помощи комментариев В важности комментариев трудно усомниться, но их не следует использовать для объяснения плохого кода. Старая мудрость гласит: «Не документируйте плохой код - перепишите его» (Kernighan and Plauger, 1978).

Код содержит глобальные переменные При пересмотре Перстная ссылка О глобаль- f г- tr

ных переменных ш, mm ФР котором используются глобальные перемен-13.3. о различиях между гло- "le, изучите его получше. Возможно, за время, прошедшее бальными данными и данными с тех пор, как вы изучали этот фрагмент, вам пришел в vo-кяассасм.г1одраздэл «Ошйбоч- лову способ устранения глобальных переменных. За это

ное представление о данных время вы уже забыли кое-какие аспекты кода - сейчас ис-класса как о глобальных данных» раздела 5 3 пользование глобальных переменных может показаться вам

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

Перед вызовом метода выполняется подготовительный код (после вызова метода выполняется код <уборкт) Подобный код должен вызывать у вас подозрение:

Пример кода подготовки к вызову метода и кода уборки - плохой код (С++)

- Подготовительный код - дурной знак.

-WithdrawalTransaction withdrawal;

withdrawal.SetCustomerId( customerld ); withdrawal.SetBalance( balance ); withdrawal.SetWithdrawalAmount( withdrawalAmount ); .withdrawal.SetWithdrawalDate( withdrawalDate );

ProcessWithdrawal( withdrawal );

Код уборки - еще один дурной знак.

"customerld = withdrawal.GetCustomerId(); balance - withdrawal.GetBalanceO; withdrawalAmount = withdrawal.GetWithdrawalAmount(); withdrawalDate - withdrawal.GetWithdrawalDateO;

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



Пример кода подготовки к вызову метода и кода уборки - плохой код (С++)

withdrawal = new WithclrawalTransaction( customerld, balance,

withdrawalAmount, withdrawalDate ); withdrawal.ProcessWithdrawal(); delete withdrawal;

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

Пример метода, не требующего ни подготовки, ни уборки, - хороший код (С++)

ProcessWithdrawal( customerld, balance, withdrawalAmount, withdrawalDate );

Заметьте, что похожая проблема возникает и в обратном случае. Так, если у вас обычно есть объект WitbdrawalTransaction, но в метод ProcessWitbdrawal передаются только несколько значений объекта, вам следует подумать о рефакторинге интерфейса метода, чтобы он принимал объект WitbdrawalTransaction, а не его отдельные поля:

Пример кода, требующего нескольких вызовов методов (С++)

ProcessWithdrawal( withdrawal.GetCustomerId(), withdrawal.GetBalance(), withdrawal.GetWithdrawalAmount(), withdrawal.GetWithdrawalDate() );

Каждый из этих подходов может быть как верным, так и неверным: все зависит от того, какую абстракцию формирует интерфейс метода ProcessWitbdrawalQ- Если абстракция подразумевает, что метод ожидает четыре отдельных элемента данных, используйте один подход; если метод ожидает сразу весь объект Witbdrawa-ITransaction, выберите другой.

Прогрсинма содержит код, который может когда-нибудь понадобиться

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

Требования к коду, «проектируемому впрок», не разрабатываются в полном объеме, поэтому программист скорее всего не угадает эти будущие требования. Код, «написанный в расчете на будущее», в итоге придется выбросить.

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

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



Дополнительный код, «проектируемый впрок», создает дополнительную сложность, что приводит к дополнительному тестированию, исправлению дефектов и т. д. Результат - замедление работы над проектом.

Мнение экспертов по этому поводу однозначно: если вы хотите наилучшим образом подготовиться к будущим требованиям, не пишите гипотетически нужный код, а уделите повышенное внимание ясности и понятности кода, который нужен прямо сейчас, чтобы будущие программисты знали, что он делает, чего не делает, и могли быстро и правильно изменить его (Fowler, 1999; Beck, 2000).

Контрольный список: разумные причины т&мтхтт выполнения рефакторинга

□ Код повторяется.

□ Метод слишком велик.

□ Цикл слишком велик или слишком глубоко вложен в другие циклы.

□ Класс имеет плохую связность.

□ Интерфейс класса не формирует согласованную абстракцию.

□ Метод принимает слишком много параметров.

□ Отдельные части класса изменяются независимо от других частей.

□ При изменении программы требуется параллельно изменять несколько классов.

□ Вам приходится параллельно изменять несколько иерархий наследования.

□ Вам приходится параллельно изменять несколько блоков case.

□ Родственные элементы данных, используемые вместе, не организованы в классы.

□ Метод использует больше элементов другого класса, чем своего собственного.

□ Элементарный тип данных перегружен.

□ Класс имеет слишком ограниченную функциональность.

□ По цепи методов передаются бродячие данные.

□ Объект-посредник ничего не делает.

□ Один класс слишком много знает о другом классе.

□ Метод имеет неудачное имя.

□ Данные-члены сделаны открытыми.

□ Подкласс использует только малую долю методов своих предков.

□ Сложный код объясняется при помощи комментариев.

□ Код содержит глобальные переменные.

□ Перед вызовом метода выполняется подготовительный код (после вызова метода выполняется код «уборки»).

□ Программа содержит код, который может когда-нибудь понадобиться.

Когда не следует выполнять рефакторинг?

Значение слова «рефакторинг» довольно размыто: так называют исправление дефектов, реализацию новой функциональности, модификацию проекта - по сути любое изменение кода. Это неуместно. Целенаправленный процесс изменений может быть эффективной стратегией, обеспечивающей постепенное повышение качества программы при ее сопровождении и предотвращающей всем известную смертельную спираль энтропии ПО, но само по себе изменение достоинств не имеет.



0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 [184] 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294



0.0024