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

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

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

Создание собственного механизма утверждений

Многие языки программирования, включая С++, Java, и

со6ст0бнйойвдадрыут0ерж- Microsoft Visual Basic, имеют встроенную поддержку утвер-

дений - хороший пример щй- ждений. Если ваш язык не поддерживает процедуры утвер-

грамширошйя <*о йшояьаш- ждений напрямую, их легко написать. Стандартный макрос

швы яйьйса», а нб просто про* assert языка С++ не предусматривает вывода текстового со-

грашйрованш «на языке». Под общения. Вот пример улучшенного макроса ASSERT на С++: ровнее об зтйх различиях см. j j

раздел 34Л Пример макроса утверждения (С++)

#define ASSERT( condition, message ) { \

if ( !(condition) ) { \

LogError( " Assertion failed: ", \

#condition, message ); \

exit( EXIT FAILURE ); \

Общие принципы использования утверждений

Далее перечислены общие положения по применению утверждений.

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

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

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

Старайтесь не помещать выполняемый код в утверждения Если в утверждении содержится код, возникает возможность удаления этого кода компилятором при отключении утверждений. Допустим, у вас есть следующее утверждение:



Пример опасного использования утверждения (Visual Basic) n*-***-.*-

врвя1вс111др1 йщЫЯЯл можете

Debug. Assert( PerformAction() ) Невозможно выполнить действие. рЖШУршгк шт ащШ Ш

одну т ттш пробящ связан-

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

Пример безопасного использования утверждения (Visual Basic)

actionPerformed = PerformAction()

Debug.Assert( actionPerformed ) Невозможно выполнить действие.

Используйте утверждения для документирования и fgfxt сюжш О \щ проверки предусловий и постусловий Предусловия и щщщщ й постусяоеш см. постусловия - это часть подхода к проектированию и раз- «Object-Oriented Software Con-работке программ, известному как «проектирование по кон- ruction* (Meyer, 1097), тракту» (Meyer, 1997). При использовании пред- и постусловий каждый метод или класс заключает контракт с остальной частью программы.

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

Постусловия - это соглашения, которые метод или класс обещает выполнить при завершении своей работы. Постусловия - это обязательства метода или класса перед кодом, который их использует.

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

В следующем примере утверждения документируют пред- и постусловия в функции Velocity:

Пример использования утверждений для документирования пред- и постусловий (Visual Basic)

Private Function Velocity ( ByVal latitude As Single, ByVal longitude As Single, ByVal elevation As Single ) As Single

Предусловия

Debug.Assert ( -90 <= latitude And latitude <= 90 )

Debug.Assert ( 0 <= longitude And longitude < 360 )

Debug.Assert ( -500 <= elevation And elevation <= 75000 )



Постусловия

Debug.Assert ( О <= returnVelocity And returnVelocity <= 600 )

Возвращаемое значение Velocity = returnVelocity End Function

Если бы переменные latitude, longitude и elevation поступили из внешнего источника, корректность их значений должна была быть проверена и обработана в коде обработчика ошибок, а не с помощью утверждений. Но если эти переменные поступили из доверенного внутреннего источника, а метод спроектирован в предположении, что их значения будут в разрешенном интервале, то применение утверждений допустимо.

Г1е1е1феша11 т\тг Об устой- большей устойчивости кода проверяйте утвер-

ттт ш. «Устойчивость про- ждения, а затем все равно обработайте возможные

тйв корректности» разбп 8.3. ошибки Каждая потенциально ошибочная ситуация обычно проверяется или утверждением, или кодом обработчика ошибок, но не тем и другим вместе. Некоторые эксперты утверждают, что необходим только один тип проверки (Meyer, 1997).

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

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

Вот как это можно сделать на примере функции Velocity:



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.0041