正在使用“out”不好的做法

Question

我刚刚在我编写的方法中添加了一个 out bool 参数，以便在我的 UI 中收到警告。我使用了 out 而不是让方法本身返回 false/true，因为这意味着 DoSomething 失败/成功。我的想法是 warnUser 将指示警告实际上是什么，而不必查看该方法的实现。

原始代码

public void DoSomething(int id, string input);

新代码

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

我正在使用 Moq 来测试此代码，但它不支持 out/ref 参数，因为 Lambda 表达式不支持它们

测试代码

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

那么，使用 out 参数是不好的做法吗？如果是，我该怎么办？

Answer 1

在 void 方法中使用 out 参数通常是一个坏主意。你说你已经使用它“而不是让方法本身返回 false/true，因为这意味着 DoSomething 失败/成功” - 我不相信存在这种暗示。通常在 .NET 中，失败是通过异常而不是真/假来指示的。

out 参数通常比返回值使用起来更难看 - 特别是，您必须有一个正确类型的变量来处理，因此您不能只写：

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

您可能需要考虑的一种替代方法是指示所需警告级别的枚举。例如：

public enum WarningLevel
{
    NoWarningRequired,
    WarnUser
}

然后该方法可以返回 WarningLevel 而不是 bool。这会让你的意思更清楚——尽管你可能想稍微重命名一些东西。 （很难用诸如“DoSomething”之类的元语法名称提供建议，尽管我完全理解您为什么在这里使用它。）

当然，另一种选择是您可能希望提供更多信息 - 就像原因< /em> 作为警告。这可以通过枚举来完成，或者您可能想完全给出一些更丰富的结果。

Answer 2

out 是非常一个有用的构造，特别在像 bool TryGetFoo(..., out value) 这样的模式中>，您想分别了解“如果”和“什么”（可为空不一定是一个选项）。

然而 - 在这种情况下，为什么不直接做到：

public bool DoSomething(int id, string input);

并使用返回值来表示这一点？

Answer 3

一些额外的想法：

• FxCop 所说的：CA1021：避免输出参数< /a>

• 对于私有/内部方法（实现细节）out/ref 参数不是一个问题

• C# 7 元组 通常是 out 参数的更好替代品

• 此外，C# 7 通过引入“out 变量”并允许“丢弃”，改进了调用站点上 out 参数的处理out 参数

Answer 4

给定一个大的遗留代码方法（例如 15 行以上，200 行以上的遗留代码方法很常见），人们可能希望使用“提取方法”重构来清理并使代码更不易损坏且更易于维护。

这种重构很可能产生一个或多个新方法，而没有用于设置先前方法本地变量值的参数。

就我个人而言，我使用这种情况作为一个强有力的指标，表明在先前的方法中隐藏了一个或多个离散类，以便我可以使用“提取类”，在新类中，这些输出参数获取对调用可见的属性（先前）方法。

我认为在先前的方法中留下不带参数的提取方法是不好的做法，跳过“提取类”的连贯的后续步骤，因为如果跳过它，这些局部变量仍保留在先前的函数中，但在语义上不再属于到它。

因此，在这种情况下，我认为 out 参数是破坏 SRP 的代码味道。

Answer 5

在不了解更多背景的情况下，这是一个非常难以回答的问题。

如果 DoSomething 是 UI 层中的一个方法，用于执行与 UI 相关的操作，那么也许没问题。如果 DoSomething 是业务层方法，那么这可能不是一个好方法，因为它意味着业务层需要了解适当的响应可能是什么，甚至可能必须知道是否本地化问题。

纯粹主观地说，我倾向于远离参数。我认为它们破坏了代码的流程并使其变得不太清晰。

Answer 6

我认为最好的方法是使用预期的异常。您可以创建一组定义警告的自定义异常，并在调用方法中捕获它们。

public class MyWarningException : Exception() {}

...

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

这个想法是在 DoSomething 实现结束时引发异常，以便流程不会在中间停止

Answer 7

我认为适合您的情况的最佳解决方案是使用委托而不是 bool。使用如下内容：

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

您可以传递一个空的 lamda，您不想向用户显示警告。