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

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

Can User Technical Profile Influence AI Architecture Decisions?

In the last few days, I ran a small experiment on Devin/Windsurf/Cascade, BMAD, and LLM-based architecture decisions. The initial concern was simple: if an AI coding assistant knows something about the user, for example, that the user is a Java developer or a .NET developer, can this information influence the architecture and technology stack that the AI will propose? This question is important because many companies are starting to use AI tools not only for coding but also for product discovery, architecture, documentation, and technical decision-making. If the AI is influenced by the developer's personal profile, the result may not be fully neutral. It may look like a business or architecture decision, but in reality, it may be partially shaped by the context of the person using the tool. The test was done using BMAD with Devin/Windsurf/Cascade. The scenario was a unified field service operations platform. The task was to let BMAD refine the product, define the architecture and s...

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