java - 如何创建实用程序类？

Question

这个问题在这里已经有了答案:

Java: Static Class? (8 个回答)

关闭 8年前。

我想创建一个带有实用方法的类，例如

public class Util {

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

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

}

创建实用程序类的最佳方法是什么？

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

我应该为抽象类创建实用程序类吗？

我应该什么都不做吗？

Answer 1

对于 Java 中完全无状态的实用程序类，我建议将该类声明为 public 和 final，并使用私有(private)构造函数来防止实例化。 final 关键字可以防止子类化，可以提高运行时的效率。

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

应为类指定与其提供的实用程序集相对应的名称(如果该类要提供广泛的未分类实用程序，则应为“Util”)。

该类不应包含嵌套类，除非嵌套类也是实用程序类(尽管这种做法可能很复杂并损害可读性)。

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

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

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

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

例子:

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;
    }
}

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