Wann soll "Try" in C # -Methodennamen verwendet werden?

Wir haben mit unseren Mitarbeitern darüber gesprochen, was es bedeutet, wenn der Methodenname mit "Try" beginnt.

Es gab folgende Meinungen:

• Verwenden Sie "Try", wenn die Methode einen Nullwert zurückgeben kann.
• Verwenden Sie "Try", wenn die Methode keine Ausnahme auslöst.

Was ist die offizielle Definition? Was sagt "Try" im Methodennamen? Gibt es eine offizielle Richtlinie dazu?

Dies ist als TryParse- Muster bekannt und wurde von Microsoft dokumentiert. Auf der offiziellen MSDN-Seite für Ausnahmen und Leistung heißt es :

Betrachten Sie das TryParse-Muster für Mitglieder, die in allgemeinen Szenarien Ausnahmen auslösen können, um Leistungsprobleme im Zusammenhang mit Ausnahmen zu vermeiden.

Wenn Sie also Code haben, für den ein regulärer Anwendungsfall bedeuten würde, dass er eine Ausnahme auslösen könnte (z. B. das Parsen eines Int), ist das TryParse- Muster sinnvoll.

(Korrigiert) Es gibt offizielle Richtlinien, wie Erik vorgeschlagen hat.

Wenn ich TrySomethingMethode sehe , nehme ich es an

• wirft nicht
• kehrt zurück bool
• Wenn ich einen Wert erwarte, wird dieser über den Parameter 'out' zurückgegeben
• Es gibt eine SomethingMethode, mit der ich jede Ausnahme selbst behandeln kann. (bearbeiten, vorgeschlagen von Jesse Webb)

Ich denke, Sie sollten verwenden, trywenn Sie fortfahren möchten. Es spielt keine Rolle, ob eine Methode einen Wert zurückgibt oder nicht.

Fall 1: Wenn es gut zurückkehrt, können Sie auf irgendeine Weise fortfahren.

Fall 2: Wenn es nicht zurückkehrt: Es ist immer noch in Ordnung. Sie können auch anders vorgehen.

Und wenn Sie einen Wert als Ausgabe dieser Methode erwarten, verwenden Sie den outParameter.

Beispiel

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

Sie müssen "Try" im Methodennamen verwenden, wenn Sie die Tatsache manifestieren möchten, dass der Methodenaufruf zu einem ungültigen Ergebnis führen kann. Nach dem .NET-Standard ist es übrigens keine Funktion, die eine Ausnahme auslöst, sondern die Funktion, die einen Wert VALIDoder NON_VALIDaus Programmsicht einen Wert zurückgibt .

Am Ende dreht sich alles um die Namenskonvention, die Sie in Ihrer Gruppe verwenden möchten.

tryStellen Sie sicher, dass Sie in Ihren Methodennamen aufnehmen, wenn:

• Sie werfen keine Ausnahme
• Ihre Methode hat die folgende Signatur: bool TrySomething(input, out yourReturn)

Wenn wir also try-methods verwenden, erhalten wir nur ein boolesches Ergebnis zurück.

Der folgende Code löst also keine Ausnahmen aus:

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

Während dieser Code Ausnahmen auslösen kann (und in diesem Fall wird):

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

Die Verwendung von Try-Methoden ist eine sicherere und defensivere Methode zum Codieren. Auch die Ausführung des Code-Snippets Nr. 2 erfordert mehr Leistung, wenn es sich nicht um eine Ganzzahl handelt.

Onkel Bob gibt das folgende Beispiel in seinem Buch Clean Code . Wann immer wir erwarten, dass eine Ausnahme ausgelöst wird, können wir das TryPräfix für einen Methodennamen verwenden:

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

Und dann (angepasst):

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

Die tryToShutDownMethode führt keine Fehlerbehandlung durch, da dies in der Verantwortung der sendShutDownMethode liegt.

Das TryParseMuster von Microsoft verstößt gegen die Clean Code-Richtlinie, die besagt, dass Ausgabeparameter vermieden werden sollten.

Wenn wir keine neue Version von C # entwickeln, müssen wir uns nicht an alle Microsoft-Richtlinien halten. Manchmal sind sie nicht die Besten.