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

How to check in AngularJS if a service was register or not

There are cases when you need to check in a service or a controller was register in AngularJS.
For example a valid use case is when you have the same implementation running on multiple application. In this case, you may want to intercept the HTTP provider and add a custom step there. This step don’t needs to run on all the application, only in the one where the service exist and register.
A solution for this case would be to have a flag in the configuration that specify this. In the core you would have an IF that would check the value of this flag.
Another solution is to check if a specific service was register in AngularJS or not. If the service was register that you would execute your own logic.
To check if a service was register or not in AngularJS container you need to call the ‘has’ method of ‘inhector’. It will return TRUE if the service was register.
if ($injector.has('httpInterceptorService')) { $httpProvider.interceptors.push('httpInterceptorService&#…

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.51EF 6.0.2VS2013
It seems that there …

Entity Framework (EF) TransactionScope vs Database.BeginTransaction

In today blog post we will talk a little about a new feature that is available on EF6+ related to Transactions.
Until now, when we had to use transaction we used ‘TransactionScope’. It works great and I would say that is something that is now in our blood.
using (var scope = new TransactionScope(TransactionScopeOption.Required)) { using (SqlConnection conn = new SqlConnection("...")) { conn.Open(); SqlCommand sqlCommand = new SqlCommand(); sqlCommand.Connection = conn; sqlCommand.CommandText = ... sqlCommand.ExecuteNonQuery(); ... } scope.Complete(); } Starting with EF6.0 we have a new way to work with transactions. The new approach is based on Database.BeginTransaction(), Database.Rollback(), Database.Commit(). Yes, no more TransactionScope.
In the followi…