How to name tool classes in Java?
Let's take a few examples first
JDK comes with its own tool class
(); (); ();
Spring Framework Tool Class
(); () ();
Hutool Tools
(); (); ();
We found that the naming methods of each group of examples are different. Let’s summarize it into three types:
1. JDK is mainly named in the plural form of the operation object.
2. The tool classes of Spring framework are named as objects or uses + Util plural
3. The tool classes of Hutool framework are named as objects or uses + Util singular
OK, after reading the above, let’s take a look at the tool class naming method in our project
(); (); (); (); (); ();
You can see that a simple String tool class can have so many naming methods, which can be said to be a collection of the strengths of a hundred schools of thought and is quite rich.
Comparison of several naming methods
Plural form of object represented by JDK
advantage
It's simple and clear, it's actually quite good for familiar people to use it like this.
shortcoming
It is easy to misunderstand the role of the class with other words, such as putting together pojo classes such as News, Goods and Objects tool classes. Is it the first thing I feel is that they are the same purpose, but it is not.
The object Util plural form represented by Spring framework
advantage
It can divide the uses of classes from the class name, and users will not easily misunderstand it.
shortcoming
Class naming is generally singular, and plural naming forms will appear to be inconsistent in the overall naming method.
Util singular form of the object represented by Hutool framework
advantage
The purpose of the class can be divided from the class name, which is not easy for users to misunderstand, and the overall naming method is easily consistent with other classes of the project.
shortcoming
This is OK, and you can't play it if you are serious.
How to name a project
Here we will not discuss the naming of Kit, Tool, etc. in the project, but mainly analyze several mainstream naming methods.
How to name it?
For pure tool classes, most of the naming methods are still commonly found in the industry. Other naming methods can of course be used, including several naming methods in the projects listed above. It is just that when you mention Util or Utils, you know that the first reaction is tool classes, and other naming methods may take several seconds to react.
But here we need to talk about the difference between Util and Helper, which is only your own understanding.
There is a concept of software reuse in software architecture, which is divided into horizontal reuse and vertical reuse.
Horizontal reuse: refers to software elements that can be used in different application fields. It is simply understood that it is business-independent and can be used in any business scenario.
Vertical reuse: refers to the reuse of soft components between a category or application fields with more common characteristics. It is simply understood that it can be used in specific business fields or business scenarios.
Then the Util class belongs to what is mentioned aboveHorizontal reuseThe Util class is more about encapsulating the classes provided by JDK, or the use encapsulation of other classes within the framework provided by a certain technical framework itself, but this type is generally independent of business and field. Can be used in any business or field. Therefore, since it is a tool class, it must ensure that its horizontal reuse is necessary.
Helper translates it to helper/helper. From a literal sense, such a class is used as a helper class. So the question is, who is the auxiliary object? Then of course it is an auxiliary to other classes. Here is a scope, which classes can be assisted, and theoretically, all classes or objects can be assisted if needed.But in reality, it is more to simplify the complexity of the use of related classes in a certain scenario, and provides a convenient access interface to form a Helper class. This scenario generally has business or domain characteristics., so more useVertical reuse。
Summarize
Personally, I am currently accustomed to using the singular form of Util. Other classes in the project are named in the singular form, such as UserController, UserVo, etc. It feels a bit abrupt when suddenly appearing a plural form of class.
If there are no special requirements or personal habits, it is better to name it in the way that Util or Utils is the easiest way for the public to understand. Why do you say I have to use Tool to name it? It's okay to do this.The key is that the company or team has its own set of standards., I am a person with a code obsession with cleanliness, and I will strictly unify the standards of the team.It seems like a lot of time to take in the early stage, butWhen everyone can reach an agreement within the internal perception, the more you work in the team, the more tacit understanding you will have in the team will be.，This minimizes communication costs, reduce later maintenance costs.
If the above needs can be met, it is really OK to name it。
Here's how to name tool classes in Java? That’s all for the article. For more related Java tool naming content, please search for my previous articles or continue browsing the related articles below. I hope everyone will support me in the future!