Java方法设计的最佳实践：可变参数、空返回值与Optional的使用

### Java 方法设计的最佳实践：可变参数、空返回值与 Optional 的使用 #### 1. 构造函数与方法重载的注意事项 在涉及构造函数时，可能无法遵循某些建议。此时，至少应避免通过强制类型转换将同一组参数传递给不同重载方法的情况。若无法避免，例如在对现有类进行改造以实现新接口时，应确保在传递相同参数时，所有重载方法的行为一致。否则，程序员将难以有效使用重载方法或构造函数，并且会对其无法正常工作的原因感到困惑。 #### 2. 明智使用可变参数（Varargs） 可变参数方法（Variable Arity Methods）允许接受零个或多个指定类型的参数。其工作原理是先创建一个大小等于调用处传递参数数量的数组，将参数值放入数组，最后将数组传递给方法。 ##### 2.1 简单可变参数示例 以下是一个接受一系列 `int` 参数并返回它们总和的可变参数方法： ```java // Simple use of varargs static int sum(int... args) { int sum = 0; for (int arg : args) sum += arg; return sum; } ``` 在这个例子中，`sum(1, 2, 3)` 的值为 6，`sum()` 的值为 0。 ##### 2.2 传递一个或多个参数的可变参数方法 有时需要编写一个要求至少有一个参数的方法。例如，编写一个计算参数最小值的函数，如果客户端不传递任何参数，该函数将无法正常定义。一种错误的实现方式是在运行时检查数组长度： ```java // The WRONG way to use varargs to pass one or more arguments! static int min(int... args) { if (args.length == 0) throw new IllegalArgumentException("Too few arguments"); int min = args[0]; for (int i = 1; i < args.length; i++) if (args[i] < min) min = args[i]; return min; } ``` 这种实现存在几个问题： - 最严重的是，如果客户端不传递任何参数调用此方法，它将在运行时而不是编译时失败。 - 代码不够美观，需要显式检查 `args` 的有效性，并且如果不将 `min` 初始化为 `Integer.MAX_VALUE`，就无法使用 `for-each` 循环。 更好的实现方式是声明方法接受两个参数，一个是指定类型的普通参数，另一个是该类型的可变参数： ```java // The right way to use varargs to pass one or more arguments static int min(int firstArg, int... remainingArgs) { int min = firstArg; for (int arg : remainingArgs) if (arg < min) min = arg; return min; } ``` ##### 2.3 性能关键场景下的可变参数使用 在性能关键的情况下使用可变参数时要谨慎，因为每次调用可变参数方法都会导致数组的分配和初始化。如果经过经验验证无法承受这种成本，但又需要可变参数的灵活性，可以采用以下模式：假设一个方法 95% 的调用参数不超过三个，那么可以声明该方法的五个重载版本，分别接受零到三个普通参数，以及一个用于参数数量超过三个时的可变参数方法： ```java public void foo() { } public void foo(int a1) { } public void foo(int a1, int a2) { } public void foo(int a1, int a2, int a3) { } public void foo(int a1, int a2, int a3, int... rest) { } ``` 这样，只有在 5% 的调用中，当参数数量超过三个时才会付出数组创建的成本。 下面是可变参数使用的流程图： ```mermaid graph TD; A[调用可变参数方法] --> B{参数数量 <= 3}; B -- 是 --> C[调用普通参数重载方法]; B -- 否 --> D[调用可变参数方法，创建数组]; ``` #### 3. 返回空集合或数组，而不是 null 常见的错误做法是返回 `null` 来表示空集合或数组。例如： ```java // Returns null to indicate an empty collection. Don't do this! private final List<Cheese> cheesesInStock = ...; /** * @return a list containing all of the cheeses in the shop, * or null if no cheeses are available for purchase. ```