Коли в іменах методу C # слід використовувати "Спробуйте"?

Ми обговорювали з нашими колегами про те, що це означає, якщо назва методу починається з "Спробувати".

Існували такі думки:

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

Яке офіційне визначення? Що означає "Спробуйте" у назві методу? Чи існує якесь офіційне керівництво щодо цього?

Ця модель відома як модель TryParse і була задокументована Microsoft. На офіційній сторінці MSDN про винятки та ефективність сказано :

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

Таким чином, якщо у вас є код, для якого звичайний випадок використання може означати, що він може кинути виняток (наприклад, розбір int), модель TryParse має сенс.

(Виправлено) Є офіційна інструкція, як запропонував Ерік.

Коли я бачу TrySomethingметод, я припускаю його

• не кидає
• повертає bool
• якщо я очікую значення, воно повертається через параметр 'out'
• існує Somethingметод, який дозволяє мені самостійно впоратися з будь-яким винятком. (редагувати, запропонував Джессі Вебб)

Я думаю, ви повинні використовувати, tryколи хочете продовжити. Не має значення, метод повертає якесь значення чи ні.

Випадок 1: якщо він повернеться нормально, ви можете продовжити певним чином.

Випадок 2: якщо воно не повертається: воно все одно добре; можна продовжувати інакше.

І якщо ви очікуєте деяке значення як вихід цього методу, тоді використовуйте outпараметр.

Приклад

int value
if (dictionary.TryGetValue("key", out value))
{
    // Proceed in some way
}
else
{
    // Proceed in some other way
}

Ви повинні використовувати "Спробувати" у назві методу, коли ви хочете виявити факт, що виклик методу може давати недійсний результат. Дотримуючись стандарту .NET, це, до речі, не функція, яка викликає виняток, а функція, яка повертає деяке VALIDабо NON_VALID, з точки зору програми, значення.

Зрештою, це все про конвенцію про іменування, яку ви вирішили використовувати у своїй групі.

Обов’язково вкажіть tryу своєму імені методу, якщо:

• ви не кидаєте жодного винятку
• ваш метод має такий підпис: bool TrySomething(input, out yourReturn)

Отже, якщо ми використовуємо try-методи, ми отримуємо лише булевий результат.

Отже, наступний код не викидає жодних винятків:

string input = "blabla";
int number;
if (int.TryParse(input, out number))
{
// wooohooo we got an int!
} else
{
//dooh!
}

Тоді як цей код може (і в цьому випадку буде) викидати винятки:

string input = "blabla";
int number;
try
{
     number = int.Parse(input); //throws an exception
}
catch (Exception)
{
     //dooh!
}

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

Дядько Боб наводить приклад нижче у своїй книзі « Чистий код» . Щоразу, коли ми очікуємо, що виняток буде видалено, ми можемо використовувати Tryпрефікс до назви методу:

public void sendShutDown()
{
    try{
        tryToShutDown();
    } catch (DeviceShutDownError e) {
        logger.log(e);            
    }
}

А потім (адаптовано):

private void tryToShutDown()
{
    //some code with no error handling, but
    //something might go wrong here
}

tryToShutDownМетод не робить ніякої обробки помилок, тому що це відповідальність sendShutDownметоди.

TryParseМодель Microsoft порушує чистий код директиву , яка говорить , що ми повинні уникати вихідних параметрів.

Якщо ми не розробляємо нову версію C #, нам не доведеться дотримуватися всіх інструкцій Microsoft. Іноді вони не найкращі.