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(...

How to audit an Azure Cosmos DB

In this post, we will talk about how we can audit an Azure Cosmos DB database. Before jumping into the problem let us define the business requirement: As an Administrator I want to be able to audit all changes that were done to specific collection inside my Azure Cosmos DB. The requirement is simple, but can be a little tricky to implement fully. First of all when you are using Azure Cosmos DB or any other storage solution there are 99% odds that you’ll have more than one system that writes data to it. This means that you have or not have control on the systems that are doing any create/update/delete operations. Solution 1: Diagnostic Logs Cosmos DB allows us activate diagnostics logs and stream the output a storage account for achieving to other systems like Event Hub or Log Analytics. This would allow us to have information related to who, when, what, response code and how the access operation to our Cosmos DB was done. Beside this there is a field that specifies what was th...

Cloud Myths: Cloud is Cheaper (Pill 1 of 5 / Cloud Pills)

Cloud Myths: Cloud is Cheaper (Pill 1 of 5 / Cloud Pills) The idea that moving to the cloud reduces the costs is a common misconception. The cloud infrastructure provides flexibility, scalability, and better CAPEX, but it does not guarantee lower costs without proper optimisation and management of the cloud services and infrastructure. Idle and unused resources, overprovisioning, oversize databases, and unnecessary data transfer can increase running costs. The regional pricing mode, multi-cloud complexity, and cost variety add extra complexity to the cost function. Cloud adoption without a cost governance strategy can result in unexpected expenses. Improper usage, combined with a pay-as-you-go model, can result in a nightmare for business stakeholders who cannot track and manage the monthly costs. Cloud-native services such as AI services, managed databases, and analytics platforms are powerful, provide out-of-the-shelve capabilities, and increase business agility and innovation. H...