Effective Java(3rd)-Item74 记录每个方法抛出的所有异常

  描述方法抛出的异常是正确使用方法所需文档的重要部分。因此,花时间仔细记录每个方法抛出的所有异常是非常重要的(item56)。

  始终单独声明已检查异常,并使用Javadoc @throw标记精确地记录每次抛出异常的条件。不要使用快捷方式声明一个方法抛出它可以抛出的多个异常类的超类。作为一个极端的例子,不要声明公共方法抛出Exception,或者更糟,抛出Throwable。除了拒绝向方法的用户提供关于它能够抛出的异常的任何指导之外,这样的声明还极大地阻碍了方法的使用,因为它有效地掩盖了可能在相同上下文中抛出的任何其他异常。这个建议的一个异常是main方法,它可以安全地声明为抛出异常,因为它只被VM调用。
  虽然该语言不要求程序员声明方法能够抛出的未检查异常,但明智的做法是像检查异常一样仔细地记录它们。未检查异常通常表示编程错误( item70 ),让程序员熟悉他们可能犯的所有错误可以帮助他们避免犯这些错误。方法可以抛出的未检查异常的良好文档列表有效地描述了成功执行的先决条件。每个公共方法的文档都必须描述它的先决条件(item56),记录它的未检查异常是满足这个需求的最佳方法。

  特别重要的是,接口中的方法要记录它们可能抛出的未检查异常。此文档构成接口通用契约的一部分,并支持接口的多个实现之间的公共行为。
  使用Javadoc @throw标记记录方法可以抛出的每个异常,但是不要对未检查的异常使用throw关键字。重要的是,使用您的API的程序员知道哪些异常被检查,哪些异常被检查,因为程序员的职责在这两种情况下是不同的。Javadoc @throw标记生成的文档在方法声明中没有对应的throw子句,这向程序员提供了一个强烈的视觉提示,说明异常是未检查的。
  应该注意的是,记录每个方法可以抛出的所有未检查异常是理想的,在现实世界中并不总是可以实现。类进行修订时,如果将导出的方法修改为抛出额外的未检查异常,这并不违反源或二进制兼容性。假设一个类从另一个独立编写的类调用一个方法。前类的作者可能会仔细记录所有的每个方法抛出未经检查的异常,如果后者类修改把额外的未经检查的异常,很可能前类(未经修订)将传播新的未经检查的异常,尽管它没有文档。
  如果类中的许多方法出于相同的原因引发异常,可以在类的文档注释中记录异常而不是为每个方法单独编写文档。一个常见的例子是NullPointerException。一个类的文档注释可以这样说,
“如果在任何参数中传递null对象引用,该类中的所有方法都会抛出NullPointerException,”或类似的语句。

  总之,记录您所编写的每个方法可能引发的每个异常。对于未检查异常和已检查异常以及抽象方法和具体方法都是如此。本文档应采用以下形式@在doc注释中抛出标记。在方法的throw子句中分别声明每个已检查的异常,但不要声明未检查的异常。如果您不能记录方法可能抛出的异常,其他人将很难或不可能有效地使用您的类和接口。
本文写于2019.7.22,历时1天

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

推荐阅读更多精彩内容