“async”/“await”方法中的参数验证应该被包装答案

【问题标题】：Parameter validation in "async"/"await" methods should be wrapped“async”/“await”方法中的参数验证应该被包装
【发布时间】：2018-11-21 23:40:13
【问题描述】：

为什么 SonarQube 在这段代码中抱怨？我阅读了解释，但并不真正理解为什么以及我需要做什么才能让它消失。

Link to SonarQube Rule

public async Task Add(SomeModel obj)
{
    if (obj == null)
    {
        throw new ArgumentNullException(nameof(obj));
    }
    var obj2 = new OtherObject();
    obj2.UpdateWith(obj);
    await _localDatabaseService.AddAsync(obj2);
}

将代码更改为如下所示并不能解决问题。

public Task Add(SomeModel obj)
{
    if (obj == null)
    {
        throw new ArgumentNullException(nameof(obj));
    }
    return AddInternal(obj);
}
private async Task AddInternal(SomeModel obj)
{
    var obj2 = new OtherObject();
    obj2.UpdateWith(obj);
    await _localDatabaseService.AddAsync(i);
}

【问题讨论】：

Validate parameters in async method的可能重复
请注意，您可以在 Add 中将 AddInternal 设为 local function（使用 C# 7+） - 效果相同，但您不能在不通过 Add 的情况下调用 AddInternal

标签： c# sonarqube

【解决方案1】：

我刚刚尝试了您的示例，但您的第二个代码没有出现问题（将 AddAsync(i) 替换为 AddAsync(obj2) 以匹配第一个代码逻辑。

关于规则的解释，我认为网站很清楚，但让我提供一个代码示例来尝试说明错误的行为。

static async void Main(string[] args)
{
    var x = new Program().Add(null); // Exception is not raised here...

    // do some other things

    await x; // ... but here when awaited
}

正如您所见，问题并没有在您预期的时候出现。

显然，如果您确定自己永远不会陷入这种情况并且没有人会以这种方式使用您的方法，您可以关闭该规则。

【讨论】：