Effective Java(3rd)-Item75 在详细消息中包含故障捕获信息

  当程序由于未捕获异常而失败时，系统自动打印出异常的堆栈跟踪。堆栈跟踪包含异常的字符串表示，这是调用其toString方法的结果。这通常包括异常的类名及其详细信息。通常，这是程序员或站点可靠性工程师在调查软件故障时所掌握的唯一信息。如果失败不容易重现，则可能很难或不可能获得更多信息。因此，异常的toString方法返回尽可能多的关于失败原因的信息是非常重要的。换句话说，异常的详细信息应该捕获失败，以便后续分析。
  要捕获故障，异常的详细消息应该包含导致异常的所有参数和字段的值。例如，IndexOutOfBoundsException的详细消息应该包含下界、上界和未能位于下界之间的索引值。这些信息说明了很多关于失败的信息。这三个值中的任何一个或所有值都可能是错误的。索引可以小于或等于上界(“fencepost错误”)，也可以是一个野生值，太低或太高。下界可能大于上界(严重的内部不变故障)。每一种情况都指向一个不同的问题，如果你知道你在寻找什么样的错误，这对诊断有很大的帮助。
  一个警告与安全敏感信息有关。因为在诊断和修复软件问题的过程中，许多人可能会看到堆栈跟踪，不要在详细信息中包含密码、加密密钥等。
  虽然在异常的详细信息中包含所有相关数据非常重要，但通常不需要包含大量的散文。堆栈跟踪将与文档一起分析，如果需要，还将与源代码一起分析。它通常包含抛出异常的确切文件和行号，以及堆栈上所有其他方法调用的文件和行号。冗长的散文描述失败是多余的;可以通过阅读文档和源代码来收集信息。
  异常的详细信息不应该与用户级错误消息混淆，因为最终用户必须能够理解这些错误消息。与用户级错误消息不同，详细消息主要是为程序员或站点可靠性工程师在分析故障时提供的。因此，信息内容远比可读性重要。用户级错误消息通常是本地化的，而异常详细信息消息很少本地化。
  确保异常在其详细信息中包含足够的故障捕获信息的一种方法是，在其构造函数中而不是字符串详细信息中需要该信息。然后可以自动生成详细信息来包含信息。例如，代替a的字符串构造函数IndexOutOfBoundsException可能有这样一个构造函数:

image.png

  从Java 9开始，IndexOutOfBoundsException最终获得了一个接受int值索引参数的构造函数，但遗憾的是它忽略了下界和上界参数。更一般地说，Java库不会大量使用这个习惯用法，但是强烈推荐使用它。它使程序员很容易抛出异常来捕获失败。事实上，它使程序员很难不捕获失败!实际上，这个习惯用法将代码集中在exception类中生成高质量的详细信息，而不是要求该类的每个用户都冗余地生成详细信息。
  正如第70项中建议的，异常可能适合为其故障捕获信息提供访问器方法(上面示例中的下界、上界和索引)。在已检查异常上提供此类访问器方法比未检查异常上提供此类访问器方法更为重要，因为故障捕获信息可能有助于从故障中恢复。程序员可能希望通过编程访问未检查异常的详细信息，这是很少见的(尽管不是不可想象的)。然而，即使对于未检查的异常，似乎也应该根据一般原则提供这些访问器(项目12，第57页)。
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
本文写于2019..，历时天