What naming convention do you use for the service layer in a Spring MVC application? [closed]

Question

I'm stuck with figuring out a good naming convention for the service layer in a spring application. For each class in the service layer I first write the interface it should implement and then the actual class. So for example I have the following interface:

public interface UserAccountManager{    public void registerUser(UserAccount newUserAccount);    public void resetPassword(UserAccount userAccount); ... } 

And then the implementation class...

What bugs me here is UserAccountManager is a good name for the implementation class so I'm forced into giving it a stupid name like SimpleUserAccountManager or UserAccountDbManager. What are some of the conventions you've used so far? Is it a good idea to put the implementation classes in a different package and give them the same names as the interfaces? Also what are your thoughts on using names ending with Manager over names ending with Service?

Answer 1

Here is what we use:

• XxxDAO (Data Access Object) - Responsible for interacting directly with the EntityManager , JDBC DataSource , file system, etc. Should contain only persistence logic, such as SQL or JPA-QL, but not (or as little as possible) business logic. Should be accessed only from Managers.
• XxxManager - Manages entites at the business level, usually performs CRUD operations, but adds the required business logic.
• XxxService - The layer where the business logic resides. Should "speak" in simple objects - Strings, ints, etc. - as much as possible.
• XxxController - The UI interaction layer. Should speak to Services only.
• XxxUtilities/XxxUtils - Helper stateless methods, should not depend on any service in the system. If you need such sependency, either convert the utility class to a service or add the service result as a parameter.

For the implementation we add the Impl Suffix (XxxServiceImpl), to distinct it from the interface, and if there are several implementations or we want to add additional information we add it as prefix (JdbcXxxDaoImpl, GoogleMapsGeocodingServiceImpl, etc.). The classes names become a bit long this way, but they are very descriptive and self documenting.