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

Why Database Modernization Matters for AI

By
  When companies transition to the cloud, they typically begin with applications and virtual machines, which is often the easier part of the process. The actual complexity arises later when databases are moved. To save time and effort, cloud adoption is more of a cloud migration in an IaaS manner, fulfilling current, but not future needs. Even organisations that are already in the cloud find that their databases, although “migrated,” are not genuinely modernised. This disparity becomes particularly evident when they begin to explore AI technologies. Understanding Modernisation Beyond Migration Database modernisation is distinct from merely relocating an outdated database to Azure. It's about making your data layer ready for future needs, like automation, real-time analytics, and AI capabilities. AI needs high throughput, which can be achieved using native DB cloud capabilities. When your database runs in a traditional setup (even hosted in the cloud), in that case, you will enc...
Post a Comment
Read more

Cloud Myths: Migrating to the cloud is quick and easy (Pill 2 of 5 / Cloud Pills)

By
The idea that migration to the cloud is simple, straightforward and rapid is a wrong assumption. It’s a common misconception of business stakeholders that generates delays, budget overruns and technical dept. A migration requires laborious planning, technical expertise and a rigorous process.  Migrations, especially cloud migrations, are not one-size-fits-all journeys. One of the most critical steps is under evaluation, under budget and under consideration. The evaluation phase, where existing infrastructure, applications, database, network and the end-to-end estate are evaluated and mapped to a cloud strategy, is crucial to ensure the success of cloud migration. Additional factors such as security, compliance, and system dependencies increase the complexity of cloud migration.  A misconception regarding lift-and-shits is that they are fast and cheap. Moving applications to the cloud without changes does not provide the capability to optimise costs and performance, leading to ...
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