扩展空检查的最佳方法是什么？

Question

你们都这样做：

public void Proc(object parameter)
{
    if (parameter == null)
        throw new ArgumentNullException("parameter");

    // Main code.
}

Jon Skeet 曾经提到他有时会使用扩展程序来执行此检查，因此您可以这样做：

parameter.ThrowIfNull("parameter");

所以我提出了这个扩展的两个实现，但我不知道哪个是最好的。

第一：

internal static void ThrowIfNull<T>(this T o, string paramName) where T : class
{
    if (o == null)
        throw new ArgumentNullException(paramName);
}

第二：

internal static void ThrowIfNull(this object o, string paramName)
{
    if (o == null)
        throw new ArgumentNullException(paramName);
}

你怎么看？

Answer 1

为此，我倾向于坚持使用无处不在的 Guard 类：

static class Guard
{
    public static void AgainstNulls(object parameter, string name = null)
    {
        if (parameter == null) 
            throw new ArgumentNullException(name ?? "guarded argument was null");

        Contract.EndContractBlock(); // If you use Code Contracts.
    }
}

Guard.AgainstNulls(parameter, "parameter");

并且避免扩展 object，加上肉眼看来，对 null 对象的方法调用似乎是荒谬的（尽管我知道对扩展方法调用 null 方法是完全有效的）。

至于哪个最好，我都不会使用。 它们都有无限递归。我也不会费心保护 message 参数，将其设为 null 即可。您的第一个解决方案也不支持 Nullable<T> 类型，因为 class 约束会阻止它。

当我们决定启用代码协定时，我们的 Guard 类后面还有 Contract.EndContractBlock() 调用，因为它符合所需的“if-then-throw”结构。

这也是PostSharp aspect 的完美候选人。

Answer 2

我会使用internal static void ThrowIfNull<T>(this T o, string paramName) where T : class。我不会使用internal static void ThrowIfNull(this object o, string paramName)，因为它可能会进行拳击。

Answer 3

我会这样做以避免硬编码参数名称。明天它可能会改变，然后你有更多的工作：

public static void ThrowIfNull<T>(this T item) where T : class
{
    var param = typeof(T).GetProperties()[0];
    if (param.GetValue(item, null) == null)
        throw new ArgumentNullException(param.Name);
}

并称它为：

public void Proc(object parameter)
{
    new { parameter }.ThrowIfNull(); //you have to call it this way.

    // Main code.
}

性能损失微不足道（在我的普通计算机上运行 100000 次不到 25 毫秒），比通常看到的基于表达式的方法快得多

ThrowIfNull(() => resource);

一个这样的here。但是如果你负担不起那么大的打击，肯定不要使用这个..

您还可以将其扩展为对象的属性。

new { myClass.MyProperty1 }.ThrowIfNull();

您可以缓存属性值以进一步提高性能，因为属性名称在运行时不会更改。

另见此问题：Resolving a parameter name at runtime

Answer 4

从 .NET 6 开始，现在我们在 System.ArgumentNullException 类中拥有静态方法 ThrowIfNull，其签名如下：

ThrowIfNull(object? argument, string? paramName = null);

因此，不要写：

if (value == null)
{
    throw new System.ArgumentNullException(nameof(value));
}

现在我们可以简单地写：

System.ArgumentNullException.ThrowIfNull(value);

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

---

implementation of this new method 利用System.Runtime.CompilerServices.CallerArgumentExpressionAttribute 属性进一步简化了这一点，不需要开发人员明确提供要保护的参数的名称。

可以在此处找到最终引入此新 API 的讨论： https://github.com/dotnet/runtime/issues/48573

在 .NET 6 代码库中引入它的 PR 可以在这里找到： https://github.com/dotnet/runtime/pull/55594

Answer 5

如何使用表达式树（来自Visual Studio Magazine）：

using System;
using System.Linq.Expressions;
namespace Validation
{
   public static class Validator
   {
     public static void ThrowIfNull(Expression<Func<object>> expression)
     {
       var body = expression.Body as MemberExpression;
       if( body == null)
       {
         throw new ArgumentException(
           "expected property or field expression.");
       }
       var compiled = expression.Compile();
       var value = compiled();
       if( value == null)
       {
         throw new ArgumentNullException(body.Member.Name);
       }
     }
     public static void ThrowIfNullOrEmpty(Expression<Func<String>> expression)  
     {
        var body = expression.Body as MemberExpression;
        if (body == null)
        {
          throw new ArgumentException(
            "expected property or field expression.");
        }
        var compiled = expression.Compile();
        var value = compiled();
        if (String.IsNullOrEmpty(value))
        {
          throw new ArgumentException(
            "String is null or empty", body.Member.Name);
        }
      }
   }

}

这样使用：

public void Proc(object parameter1, object parameter2, string string1)
{
    Validator.ThrowIfNull(() => parameter1);
    Validator.ThrowIfNull(() => parameter2);
    Validator.ThrowIfNullOrEmpty(() => string1);
    // Main code.
}

Answer 6

基于 C# 10，我使用 ThrowIfNull 扩展方法：

public static class CheckNullArgument
{
    public static T ThrowIfNull<T>(this T argument)
    {
        ArgumentNullException.ThrowIfNull(argument);

        return argument;
    }
}

用法：

public class UsersController
{
    private readonly IUserService _userService;

    public UsersController(IUserService userService)
    {
        _userService = userService.ThrowIfNull();
    }
}

Answer 7

第二种处理方式似乎更优雅。在这种情况下，您可以对每个托管对象进行限制。

internal static void ThrowIfNull(this object o, string paramName)
{
       if (o == null)
        throw new ArgumentNullException(paramName);
}