Skip to main content

Don't name your class "XXXManager"

By
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.
Labels:

Comments

  1. AnonymousAugust 21, 2012 at 6:45 PM

    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

By
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(...
Post a Comment
Read more

How to audit an Azure Cosmos DB

By
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...
Post a Comment
Read more

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

By
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...
Post a Comment
Read more