什么时候应该在 C# 方法名称中使用“Try”？

Question

我们正在与我们的同事讨论如果方法名称以“Try”开头意味着什么。

有以下意见：

• 当方法可以返回空值时使用“Try”。
• 当方法不会抛出异常时使用“Try”。

官方定义是什么？方法名称中的“Try”是什么意思？ 对此有官方指南吗？

Answer 1

（已更正） 正如 Erik 建议的那样，有官方指南。

当我看到TrySomething 方法时，我认为它

• 不扔
• 返回bool
• 如果我期望值，它通过'out'参数返回
• 存在Something 方法，它允许我自己处理任何异常。 （编辑，由 Jesse Webb 建议）

Answer 2

你必须在方法名中使用“Try”，当你想表明方法调用会产生无效结果的事实时。顺便说一下，按照 .NET 标准，它不是引发异常的函数，而是返回一些 VALID 或 NON_VALID 的函数，从程序的角度来看，值。

最后，这一切都与您决定在小组中使用的命名约定有关。

Answer 3

这被称为 TryParse 模式，已被 Microsoft 记录。 official Exceptions and Performance MSDN page says：

对于可能在常见情况下抛出异常的成员考虑 TryParse 模式，以避免与异常相关的性能问题。

因此，如果您的代码在常规用例中意味着它可能会引发异常（例如解析 int），则 TryParse 模式是有意义的。

Answer 4

我认为当你想继续时应该使用try。方法是否返回一些值并不重要。

案例1：如果返回正常，您可以通过某种方式继续。

情况2：如果不返回：还是可以的；您可以通过其他方式继续。

如果您希望某个值作为该方法的输出，请使用 out 参数。

示例

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

Answer 5

如果出现以下情况，请确保在方法名称中包含 try：

• 你不会抛出任何异常
• 您的方法具有以下签名：bool TrySomething(input, out yourReturn)

所以基本上，如果我们使用try-methods，我们只会得到一个布尔结果。

所以下面的代码不会抛出任何异常：

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 方法是一种更安全、更具防御性的编码方式。 此外，如果代码 sn-p #2 不是整数，则执行起来需要更高的性能。

Answer 6

鲍勃叔叔在他的清洁代码一书中给出了下面的例子。每当我们期望抛出异常时，我们可以在方法名称中使用 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 方法的职责。

Microsoft 的TryParse 模式违反了干净的代码准则，即我们应该避免输出参数。

如果我们不开发新版本的 C#，我们不必遵守所有 Microsoft 准则。有时它们不是最好的。