ITEM 75: INCLUDE FAILURE-CAPTURE INFORMATION IN DETAIL MESSAGES
当程序由于未捕获的异常而失败时，系统自动打印出异常的堆栈跟踪。堆栈跟踪包含异常的字符串表示形式，即调用其 toString 方法的结果。这通常由异常的类名和它的详细信息组成。这通常是程序员或站点可靠性工程师在调查软件故障时所掌握的唯一信息。如果故障不容易重现，则可能很难或不可能获得更多的信息。因此，异常的 toString 方法返回关于失败原因的尽可能多的信息是非常重要的。换句话说，异常的详细信息应该能够说明故障，以便进行后续分析。
要捕获失败，异常的详细信息应该包含导致异常的所有参数和字段的值。例如，IndexOutOfBoundsException 的详细信息应该包含下界、上界和未位于边界之间的索引值。这个信息告诉我们很多关于失败的信息。这三个值中的任何一个或全部都可能是错误的。索引可能小于下界或等于上界(“fencepost 错误”)，或者它可能是一个不合法的值，过低或过高。下界可能大于上界(严重的内部不变失败)。每一种情况都指向一个不同的问题，如果您知道要查找的错误类型，就会大大有助于诊断。
需要注意的是安全敏感信息。在诊断和修复软件问题的过程中，许多人可能会看到堆栈跟踪，因此不应该在异常信息中包含密码、加密密钥等。
虽然在异常的详细消息中包含所有相关数据非常重要，但通常不需要包含大量的文字。我们可以利用堆栈跟踪与文档以及(如果必要的话)源代码一起分析。它通常包含抛出异常的确切文件和行号，以及堆栈上所有其他方法调用的文件和行号。用冗长的文字描写失败是多余的；这些信息可以通过阅读文档和源代码来获取。
异常的详细信息不应与用户级别的错误消息混淆，后者必须是终端用户能够理解的。与用户级别的错误消息不同，在分析故障时，详细消息主要是为程序员或站点可靠性工程师服务的。因此，信息内容远比可读性重要。用户级别的错误消息通常是本地化的，而异常细节消息很少是本地化的。
确保异常在其细节消息中包含足够的失败捕获信息的一种方法是在其构造函数中要求该信息，而不是字符串细节消息。然后可以自动生成包含这些信息的详细信息。例如，IndexOutOfBoundsException 可以有一个类似这样的构造函数，而不是字符串构造函数:
/**
* Constructs an IndexOutOfBoundsException.
*
* @param lowerBound the lowest legal index value
* @param upperBound the highest legal index value plus one
* @param index the actual index value
*/
public IndexOutOfBoundsException(int lowerBound, int upperBound,
int index) {
// Generate a detail message that captures the failure
super(String.format("Lower bound: %d, Upper bound: %d, Index: %d", lowerBound, upperBound, index));
// Save failure information for programmatic access
this.lowerBound = lowerBound;
this.upperBound = upperBound;
this.index = index;
}
在Java 9中，IndexOutOfBoundsException 最终获得了一个构造函数，它接受一个 int 值的索引参数，但遗憾的是，它忽略了下界和上界参数。一般来说，Java 库不会大量使用这种习惯用法，但强烈建议这样做。它使得程序员可以很容易地抛出异常来捕获失败。事实上，它使得程序员很难不捕获失败！实际上，该习惯用法将代码集中在异常类中生成高质量的细节消息，而不是要求类的每个用户都冗余地生成细节消息。
正如 item 70 中所建议的，为异常的失败捕获信息(上例中的下界、上界和索引)提供访问器方法可能是合适的。对已检查异常提供此类访问器方法比对未检查异常提供此类访问器方法更为重要，因为故障捕获信息在从故障中恢复时可能非常有用。程序员希望通过编程访问未检查异常的详细信息的情况很少见(尽管并非不可思议)。然而，即使对于未检查的异常，根据一般原则提供这些访问器似乎也是可取的(item 12)。
网友评论