Question

带有XML文档的示例方法：

// summary and param tags are here when you're not looking.
/// <exception cref="ArgumentNullException>
///    <paramref name="text" /> is null.
/// </exception>
public void Write(string text)
{
    if (text == null)
        throw new ArgumentNullException("text", "Text must not be null.");

    // sync stuff...
}

Write(null)按预期抛出异常。这是一个异步方法：

public async Task WriteAsync(string text)
{
    if (text == null)
        throw new ArgumentNullException("text", "Text must not be null.");

    // async stuff...
}

WriteAsync(null)，在等待之前不会抛出异常。我是否应该在ArgumentNullException代码中指定exception？我认为这会让消费者认为调用WriteAsync可能会抛出ArgumentNullException并写下这样的内容：

Task t;
try
{
    t = foo.WriteAsync(text);
}
catch (ArgumentNullException)
{
    // handling stuff.
}

在异步方法中记录异常的最佳做法是什么？

Answer 1

不是直接的答案，但我个人建议我在这里倾向于快速失败;这可能意味着编写两种方法：

public Task WriteAsync(string text) // no "async"
{
    // validation
    if (text == null)
        throw new ArgumentNullException("text", "Text must not be null.");

    return WriteAsyncImpl(text);
}
private async Task WriteAsyncImpl(string text)
{
    // async stuff...
}

此模式也是添加“快速路径”代码的理想位置，例如：

public Task WriteAsync(string text) // no "async"
{
    // validation
    if (text == null)
        throw new ArgumentNullException("text", "Text must not be null.");

    if (some condition)
        return Task.FromResult(0); // or similar; also returning a pre-existing
                                   // Task instance can be useful

    return WriteAsyncImpl(text);
}

Answer 2

Microsoft似乎没有区分抛出异常的async方法和在Task属性中存储异常的返回Exception。 E.g：

WebClient.DownloadFileTaskAsync(string, string)

就个人而言，我会选择将异常记录为返回值文档的一部分（即返回的Task），因为这种区别对于客户来说可能很重要。

Answer 3

我建议保留异常标记，因为它们会出现在Intellisense中。

为简洁起见，只要符合直觉，我就不会提及异常是否快速失败。即，健全性检查应快速失败，而执行期间的失败则不应如此。如果您必须背离此规则，请记录下来。

请注意，更改是同步引发异常（快速失败）还是等待异常，可能会破坏客户代码。

如何记录异步方法的异常？

3 个答案: