如何创建实用程序类？

Question

我想用实用程序方法创建一个类，例如

public class Util {

   public static void f (int i) {...}

   public static int g (int i, int j) {...}

}

创建实用程序类的最佳方法是哪一种？

我应该使用私有构造函数吗？

我应该将实用程序类设为抽象类吗？

我应该什么都不做？

Answer 1

对于Java中完全无状态的实用程序类，我建议将该类声明为public和final，并具有一个私有构造函数以防止实例化。的final关键字，可避免子类，并且可以在运行时提高工作效率。

该类应包含所有static方法，并且不应声明abstract（因为这意味着该类不是具体的，必须以某种方式实现）。

应该给该类一个与其所提供的实用程序集相对应的名称（如果该类将提供各种未分类的实用程序，则为“ Util”）。

除非嵌套类也将成为实用程序类，否则该类不应包含嵌套类（尽管这种做法可能很复杂并且会损害可读性）。

类中的方法应具有适当的名称。

仅由类本身使用的方法应该是私有的。

该类不应具有任何非最终/非静态类字段。

该类也可以由其他类静态导入，以提高代码的可读性（但这取决于项目的复杂性）。

例：

public final class ExampleUtilities {
    // Example Utility method
    public static int foo(int i, int j) {
        int val;

        //Do stuff

        return val;
    }

    // Example Utility method overloaded
    public static float foo(float i, float j) {
        float val;

        //Do stuff

        return val;
    }

    // Example Utility method calling private method
    public static long bar(int p) {
        return hid(p) * hid(p);
    }

    // Example private method
    private static long hid(int i) {
        return i * 2 + 1;
    }
}

也许最重要的是，每种方法的文档都应该准确且具有描述性。此类中的方法很有可能会被经常使用，并且拥有高质量的文档来补充代码是件好事。