Налагодження проти викидів

Я прочитав безліч статей (і ще пару подібних запитань, які були опубліковані на StackOverflow) про те, як і коли використовувати твердження, і я їх добре розумів. Але все-таки я не розумію, яка мотивація повинна спонукати мене використовувати Debug.Assertзамість простого виключення. Я маю на увазі те, що у .NET за замовчуванням відповідь на невдале твердження - "зупинити світ" та показати вікно повідомлення користувачеві. Хоча такий спосіб поведінки можна модифікувати, я вважаю це дуже прикрим і зайвим робити це, хоча я міг би натомість просто підкинути відповідний виняток. Таким чином, я міг легко записати помилку в журнал програми безпосередньо перед тим, як видалити виняток, і, крім того, моя програма не обов'язково зависає.

То чому я, якщо взагалі, маю використовувати Debug.Assertзамість простого винятку? Розміщення твердження там, де воно не повинно бути, може просто спричинити всі види "небажаної поведінки", тому, на мій погляд, я справді нічого не отримую, використовуючи твердження, замість того, щоб кидати виняток. Ви згодні зі мною, чи мені тут чогось не вистачає?

Примітка: Я повністю розумію, в чому полягає різниця "в теорії" (налагодження проти випуску, моделі використання тощо), але, як я бачу, мені було б краще кинути виняток замість виконання твердження. Оскільки, якщо у виробничому випуску виявлено помилку, я все одно хотів би, щоб "твердження" провалилося (врешті-решт, "накладні витрати" смішно малі), тому мені краще замість цього викинути виняток.

Редагувати: Я бачу це, якщо затвердження не вдалося, це означає, що програма перейшла в якийсь пошкоджений, несподіваний стан. То чому я хотів би продовжувати виконання? Не має значення, працює програма на налагоджувальній чи випускній версії. Те саме стосується обох

Хоча я згоден з тим, що ваші міркування є правдоподібними - тобто, якщо твердження порушено несподівано, має сенс зупинити страту, кинувши - я особисто не використовував би винятків замість тверджень. Ось чому:

Як уже говорили інші, твердження повинні документувати ситуації, які неможливо , таким чином , що якщо нібито неможлива ситуація збувається, повідомляється розробник. Винятки, навпаки, забезпечують механізм управління потоком у виняткових, малоймовірних або помилкових ситуаціях, але не неможливих ситуаціях. Для мене ключова відмінність полягає в наступному:

• Завжди повинно бути можливим скласти тестовий кейс, який виконує заданий викид. Якщо неможливо створити такий тестовий приклад, тоді у вашій програмі є шлях до коду, який ніколи не виконується, і його слід видалити як мертвий код.

• НІКОЛИ не повинно бути можливо створити тест-кейс, який спричиняє спрацьовування твердження. Якщо твердження спрацьовує, або код помилковий, або твердження помилкове; в будь-якому випадку, щось потрібно змінити в коді.

Ось чому я б не замінив твердження винятком. Якщо твердження насправді не може запуститись, то заміна його на виняток означає, що у вашій програмі є неперевірний шлях коду . Мені не подобаються неперевірені шляхи коду.

Твердження використовуються для перевірки розуміння програмістом світу. Твердження повинно провалитися, лише якщо програміст зробив щось не так. Наприклад, ніколи не використовуйте твердження для перевірки введення користувачем.

Стверджує тест на умови, які "не можуть відбутися". Виняток становлять умови, які "не повинні відбуватися, але мають відбуватися".

Твердження корисні тим, що під час побудови (або навіть часу виконання) ви можете змінити їх поведінку. Наприклад, часто у збірках випусків твердження навіть не перевіряються, оскільки вони створюють непотрібні накладні витрати. З цим також слід бути обережним: ваші тести можуть навіть не виконуватися.

Якщо ви використовуєте винятки замість тверджень, ви втрачаєте деяке значення:

1. Код є більш багатослівним, оскільки тестування та створення винятку складає принаймні два рядки, тоді як твердження - лише один.

2. Ваш код тестування і скидання завжди працюватиме, тоді як твердження можна скомпілювати.

3. Ви втрачаєте деяку комунікацію з іншими розробниками, оскільки твердження мають інше значення, ніж код продукту, який перевіряє та кидає. Якщо ви дійсно тестуєте твердження програмування, використовуйте твердження.

Більше тут: http://nedbatchelder.com/text/assert.html

РЕДАГУВАТИ: У відповідь на редагування / нотатку, яку ви зробили у своєму дописі: Схоже, використання винятків - це правильна річ, яку слід використовувати, а не використовувати твердження щодо того, що ви намагаєтесь виконати. Я думаю, що розумовий камінь спотикання, який ви вражаєте, полягає в тому, що ви розглядаєте винятки та твердження, щоб виконати ту саму мету, і тому ви намагаєтеся з’ясувати, який із них буде “правильним” використовувати. Незважаючи на те, що може існувати деяке накладання на те, як можна використовувати твердження та винятки, не плутайте, що для них вони є різними рішеннями однієї і тієї ж проблеми - вони не є. Кожне твердження та винятки мають своє призначення, сильні та слабкі сторони.

Я збирався набрати відповідь своїми словами, але це робить концепцію кращою, ніж я мав би:

C # Station: Твердження

Використання тверджень assert може бути ефективним способом виявлення помилок логіки програми під час виконання, і все ж вони легко відфільтровуються із виробничого коду. Після завершення розробки вартість виконання цих надлишкових тестів на помилки кодування може бути усунена простим визначенням символу препроцесора NDEBUG [який відключає всі твердження] під час компіляції. Проте пам’ятайте, пам’ятайте, що код, розміщений у самому затвердженні, буде опущений у виробничій версії.

Твердження найкраще використовувати для перевірки стану лише тоді, коли виконуються всі наведені нижче умови.

* the condition should never be false if the code is correct,
* the condition is not so trivial so as to obviously be always true, and
* the condition is in some sense internal to a body of software.

Твердження майже ніколи не слід використовувати для виявлення ситуацій, що виникають під час нормальної роботи програмного забезпечення. Наприклад, зазвичай твердження не слід використовувати для перевірки помилок у введенні користувачем даних. Однак може мати сенс використовувати твердження для підтвердження того, що абонент вже перевірив введення користувача.

В основному, використовуйте винятки для речей, які потрібно вловити / вирішити у виробничому додатку, використовуйте твердження для виконання логічних перевірок, які будуть корисні для розробки, але вимкнені у виробництві.

Я думаю, що (надуманий) практичний приклад може допомогти висвітлити різницю:

(адаптоване з розширення Batch для MoreLinq )

// 'public facing' method
public int DoSomething(List<string> stuff, object doohickey, int limit) {

    // validate user input and report problems externally with exceptions

    if(stuff == null) throw new ArgumentNullException("stuff");
    if(doohickey == null) throw new ArgumentNullException("doohickey");
    if(limit <= 0) throw new ArgumentOutOfRangeException("limit", limit, "Should be > 0");

    return DoSomethingImpl(stuff, doohickey, limit);
}

// 'developer only' method
private static int DoSomethingImpl(List<string> stuff, object doohickey, int limit) {

    // validate input that should only come from other programming methods
    // which we have control over (e.g. we already validated user input in
    // the calling method above), so anything using this method shouldn't
    // need to report problems externally, and compilation mode can remove
    // this "unnecessary" check from production

    Debug.Assert(stuff != null);
    Debug.Assert(doohickey != null);
    Debug.Assert(limit > 0);

    /* now do the actual work... */
}

Отже, як сказали Ерік Ліпперт та інші, ви стверджуєте лише ті речі, які, на вашу думку, будуть правильними, на той випадок, якщо ви (розробник) випадково використали їх десь ще, тож ви можете виправити свій код. Ви в основному кидаєте винятки, коли ви не можете контролювати або не можете передбачити, що надходить, наприклад, для введення користувачем , так що все, що дало йому погані дані, могло відповісти належним чином (наприклад, користувач).

Ще один самородок від Code Complete :

"Твердження - це функція або макрос, який голосно скаржиться, якщо припущення не відповідає дійсності. Використовуйте твердження, щоб задокументувати припущення, зроблені в коді, і змити несподівані умови. ...

"Під час розробки твердження видаляють суперечливі припущення, несподівані умови, погані значення, що передаються до процедур тощо".

Далі він додає деякі вказівки щодо того, що слід, а що не слід стверджувати.

З іншого боку, винятки:

"Використовуйте обробку винятків, щоб привернути увагу до несподіваних випадків. Виняткові випадки повинні оброблятися таким чином, щоб зробити їх очевидними під час розробки та відновити, коли працює виробничий код."

Якщо у вас немає цієї книги, вам слід її придбати.

Debug.Assert за замовчуванням працюватиме лише в налагоджувальних збірках, тому, якщо ви хочете виявити будь-яку погану несподівану поведінку у збірках випусків, вам доведеться використовувати винятки або вмикати константу налагодження у властивостях вашого проекту (що враховується в загалом, щоб не бути гарною ідеєю).

Використовуйте твердження щодо речей, які МОЖЛИВІ, але не повинні відбуватися (якщо це було неможливо, чому б ви давали твердження?).

Хіба це не схоже на випадок використання Exception? Чому б ви використовували твердження замість Exception?

Тому що перед вашим твердженням повинен бути код, який викликається, що зупинить параметр твердження хибним.

Зазвичай перед вашим кодом не існує коду, Exceptionякий гарантує, що його не кинуть.

Чому це добре, що Debug.Assert()компілюється у прод? Якщо ви хочете знати про це під час налагодження, чи не хочете ви про це знати у prod?

Ви хочете цього лише під час розробки, тому що, знайшовши Debug.Assert(false)ситуації, ви пишете код, щоб гарантувати, що Debug.Assert(false)це не повториться. Після завершення розробки, припускаючи, що ви знайшли Debug.Assert(false)ситуації та виправили їх, їх Debug.Assert()можна сміливо скомпілювати, оскільки вони тепер зайві.

Припустимо, ви є членом досить великої команди, і кілька людей працюють над однією загальною базою коду, включаючи накладання класів. Ви можете створити метод, який викликається кількома іншими методами, і, щоб уникнути суперечки щодо блокування, ви не додаєте до нього окремий замок, а навпаки "припускаєте", що він раніше був заблокований методом виклику за допомогою певного блокування. Такі, як Debug.Assert (RepositoryLock.IsReadLockHeld || RepositoryLock.IsWriteLockHeld); Інші розробники можуть пропустити коментар, який говорить, що метод виклику повинен використовувати блокування, але вони не можуть ігнорувати це.