Skip to main content

Don't name your class "XXXManager"

How to you name your classes? How many classes you have in your current project named "Manager" and "Repository"? In the last period of time I saw a lot of classes named "Manager", so may that I begin to think that this is a suffix for any class that do some actions.
In this blog post I will talk about some suffixed that can be used when we need to name a class. First of all let why I don't like the "Manager" suffix? Because you cannot understand what the class do. Basically, "Manager" is so general that you can put almost anything there. When I read the name of the class I expect to understand what it does. For example a class with "Writer" suffix will tell me that this class is used to write data.
In the next part of the post I will enumerate some common suffix and when we can use them:
  • XXXFactory - Create objects
  • XXXWritter - Write data to a specific location
  • XXXReader - Read data from a specific location
  • XXXProtocol - Define a specific protocal
  • XXXConverter - A coverter that is used to convert from one type to another
  • XXXShepherd - Manage the lifetime of objects from creation to unload (delete)
  • XXXCoordinator - Coordinates a specific action or object
  • XXXBuilder - Is able to create new instances of objects
  • XXXContainer - A container of elements
  • XXXHandler - An handler for some a functionality
  • XXXController - Define a controller for an object
  • XXXEntity - Define an entity
  • XXXView - Define a view for a specific class.
  • XXXTarget
  • XXXSynchronizer
  • XXXBucket
  • XXXAttribute
  • XXXType
  • XXXEditor
  • XXXBase
  • XXXNode
  • XXXItem
  • XXXInfo
  • XXXHelper
  • XXXProvider
  • XXXException
  • XXXService (you can have the same problem as with Manager)
And so on...
There are so many ways how we suffix a class that we don't need to stuck only on one or two names. For example if you see "FooManager" will you be able to know that this class synchronize content with a remote server? If you name your class "FooSynchronizer" any programmer that will read the name of the class will know what it does.
In conclusion try don't stuck only one XXXManager and XXService. The "Clean Code" book is a good starting point.

Comments

  1. indeed: http://c2.com/cgi/wiki?DontNameClassesObjectManagerHandlerOrData :)

    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(

Azure AD and AWS Cognito side-by-side

In the last few weeks, I was involved in multiple opportunities on Microsoft Azure and Amazon, where we had to analyse AWS Cognito, Azure AD and other solutions that are available on the market. I decided to consolidate in one post all features and differences that I identified for both of them that we should need to take into account. Take into account that Azure AD is an identity and access management services well integrated with Microsoft stack. In comparison, AWS Cognito is just a user sign-up, sign-in and access control and nothing more. The focus is not on the main features, is more on small things that can make a difference when you want to decide where we want to store and manage our users.  This information might be useful in the future when we need to decide where we want to keep and manage our users.  Feature Azure AD (B2C, B2C) AWS Cognito Access token lifetime Default 1h – the value is configurable 1h – cannot be modified

What to do when you hit the throughput limits of Azure Storage (Blobs)

In this post we will talk about how we can detect when we hit a throughput limit of Azure Storage and what we can do in that moment. Context If we take a look on Scalability Targets of Azure Storage ( https://azure.microsoft.com/en-us/documentation/articles/storage-scalability-targets/ ) we will observe that the limits are prety high. But, based on our business logic we can end up at this limits. If you create a system that is hitted by a high number of device, you can hit easily the total number of requests rate that can be done on a Storage Account. This limits on Azure is 20.000 IOPS (entities or messages per second) where (and this is very important) the size of the request is 1KB. Normally, if you make a load tests where 20.000 clients will hit different blobs storages from the same Azure Storage Account, this limits can be reached. How we can detect this problem? From client, we can detect that this limits was reached based on the HTTP error code that is returned by HTTP