C#优雅的方法来检查属性的属性是否为null

时间:2010-08-12 13:40:40

标签: c# nullreferenceexception nullable null-conditional-operator

在C#中,假设您想在此示例中从PropertyC中提取值,而ObjectA,PropertyA和PropertyB都可以为null。

ObjectA.PropertyA.PropertyB.PropertyC

如何使用最少量的代码安全地获取PropertyC?

现在我会检查:

if(ObjectA != null && ObjectA.PropertyA !=null && ObjectA.PropertyA.PropertyB != null)
{
    // safely pull off the value
    int value = objectA.PropertyA.PropertyB.PropertyC;
}

做更像这样的事情会很好(伪代码)。

int value = ObjectA.PropertyA.PropertyB ? ObjectA.PropertyA.PropertyB : defaultVal;

使用无效合并运算符可能会进一步崩溃。

编辑最初我说我的第二个例子就像js,但是我把它改成伪代码,因为它被正确地指出它在js中不起作用。

21 个答案:

答案 0 :(得分:79)

在C#6中,您可以使用Null条件运算符。所以最初的测试将是:

 int? value = objectA?.PropertyA?.PropertyB?.PropertyC;

答案 1 :(得分:26)

短扩展方法:

public static TResult IfNotNull<TInput, TResult>(this TInput o, Func<TInput, TResult> evaluator)
  where TResult : class where TInput : class
{
  if (o == null) return null;
  return evaluator(o);
}

使用

PropertyC value = ObjectA.IfNotNull(x => x.PropertyA).IfNotNull(x => x.PropertyB).IfNotNull(x => x.PropertyC);

这种简单的扩展方法,您可以在http://devtalk.net/csharp/chained-null-checks-and-the-maybe-monad/

找到更多内容

编辑:

在使用它之后我认为这个方法的正确名称应该是 IfNotNull()而不是原始With()。

答案 2 :(得分:16)

你可以为你的班级添加一个方法吗?如果没有,您是否考虑过使用扩展方法?您可以为名为GetPropC()的对象类型创建扩展方法。

示例:

public static class MyExtensions
{
    public static int GetPropC(this MyObjectType obj, int defaltValue)
    {
        if (obj != null && obj.PropertyA != null & obj.PropertyA.PropertyB != null)
            return obj.PropertyA.PropertyB.PropertyC;
        return defaltValue;
    }
}

用法:

int val = ObjectA.GetPropC(0); // will return PropC value, or 0 (defaltValue)

顺便说一下,假设您使用的是.NET 3或更高版本。

答案 3 :(得分:12)

你这样做的方式是正确的。

可以使用Linq表达式使用类似here描述的技巧:

int value = ObjectA.NullSafeEval(x => x.PropertyA.PropertyB.PropertyC, 0);

但手动检查每个属性要慢得多......

答案 4 :(得分:11)

重构以观察Law of Demeter

答案 5 :(得分:9)

2014年更新:C#6有一个新的运营商?.各种所谓的“安全导航”#39;或者&#39; null传播&#39;

parent?.child

阅读http://blogs.msdn.com/b/jerrynixon/archive/2014/02/26/at-last-c-is-getting-sometimes-called-the-safe-navigation-operator.aspx了解详情

这一直是一个非常受欢迎的要求 https://visualstudio.uservoice.com/forums/121579-visual-studio/suggestions/3990187-add-operator-to-c-?tracking_code=594c10a522f8e9bc987ee4a5e2c0b38d

答案 6 :(得分:9)

你显然正在寻找 Nullable Monad

string result = new A().PropertyB.PropertyC.Value;

变为

string result = from a in new A()
                from b in a.PropertyB
                from c in b.PropertyC
                select c.Value;

如果任何可空属性为null,则返回null;否则,Value

的值
class A { public B PropertyB { get; set; } }
class B { public C PropertyC { get; set; } }
class C { public string Value { get; set; } }

LINQ扩展方法:

public static class NullableExtensions
{
    public static TResult SelectMany<TOuter, TInner, TResult>(
        this TOuter source,
        Func<TOuter, TInner> innerSelector,
        Func<TOuter, TInner, TResult> resultSelector)
        where TOuter : class
        where TInner : class
        where TResult : class
    {
        if (source == null) return null;
        TInner inner = innerSelector(source);
        if (inner == null) return null;
        return resultSelector(source, inner);
    }
}

答案 7 :(得分:5)

此代码是“代码量最少”,但不是最佳实践:

try
{
    return ObjectA.PropertyA.PropertyB.PropertyC;
}
catch(NullReferenceException)
{
     return null;
}

答案 8 :(得分:5)

假设您有类型的空值,则可以采用以下方法:

var x = (((objectA ?? A.Empty).PropertyOfB ?? B.Empty).PropertyOfC ?? C.Empty).PropertyOfString;

我是C#的忠实粉丝,但新Java(1.7?)中的一个非常好的东西是。?操作者:

 var x = objectA.?PropertyOfB.?PropertyOfC.?PropertyOfString;

答案 9 :(得分:4)

我在新的C#6.0中看到了一些东西, 这是通过使用&#39;?&#39;而不是检查

例如,

而不是使用

if (Person != null && Person.Contact!=null && Person.Contact.Address!= null && Person.Contact.Address.City != null)
{ 
  var city = person.contact.address.city;
}

你只需使用

var city = person?.contact?.address?.city;

我希望它有所帮助。

更新:

你现在可以这样做

 var city = (Person != null)? 
           ((Person.Contact!=null)? 
              ((Person.Contact.Address!= null)?
                      ((Person.Contact.Address.City!=null)? 
                                 Person.Contact.Address.City : null )
                       :null)
               :null)
            : null;

答案 10 :(得分:4)

当我需要链接这样的调用时,我依赖于我创建的辅助方法TryGet():

    public static U TryGet<T, U>(this T obj, Func<T, U> func)
    {
        return obj.TryGet(func, default(U));
    }

    public static U TryGet<T, U>(this T obj, Func<T, U> func, U whenNull)
    {
        return obj == null ? whenNull : func(obj);
    }

在你的情况下,你会像这样使用它:

    int value = ObjectA
        .TryGet(p => p.PropertyA)
        .TryGet(p => p.PropertyB)
        .TryGet(p => p.PropertyC, defaultVal);

答案 11 :(得分:4)

检查this blog post。我认为这是一种非常优雅的链式空检查方法。有许多类似的实现,但我喜欢这个,因为它会在链中找到null后立即停止评估。

所有源代码都在github

答案 12 :(得分:2)

你可以这样做:

class ObjectAType
{
    public int PropertyC
    {
        get
        {
            if (PropertyA == null)
                return 0;
            if (PropertyA.PropertyB == null)
                return 0;
            return PropertyA.PropertyB.PropertyC;
        }
    }
}



if (ObjectA != null)
{
    int value = ObjectA.PropertyC;
    ...
}

或者更好的可能是这个:

private static int GetPropertyC(ObjectAType objectA)
{
    if (objectA == null)
        return 0;
    if (objectA.PropertyA == null)
        return 0;
    if (objectA.PropertyA.PropertyB == null)
        return 0;
    return objectA.PropertyA.PropertyB.PropertyC;
}


int value = GetPropertyC(ObjectA);

答案 13 :(得分:1)

在这篇文章中偶然发现了。

前段时间我在Visual Studio Connect上提出了关于添加新???运算符的建议。

http://visualstudio.uservoice.com/forums/121579-visual-studio/suggestions/4104392-add-as-an-recursive-null-reference-check-opera

这需要框架团队的一些工作,但不需要改变语言,只需要做一些编译魔术。想法是编译器应该更改此代码(语法不允许atm)

string product_name = Order.OrderDetails[0].Product.Name ??? "no product defined";

进入此代码

Func<string> _get_default = () => "no product defined"; 
string product_name = Order == null 
    ? _get_default.Invoke() 
    : Order.OrderDetails[0] == null 
        ? _get_default.Invoke() 
        : Order.OrderDetails[0].Product == null 
            ? _get_default.Invoke() 
            : Order.OrderDetails[0].Product.Name ?? _get_default.Invoke()

对于null检查,这可能看起来像

bool isNull = (Order.OrderDetails[0].Product ??? null) == null;

答案 14 :(得分:1)

你可以使用以下扩展名,我认为这非常好:

/// <summary>
/// Simplifies null checking
/// </summary>
public static TR Get<TF, TR>(TF t, Func<TF, TR> f)
    where TF : class
{
    return t != null ? f(t) : default(TR);
}

/// <summary>
/// Simplifies null checking
/// </summary>
public static TR Get<T1, T2, TR>(T1 p1, Func<T1, T2> p2, Func<T2, TR> p3)
    where T1 : class
    where T2 : class
{
    return Get(Get(p1, p2), p3);
}

/// <summary>
/// Simplifies null checking
/// </summary>
public static TR Get<T1, T2, T3, TR>(T1 p1, Func<T1, T2> p2, Func<T2, T3> p3, Func<T3, TR> p4)
    where T1 : class
    where T2 : class
    where T3 : class
{
    return Get(Get(Get(p1, p2), p3), p4);
}

它的用法如下:

int value = Nulify.Get(objectA, x=>x.PropertyA, x=>x.PropertyB, x=>x.PropertyC);

答案 15 :(得分:1)

在C#vNext中计划的空传播,由Roslyn提供支持

<小时/> 不是答案,而是更多的更新。似乎UserVoice已经驱动了这个,以及一系列其他新事物,因为Roslyn并且显然是一个计划的补充:

https://roslyn.codeplex.com/discussions/540883

答案 16 :(得分:1)

这是不可能的。如果ObjectA由于空解除引用而为null,则ObjectA.PropertyA.PropertyB将失败,这是一个错误。

if(ObjectA!= null&amp;&amp; ObjectA.PropertyA ...由于短路而起作用,即如果ObjectA为空则永远不会检查ObjectA.PropertyA。

您提出的第一种方式是最好的,最明确的意图。如果有什么可以尝试重新设计而不必依赖这么多的空值。

答案 17 :(得分:0)

一旦你克服了lambda gobbly-gook,这种方法就相当简单了:

public static TProperty GetPropertyOrDefault<TObject, TProperty>(this TObject model, Func<TObject, TProperty> valueFunc)  
                                                        where TObject : class
    {
        try
        {
            return valueFunc.Invoke(model);
        }
        catch (NullReferenceException nex)
        {
            return default(TProperty);
        }
    }

使用情况可能如下:

ObjectA objectA = null;

Assert.AreEqual(0,objectA.GetPropertyOrDefault(prop=>prop.ObjectB.ObjectB.ObjectC.ID));

Assert.IsNull(objectA.GetPropertyOrDefault(prop => prop.ObjectB));

答案 18 :(得分:0)

我写了一个接受默认值的方法,下面是如何使用它:

var teacher = new Teacher();
return teacher.GetProperty(t => t.Name);
return teacher.GetProperty(t => t.Name, "Default name");

以下是代码:

public static class Helper
{
    /// <summary>
    /// Gets a property if the object is not null.
    /// var teacher = new Teacher();
    /// return teacher.GetProperty(t => t.Name);
    /// return teacher.GetProperty(t => t.Name, "Default name");
    /// </summary>
    public static TSecond GetProperty<TFirst, TSecond>(this TFirst item1,
        Func<TFirst, TSecond> getItem2, TSecond defaultValue = default(TSecond))
    {
        if (item1 == null)
        {
            return defaultValue;
        }

        return getItem2(item1);
    }
}

答案 19 :(得分:0)

我会使用类似于Nullable类型的模式在PropertyA类型(或扩展方法,如果它不是你的类型)中编写自己的方法。

class PropertyAType
{
   public PropertyBType PropertyB {get; set; }

   public PropertyBType GetPropertyBOrDefault()
   {
       return PropertyB != null ? PropertyB : defaultValue;
   }
}

答案 20 :(得分:-2)

var result = nullableproperty ?? defaultvalue;

?? operator表示如果第一个参数为null,则返回第二个参数。