Skip to main content

Code refactoring - Create base class/interface when is needed

When I made the last code review on a project I found the following lines of code:
Original version
public abstract class FooBase
{
Person _person;
public void string PersonId()
{
if(_person is Student)
{
return ((Student)_person).Id;
}
if(_person is Worker)
{
return ((Worker)_person).Id;
}

return _someDefaultValue;
}
public void string ScreenName()
{
if(_screen is MainScreen)
{
return ((MainScreen)_screen).Name;
}
if(_screen is SettingsScreen)
{
return ((SettingsScreen)_screen).Name;
}

((DefaultScreen)_screen).Name ;
}
}

After some new functionality was added:
public abstract class FooBase
{
Person _person;
public void string PersonId()
{
if(_person is Student)
{
return ((Student)_person).Id;
}
if(_person is Worker)
{
return ((Worker)_person).Id;
}
if(_person is Vampire)
{
return ((Vampire)_person).Id;
}

return _someDefaultValue;
}
public void string ScreenName()
{
if(_screen is MainScreen)
{
return ((MainScreen)_screen).Name;
}
if(_screen is SettingsScreen)
{
return ((SettingsScreen)_screen).Name;
}
if(_screen is TimeScreen)
{
return ((TimeScreen)_screen).Name;
}

((DefaultScreen)_screen).Name;
}
}
If you ask you’re self if the Person class contains the Id property, the response is not. The original team didn’t look over the code and add common items to the base class.
What we can observe in the above code?
First of all, the screens and persons could have a base class or at least a base interface.
The changes are made without trying to improve the code and design. Extracting a base class (interface) is a mandatory think to do before marking a task as done.
There are times when the developer don’t want to make changes to the code because is afraid that he can brake something. Maybe, if the code is covered with strong unit tests than the developer would feel more comfortable to make changes. If you are a developer and see that the code is not covered with test and because of this you cannot improve the design that you should begin to write some test first. After that you should refac. this methods.
After we make the refac our FooBase class should look something similar to this:
public abstract class FooBase
{
// Add the Id property to the base class (Person)
Person _person;
public void string PersonId()
{
if(_person == null)
{
return _someDefaultValue;
}
return _person.Id
}
public void string ScreenName()
{
// Define a base Screen class that contains the Name property
return _screen.Name;
}
}
As a developer, don’t be afraid to improve the code. If the first team that implemented this class would made the refac. we would never had this problem. But in the same time, the second developer that made the changes should look over the code and try to improve it.

Comments

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