Verwendet "out" schlechte Praxis

Question

Ich habe gerade hinzugefügt aus bool Parameter zu einer Methode, die ich geschrieben habe, um eine Warnung in meine UI zu bekommen. Ich habe ein out verwendet, anstatt die Methode selbst zu bekommen, falsch/wahr zurückzugeben, da dies die DoSomething failed/succeed bedeuten würde. Mein Denken war, dass die warnUser zeigen würde, was die Warnung tatsächlich war, ohne auf die Implementierung der Methode zu schauen.

Originalcode

public void DoSomething(int id, string input); 

Neuer Code

public void DoSomething(int id, string input, out bool warnUser); 

ich Moq mit diesem Code zu testen, aber es bietet keine Unterstützung/ref Parameter aus, weil sie nicht unterstützt von Lambda-Ausdrücken

Testcode

mockService.Verify(It.IsAny<int>(), It.IsAny<string>(), It.IsAny<bool>()); 

So wird mit aus Parametern schlechte Praxis und wenn ja, was soll ich tun, statt?

Answer 1

stoppt einen out-Parameter in einem Hohlraum Methode ist im Allgemeinen eines schlechte Idee. Sie sagen, Sie haben es verwendet, "anstatt die Methode selbst dazu zu bringen, falsch/wahr zurückzugeben, da dies bedeuten würde, dass die DoSomething gescheitert ist/gelungen ist" - ich glaube nicht, dass diese Implikation vorhanden ist. In .NET wird der Fehler normalerweise durch eine Ausnahme und nicht durch true/false angezeigt.

out Parameter sind in der Regel hässliche Rückgabewerte zu verwenden, als - insbesondere eine Variable des richtigen Typs zu handhaben haben, so dass Sie nicht nur schreiben:

if (DoSomething(...)) 
{ 
    // Warn user here 
} 

Alternative Man könnten Sie Möchten Sie in Betracht ziehen, ist eine Aufzählung, die die erforderliche Warnstufe angibt. Zum Beispiel:

public enum WarningLevel 
{ 
    NoWarningRequired, 
    WarnUser 
} 

Dann könnte die Methode zurückgeben WarningLevel statt bool. Das würde deutlicher machen, was Sie meinten - obwohl Sie die Dinge vielleicht etwas umbenennen möchten. (Es ist schwer, Ratschläge mit metasyntaktischen Namen wie "DoSomething" zu geben, obwohl ich völlig verstehe, warum Sie das hier benutzt haben.)

Natürlich können Sie auch andere Informationen haben - wie die Grund für die Warnung. Das könnte mit einem Enum gemacht werden, oder Sie möchten vielleicht etwas reicheres Ergebnis geben.

Answer 2

Ein paar zusätzliche Gedanken:

• Was FxCop sagt: CA1021: Avoid out parameters

• Für private/interne Methoden (Implementierungsdetails) out/ref Parameter sind weniger ein Problem

• C# 7 Tuples oft sind eine bessere Alternative zu out Parameter

• Ferner verbessert C# 7 den Umgang mit out Parametern auf der Website Aufruf von „out Variablen“ Einführung und indem sie zu „verwerfen“ out Parameter

Answer 3

Ich denke, dass der beste Weg, dies zu tun ist, zu verwenden, erwartete Ausnahmen. Sie können eine Reihe von benutzerdefinierten Ausnahmen erstellen, die Ihre Warnungen definieren, und sie in der aufrufenden Methode abfangen.

public class MyWarningException : Exception() {} 

... 

try 
{ 
    obj.DoSomething(id,input); 
} 
catch (MyWarningException ex) 
{ 
    // do stuff 
} 

Die Idee wäre, dass die Ausnahme am Ende der Umsetzung DoSomething angehoben wird, so dass der Fluss nicht in der Mitte

Answer 4

out ist sehr viel ein nützliches Konstrukt, insbesondere in Mustern wie bool TryGetFoo(..., out value), wo Sie die „if“ und das „Was“ getrennt wissen wollen (und nullable ist nicht unbedingt eine Option).

jedoch - in diesem Fall, warum nicht einfach machen:

public bool DoSomething(int id, string input); 

und den Rückgabewert verwenden, um dies zu signalisieren?

Answer 5

Dies ist eine wirklich schwierige Frage zu beantworten, ohne mehr über den Kontext zu wissen.

Wenn DoSomething ist eine Methode in der UI-Schicht, die etwas tun, die UI verwandt ist, dann ist es vielleicht in Ordnung. Wenn DoSomething eine Business-Schicht-Methode ist, dann ist dies wahrscheinlich kein guter Ansatz, weil es bedeutet, dass die Business-Schicht verstehen muss, was eine angemessene Antwort sein könnte, und sie muss möglicherweise sogar auf Lokalisierungsprobleme achten.

Aus rein subjektiver Sicht habe ich mich von Out-Parametern fern gehalten. Ich denke, sie stören den Fluss des Codes und machen es etwas weniger klar.

Answer 6

Ich denke, die beste beste Lösung für Ihren Fall ist die Verwendung eines Delegaten anstelle von Bool. Verwenden Sie etwas wie folgt:

Sie können eine leere Lamda weitergeben, wo Sie Warnungen an den Benutzer nicht anzeigen möchten.

Answer 7

Angesichts einer großen Legacy-Code-Methode (sagen 15 Zeilen, Legacy-Code-Methoden mit mehr als 200 Zeilen sind ziemlich häufig), könnte man die "Extract Method" Refactoring verwenden, um Code weniger spröde und wartungsfreundlicher zu machen .

Ein solches Refactoring führt sehr wahrscheinlich zu einer oder mehreren neuen Methoden mit out-Parametern für die Einstellung von lokalen Variablenwerten für die vorherige Methode.

Persönlich verwende ich diesen Umstand für einen starken Hinweis, dass es eine oder mehrere diskrete Klassen in der früheren Methode versteckt hat, so dass ich "Klasse extrahieren" kann, wo in der neuen Klasse diese out-Parameter Eigenschaften sichtbar machen an die aufrufende (vorherige) Methode.

Ich halte es für eine schlechte Praxis, die extrahierten Methoden ohne Parameter in der früheren Methode zu belassen und den kohärenten folgenden Schritt von "Klasse extrahieren" zu überspringen, weil diese lokalen Variablen in Ihrer früheren Funktion verbleiben, aber tun semantisch gehören nicht mehr dazu.

Also, in einem solchen Szenario, out Parameter sind meiner Meinung nach ein Code, der SRP bricht.