'Is if(items != null) superfluous before foreach(T item in items)?

I often come across code like the following:

if ( items != null)
{
   foreach(T item in items)
   {
        //...
   }
}

Basically, the if condition ensures that foreach block will execute only if items is not null. I'm wondering if the if condition is really needed, or foreach will handle the case if items == null.

I mean, can I simply write 

foreach(T item in items)
{
    //...
}

without worrying about whether items is null or not? Is the if condition superfluous? Or this depends on the type of items or maybe on T as well?

c++sharpiteratorforeachiteration


Solution 1:[1]

Using C# 6 you could use the new null conditional operator together with List<T>.ForEach(Action<T>) (or your own IEnumerable<T>.ForEach extension method).

List<string> items = null;
items?.ForEach(item =>
{
    // ...
});

Solution 2:[2]

The real takeaway here should be a sequence should almost never be null in the first place. Simply make it an invariant in all of your programs that if you have a sequence, it is never null. It is always initialized to be the empty sequence or some other genuine sequence.

If a sequence is never null then obviously you don't need to check it.

Solution 3:[3]

Actually there is a feature request on that here: https://github.com/dotnet/csharplang/discussions/1081#issuecomment-443209795 And the response is quite logical:

I think that most foreach loops are written with the intent of iterating a non-null collection. If you try iterating through null you should get your exception, so that you can fix your code.

Solution 4:[4]

You could always test it out with a null list... but this is what I found on the msdn website

foreach-statement:
    foreach   (   type   identifier   in   expression   )   embedded-statement

If expression has the value null, a System.NullReferenceException is thrown.

Solution 5:[5]

You can encapsulate the null check in an extension method and use a lambda:

public static class EnumerableExtensions {
  public static void ForEach<T>(this IEnumerable<T> self, Action<T> action) {
    if (self != null) {
      foreach (var element in self) {
        action(element);
      }
    }
  }
}

The code becomes:

items.ForEach(item => { 
  ...
});

If can be even more concise if you want to just call a method that takes an item and returns void:

items.ForEach(MethodThatTakesAnItem);

Solution 6:[6]

It is not superflous. At runtime items will be casted to an IEnumerable and its GetEnumerator method will be called. That will cause a dereferencing of items that will fail

Solution 7:[7]

You do need this. You'll get an exception when foreach accesses the container to set up the iteration otherwise.

Under the covers, foreach uses an interface implemented on the collection class to perform the iteration. The generic equivalent interface is here.

The foreach statement of the C# language (for each in Visual Basic) hides the complexity of the enumerators. Therefore, using foreach is recommended instead of directly manipulating the enumerator.

Solution 8:[8]

The test is necessary, because if the collection is null, foreach will throw a NullReferenceException. It's actually quite simple to try it out.

List<string> items = null;
foreach(var item in items)
{
   Console.WriteLine(item);
}

Solution 9:[9]

the second will throw a NullReferenceException with the message Object reference not set to an instance of an object.

Solution 10:[10]

As mentioned here you need to check is it not null.

Do not use an expression that evaluates to null.

Solution 11:[11]

In C# 6 you can write sth like this:

// some string from file or UI, i.e.:
// a) string s = "Hello, World!";
// b) string s = "";
// ...
var items = s?.Split(new char[] { ',', '!', ' ' }) ?? Enumerable.Empty<string>();  
foreach (var item in items)
{
    //..
}

It's basically Vlad Bezden's solution but using the ?? expression to always generate an array that is not null and therefore survives the foreach rather than having this check inside the foreach bracket.

Related Questions