Kiedy „Try” powinno być używane w nazwach metod C #?

Dyskutowaliśmy z naszymi współpracownikami, co to znaczy, jeśli nazwa metody zaczyna się od „Try”.

Były następujące opinie:

• Użyj „Spróbuj”, gdy metoda może zwrócić wartość pustą.
• Użyj „Spróbuj”, gdy metoda nie zgłosi wyjątku.

Jaka jest oficjalna definicja? Co mówi „Try” w nazwie metody? Czy istnieją jakieś oficjalne wytyczne na ten temat?

Jest to znane jako wzorzec TryParse i zostało udokumentowane przez Microsoft. W oficjalnych Wyjątki i wydajności stronę MSDN mówi :

Rozważ wzorzec TryParse dla członków, którzy mogą zgłaszać wyjątki w typowych scenariuszach, aby uniknąć problemów z wydajnością związanych z wyjątkami.

Zatem jeśli masz kod, dla którego zwykły przypadek użycia oznaczałby, że może zgłosić wyjątek (taki jak parsowanie liczby całkowitej ), wzorzec TryParse ma sens.

(Poprawiony) Istnieje oficjalna wytyczna, jak sugerował Erik.

Kiedy widzę TrySomethingmetodę, zakładam, że

• nie rzuca
• zwroty bool
• jeśli oczekuję wartości, jest ona zwracana za pomocą parametru „out”
• istnieje Somethingmetoda, która pozwala mi samodzielnie obsłużyć każdy wyjątek. (edycja sugerowana przez Jesse Webb)

Myślę, że powinieneś użyć, trykiedy chcesz kontynuować. Nie ma znaczenia, że ​​metoda zwraca pewną wartość, czy nie.

Przypadek 1: jeśli zwróci się dobrze, możesz postępować w jakiś sposób.

Przypadek 2: jeśli nie zwróci: nadal jest w porządku; możesz postępować w inny sposób.

A jeśli oczekujesz pewnej wartości jako wyniku tej metody, użyj outparametru.

Przykład

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

Musisz użyć „Try” w nazwie metody, jeśli chcesz zamanifestować fakt, że wywołanie metody może dać niepoprawny wynik. Nawiasem mówiąc, zgodnie ze standardem .NET nie jest to funkcja, która wywołuje wyjątek, ale funkcja, która zwraca część VALIDlub NON_VALID, z perspektywy programu, wartość.

Na koniec chodzi o konwencję nazewnictwa, którą zdecydujesz się zastosować w swojej grupie.

Pamiętaj o dołączeniu do trynazwy metody, jeśli:

• nie rzucasz żadnych wyjątków
• twoja metoda ma następujący podpis: bool TrySomething(input, out yourReturn)

Zasadniczo, jeśli użyjemy try-metod, otrzymamy tylko wynik boolowski.

Poniższy kod nie zgłosi żadnych wyjątków:

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

Podczas gdy ten kod może (iw tym przypadku będzie) zgłaszać wyjątki:

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

Korzystanie z metod Try jest bezpieczniejszym i bardziej defensywnym sposobem kodowania. Fragment kodu nr 2 wymaga większej wydajności, jeśli nie jest liczbą całkowitą.

Wujek Bob podaje poniższy przykład w swojej książce Clean Code . Ilekroć spodziewamy się zgłoszenia wyjątku, możemy użyć Tryprefiksu nazwy metody:

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

A następnie (dostosowany):

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

tryToShutDownMetoda nie ma żadnej obsługi błędów, bo to w gestii sendShutDownmetody.

The TryParseWzór Microsoft narusza czystego kodu wytyczna, która mówi, że powinniśmy unikać parametry wyjściowe.

Jeśli nie opracowujemy nowej wersji C #, nie musimy trzymać się wszystkich wytycznych Microsoft. Czasami nie są najlepsze.