Skip to main content

Code refactoring - NULL check

Part 1
Part 2
Part 3

Let’s look over the following code:
public class Foo
{
  SomeFoo _some;
  
  ...

  public int GetA()
  {
    if(_some == null)
    {
      return 0;
    }

    return _some.A;
  }

  public string GetB()
  {
    if(_some == null)
    {
      return null;
    }

    return _some.B;
  }

  public int GetTotalX()
  {
    if(_some == null)
    {
      return -1;
    }

    return _some.A + _some.C;
  }

}
We can see that the IF checks appears in more than one place. Even if is only a simple check, there can be a lot of places where it appears.
If we manage to extract this check in a generic method, than the code would be more legible. Because we don’t return each time the default value of an object we need to be able to return custom “default” value for the case when or object is null.
We can image a method that accept as parameter the object that we check if is null or not and another two parameters that represent the default value that need to be return and a generic function that return the expected value.
private TReturn ExecuteFuncOverObj<TReturn>(object obj, TReturn defaultValue, Func<TReturn> func)
{
  if( obj == null)
  {
    return defaultValue;
  }

  return func.Invoke();
}
In this way our code would look like this:

public class Foo
{
  SomeFoo _some;
  
  ...

  public int GetA()
  {
    return ExecuteFuncOverObj(_some, () => _some.A, 0);
  }

  public string GetB()
  {
    return ExecuteFuncOverObj(_some, () => _some.B, null);
  }

  public int GetTotalX()
  {

    return ExecuteFuncOverObj(_some, () => _some.A + _some.C, -1);
  }

}
If we need this behavior in other methods we could define a helper function or an extension method of Object.
Enjoy!
Part 1
Part 2
Part 3

Comments

  1. In Java it is recommended (and I would imagine C# is quite similar) that you don't use null, rather a "neutral" object. For example empty maps / lists / sets, 0, empty string etc. (depending on the context in which the object will be used).

    ReplyDelete
    Replies
    1. Indeed, another name for this would be the "null object pattern" or "special case pattern" (http://martinfowler.com/eaaCatalog/specialCase.html).
      Anyway, this would require to wrap all external classes if they are subject to null checks.

      Delete
  2. So you suggest that in order to avoid having an if, we create a new function call and we pass it a lambda function? I fail to see the benefit here. It's 1) counterintuitive 2) requires that a new developer using that code understand a new layer of indirection and 3) it's wasted resources. Of course, the approach can be optimized by the compiler, but the strategy explains why typical and advanced high-level languages users produce bloated solutions.

    ReplyDelete

Post a Comment

Popular posts from this blog

Windows Docker Containers can make WIN32 API calls, use COM and ASP.NET WebForms

After the last post , I received two interesting questions related to Docker and Windows. People were interested if we do Win32 API calls from a Docker container and if there is support for COM. WIN32 Support To test calls to WIN32 API, let’s try to populate SYSTEM_INFO class. [StructLayout(LayoutKind.Sequential)] public struct SYSTEM_INFO { public uint dwOemId; public uint dwPageSize; public uint lpMinimumApplicationAddress; public uint lpMaximumApplicationAddress; public uint dwActiveProcessorMask; public uint dwNumberOfProcessors; public uint dwProcessorType; public uint dwAllocationGranularity; public uint dwProcessorLevel; public uint dwProcessorRevision; } ... [DllImport("kernel32")] static extern void GetSystemInfo(ref SYSTEM_INFO pSI); ... SYSTEM_INFO pSI = new SYSTEM_INFO(...

ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded

Today blog post will be started with the following error when running DB tests on the CI machine: threw exception: System.InvalidOperationException: The Entity Framework provider type 'System.Data.Entity.SqlServer.SqlProviderServices, EntityFramework.SqlServer' registered in the application config file for the ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded. Make sure that the assembly-qualified name is used and that the assembly is available to the running application. See http://go.microsoft.com/fwlink/?LinkId=260882 for more information. at System.Data.Entity.Infrastructure.DependencyResolution.ProviderServicesFactory.GetInstance(String providerTypeName, String providerInvariantName) This error happened only on the Continuous Integration machine. On the devs machines, everything has fine. The classic problem – on my machine it’s working. The CI has the following configuration: TeamCity .NET 4.51 EF 6.0.2 VS2013 It see...

Navigating Cloud Strategy after Azure Central US Region Outage

 Looking back, July 19, 2024, was challenging for customers using Microsoft Azure or Windows machines. Two major outages affected customers using CrowdStrike Falcon or Microsoft Azure computation resources in the Central US. These two outages affected many people and put many businesses on pause for a few hours or even days. The overlap of these two issues was a nightmare for travellers. In addition to blue screens in the airport terminals, they could not get additional information from the airport website, airline personnel, or the support line because they were affected by the outage in the Central US region or the CrowdStrike outage.   But what happened in reality? A faulty CrowdStrike update affected Windows computers globally, from airports and healthcare to small businesses, affecting over 8.5m computers. Even if the Falson Sensor software defect was identified and a fix deployed shortly after, the recovery took longer. In parallel with CrowdStrike, Microsoft provi...