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

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

image.png

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,047评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,807评论 3 386
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,501评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,839评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,951评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,117评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,188评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,929评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,372评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,679评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,837评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,536评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,168评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,886评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,129评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,665评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,739评论 2 351

推荐阅读更多精彩内容