Когда предполагается использовать «Try» в именах методов C #?

Мы обсуждали с нашими коллегами, что означает, если имя метода начинается с «Try».

Были следующие мнения:

• Используйте «Try», когда метод может вернуть нулевое значение.
• Используйте «Try», когда метод не сгенерирует исключение.

Какое официальное определение? Что говорит «Try» в названии метода? Есть ли официальное руководство по этому поводу?

Это известно как шаблон 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
}

Вы должны использовать «Try» в имени метода, когда вы хотите продемонстрировать тот факт, что вызов метода может привести к неверному результату. Следуя стандарту .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!
}

Использование методов Try - более безопасный и более безопасный способ написания кода. Также фрагмент кода № 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. Иногда они не самые лучшие.