检查空参数的最佳方法（保护子句）

Question

例如，你通常不希望构造函数中的参数为空，所以看到类似的东西是很正常的

if (someArg == null)
{
    throw new ArgumentNullException(nameof(someArg));
}

if (otherArg == null)
{
    throw new ArgumentNullException(nameof(otherArg));
}

代码确实有点混乱。

有没有比这更好的方法来检查参数列表中的参数？

类似于“检查所有参数并在其中任何一个为空时抛出 ArgumentNullException 并为您提供为空的参数。

顺便说一句，关于重复的问题声明，这不是用属性或内置的东西标记参数，而是一些人称之为保护子句的东西，以保证对象接收初始化的依赖关系。

Answer 1

如果你的构造函数中的参数太多，你最好修改它们，但那是另一回事了。

为了减少样板验证代码，许多人编写了这样的 Guard 实用程序类：

public static class Guard
{
    public static void ThrowIfNull(object argumentValue, string argumentName)
    {
        if (argumentValue == null)
        {
            throw new ArgumentNullException(argumentName);
        }
    }

    // other validation methods
}

（您可以添加该 Guard 类可能需要的其他验证方法）。

因此只需要一行代码来验证一个参数：

    private static void Foo(object obj)
    {
        Guard.ThrowIfNull(obj, "obj");
    }

Answer 2

空引用是您必须防范的一种麻烦。但是，他们并不是唯一的。问题比这更广泛，归结为：方法接受某种类型的实例，但它不能处理所有实例。

换句话说，方法的域大于它处理的值集。然后使用保护子句断言实际参数不属于方法域的无法处理的“灰色区域”。

现在，我们有空引用，作为一个通常超出可接受值集的值。另一方面，经常发生集合中的一些非空元素也是不可接受的（例如空字符串）。

在这种情况下，可能会证明方法签名过于宽泛，这表明存在设计问题。这可能会导致重新设计，例如定义一个子类型，通常是一个派生接口，它限制方法的域并使一些保护子句消失。你可以在这篇文章中找到一个例子：Why do We Need Guard Clauses?

Answer 3

public static class Ensure
{
    /// <summary>
    /// Ensures that the specified argument is not null.
    /// </summary>
    /// <param name="argumentName">Name of the argument.</param>
    /// <param name="argument">The argument.</param>
    [DebuggerStepThrough]
    [ContractAnnotation("halt <= argument:null")]        
    public static void ArgumentNotNull(object argument, [InvokerParameterName] string argumentName)
    {
        if (argument == null)
        {
            throw new ArgumentNullException(argumentName);
        }
    }
}

用法：

// C# < 6
public Constructor([NotNull] object foo)
{
    Ensure.ArgumentNotNull(foo, "foo");
    ...
}

// C# >= 6
public Constructor([NotNull] object bar)
{
    Ensure.ArgumentNotNull(bar, nameof(bar));
    ...
}

DebuggerStepThroughAttribute 非常方便，因此在调试时出现异常（或者当我在异常发生后附加调试器时）我不会在 ArgumentNotNull 方法中结束，而是在调用方法中结束空引用 actually 发生了。

我正在使用ReSharper Contract Annotations。

• ContractAnnotationAttribute 确保我不会拼错 参数（"foo"），如果我重命名它也会自动重命名 foo 符号。
• NotNullAttribute 帮助 ReSharper 进行代码分析。因此，如果我执行new Constructor(null)，我会收到 ReSharper 的警告，指出这将导致异常。
• 如果您不喜欢直接注释代码， 您也可以使用 external XML-files 执行相同的操作，您可以将其部署到您的库中，并且用户可以选择在他们的 ReSharper 中引用。

Answer 4

有一个名为 SwissKnife 的 nuget 包。从nuget gallery 安装SwissKnife。它为您提供了许多选项，从检查参数的空值开始 Argument.IsNotNullOrEmpty(args,"args") 在 SwissKnife.Diagnostics.Contracts 命名空间下以及选项 idoim 等等。您可以设置Option<Class_Name> _someVar，然后检查是_someVar.IsSome 还是_someVar.IsNone。这也有助于对抗可为空的类。希望这会有所帮助。

Answer 5

你可以试试我的 Heleonix.Guard 库，它提供了保护功能。

你可以像下面这样写保护子句：

// C# 7.2+: Non-Trailing named arguments
Throw.ArgumentNullException(when: param.IsNull(), nameof(param));

// OR

// Prior to C# 7.2: You can use a helper method 'When'
Throw.ArgumentNullException(When(param.IsNull()), nameof(param));

// OR
Throw.ArgumentNullException(param == null, nameof(param));

// OR
Throw.ArgumentNullException(When (param == null), nameof(param));

它提供了许多现有异常的抛出，您可以为自定义异常编写自定义扩展方法。此外，该库还引用了带有诸如IsNull、IsNullOrEmptyOrWhitespace、IsLessThan 等谓词扩展的“Heleonix.Extensions”库，以检查您的参数或变量是否与所需值相符。与其他一些具有流畅接口的保护库不同，这些扩展不会生成中间对象，而且由于实现非常简单，因此它们是高性能的。

Answer 6

使用较新版本的 C# 语言，您无需额外的库或额外的方法调用即可编写此代码：

_ = someArg ?? throw new ArgumentNullException(nameof(someArg));
_ = otherArg ?? throw new ArgumentNullException(nameof(otherArg));

从 .NET6 开始你也可以这样写：

ArgumentNullException.ThrowIfNull(someArg);

Answer 7

Ardalis 拥有出色的 GuardClauses 库。

很好用Guard.Against.Null(message, nameof(message));

Answer 8

在 C# 8.0 及更高版本中，提供了新的帮助。 C# 8.0 引入了不可为空的引用类型（文档中称为“可空引用类型”的功能有点令人困惑）。在 C# 8.0 之前，所有引用类型都可以设置为 null。但是现在有了 C# 8.0 和 'nullable' 项目设置，我们可以说引用类型默认是不可为空的，然后根据具体情况使我们的变量和参数可以为空。

因此，目前我们可以识别这样的代码：

public void MyFunction(int thisCannotBeNull, int? thisCouldBeNull)
{
    // no need for checking my thisCannotBeNull parameter for null here
}

如果你为你的 C# v8.0+ 项目设置了<Nullable>enable</Nullable>，你也可以这样做：

public void MyFunction(MyClass thisCannotBeNull, MyClass? thisCouldBeNull)
{
    // static code analysis at compile time checks to see if thisCannotBeNull could be null
}

空值检查是在编译时使用静态代码分析完成的。因此，如果您以一种意味着可能出现空值的方式对其进行编码，您将收到编译器警告（如果需要，您可以将其升级为错误）。因此，很多（但不是全部）需要对空参数进行运行时检查的情况可以根据您的代码作为编译时检查来处理。

Answer 9

我发现的最简单的方法是受到 Dapper 使用匿名类型的启发。 我编写了一个使用匿名类型来获取属性名称的 Guard 类。 守卫本身如下

    public class Guard
    {
        public static void ThrowIfNull(object param) 
        {
            var props = param.GetType().GetProperties();
            foreach (var prop in props) 
            {
                var name = prop.Name;
                var val = prop.GetValue(param, null);

                _ = val ?? throw new ArgumentNullException(name);
            }
        }
    }

然后你就这样使用它

...
        public void Method(string someValue, string otherValue)
        {
            Guard.ThrowIfNull(new { someValue, otherValue }); 
        }
...

当 ArgumentNullException 被抛出时，反射用于确定属性的名称，然后将显示在您的异常中

Answer 10

如果您想保存两次输入参数名称，例如 Guard.AgainstNull(arg, nameof(arg));

查看YAGuard，您可以在其中写信 Guard.AgainstNull(arg);

无需在guard子句中指定参数名称，但在抛出的参数中，名称被正确解析。

它还支持表单中的guard-and-set MyProperty = 赋值.IfNotNull(arg);

Nuget：YAGuard

免责声明：我是YAGuard的作者。

Answer 11

C# 10 介绍了执行此操作的最短方法（到目前为止）。您只需要在要检查 null 的参数后面加上 2 个感叹号 !!。

之前：

public void test(string someArg){
    if (someArg == null)
    {
        throw new ArgumentNullException(nameof(someArg));
    }
    // other code
}

使用 C# 10 或更高版本：

public void test(string someArg!!){
    // other code
}

如果您调用 test(null)，则会抛出 ArgumentNullException，告诉您 someArg 是 null。

来源：A video on the 'Microsoft Developer' YouTube channel explaining the new feature

---

请注意：这是 C# 10 的一项功能，C# 10 尚未正式发布。它将于 2021 年 11 月与 .Net6 一起发布 (according to Microsoft)。

Answer 12

使用更新版本的 C#（C# 10，.NET6 将在几天内发布）您甚至可以执行以下操作： ArgumentNullException.ThrowIfNull(someArg);

文档：https://docs.microsoft.com/en-us/dotnet/api/system.argumentnullexception.throwifnull?view=net-6.0