Effective Java-异常

异常机制可以使程序中异常处理代码和正常业务代码分离,提高程序的可读性、可靠性和可维护性。

1.只针对异常的情况才使用异常

异常机制的设计初衷是用于不正常的情形,它只能用于异常的情况,永远不应该用于正常的控制流。
设计良好的API不应该强迫它的客户端为了正常的控制流而使用异常。如果类具有“状态相关”的方法,这个类往往也应该有个单独的“状态测试”方法,指示是否可以调用这个状态相关的方法。例如,Iterator接口有一个“状态相关”的next()和相应的状态测试方法hasNext()。这使得利用for循环对集合进行迭代的标准模式成为可能:

for (Iterator<Foo> i = collection.iterator(); i.hasNext(); ) {
    Foo foo = i.next();
    ...
}

如果Iterator缺少hasNext(),客户端将被迫改用下面的做法:

try {
    Iterator<Foo> i = collection.iterator();
    while(true) {
        Foo foo = i.next();
        ...
    }
} catch (NoSuchElementException e) {
}

异常是为了在异常情况下使用而设计的,不要将它们用于普通的控制流,也不要编写迫使它们这么做的API。

2.对可恢复的情况使用受检异常,对编程错误使用运行时异常

JDK异常体系结构如下图所示(只列出部分常见异常):

Java语言提供了三种可抛出结构(throwable):

  1. 受检的异常(checked exception)
  2. 运行时异常(run-time exception)
  3. 错误(error)

异常的使用情形:

  1. 期望能从异常恢复时,应该使用受检异常
  2. 用运行时异常来表明编程错误

运行时异常和错误都是未受检的可抛出结构,在行为上两者是等同的,它们都不需要也不应该被捕获。如果程序抛出未受检的异常或错误,往往就属于不可恢复的情形,继续执行下去有害无益,此时系统应做的就是及时终止,并及时提示错误信息。
按照惯例,错误往往被JVM保留用于表示资源不足、约束失败,或者其他使程序无法继续执行的条件。因此最好不要再实现任何新的Error子类。实现的所有未受检的抛出结构都应该是RuntimeException直接或间接的子类。

对于可恢复的情况,使用受检异常;
对于程序错误,使用运行时异常。
异常也是个完全意义上的对象,可以在它上面定义任意的方法。这些方法的主要用途是为捕获异常的代码提供额外的信息,特别是关于引发这个异常条件的信息。
受检的异常往往指明了可恢复的条件,对于这样的异常,提供一些辅助方法尤其重要,通过这些方法,调用者可以获得一些有助于恢复的信息。

3.避免不必要地使用受检异常

受检异常强迫程序员处理异常的条件,虽然大大增强了可靠性,但过分使用受检的异常会使API使用起来非常不方便。
如果正确地使用API并不能阻止这种异常条件的产生,并且一旦产生异常,使用API的程序员可以立即采取有用的动作,就可认为这种受检异常是必要的,否则,更适合使用未受检异常。
把受检的异常变成未受检的异常的一种做法是:把这个抛出异常的方法分成两个方法,其中第一个方法返回一个boolean,表明是否应该抛出异常:
重构前:

try {
    obj.action(args);
} catch (TheCheckedException e) {
    ...  // handle exception condition
}

重构后:

if (obj.actionPermitted(args)) {
    obj.action(args);
} else {
    ...  // handle exception condion
}

这种重构并不总是恰当的,但凡是在恰当的地方,它都会使API用起来更加舒服,也更加灵活。

4.优先使用标准的异常

Java平台类库提供了一组基本的未受检异常,它们满足了绝大多数API的异常抛出需求。
重用现有的异常是很有好处的:

  1. 它使API更加易于学习和使用,因为它与习惯用法是一致的;
  2. 对于用到这些API的程序而言,可读性会更好,因为它们不会出现很多程序员不熟悉的异常;
  3. 异常类越少,意味着内存印迹就越小,装载这些类的时间开销也越少。

常用的异常如下:

选择使用哪个异常并不是总是很精确的,有时候它们的使用场合并不相互排斥。

5.抛出与抽象相对应的异常

如果方法抛出的异常与它所执行的任务没有明显的联系,这种情形将会使人不知所措。当方法传递由低层抽象抛出的异常时,往往会发生这种情况。除了使人感到困惑外,这也让实现细节污染了更高层的API。如果高层的实现在后续的发行版本中发生了变化,它所抛出的异常也可能会跟着发生变化,从而潜在地破坏现有的客户端程序。
为避免上述问题,更高层的实现应该捕获底层的异常,同时抛出可以按照高层抽象进行解释的异常。这种做法被称为异常转译

try {
    ...
} catch (LowerLevelException e) {
    throw new HigherLevelException(...);
}

如JDK源码中AbstractSequentialList类,它是List接口的一个骨架实现类,按照List<E>接口中get方法的规范,需要对其进行异常转译:

public E get(int index) {
    ListIterator<E> i = listIterator(index);
    try {
        return i.next();
    } catch (NoSuchElementException e) {
        throw new IndexOutOfBoundsException("Index: " + index);
    }
}

异常链是一种特殊的异常转译形式,如果低层的异常对于调试导致高层异常的问题非常有帮助,就应该使低层的异常传到高层的异常,高层的异常提供访问方法来获得低层的异常:

try {
    ...
} catch (LowerLevelException cause) {
    throw new HightLevelException(cause);
}

如果不能阻止或处理来自更低层的异常,一般的做法是使用异常转译,除非低层方法碰巧可以保证它抛出的所有异常对高层也合适才可以将异常从低层传播到高层。
异常链对高层和低层异常都提供了最佳的功能:它允许抛出适当的高层异常,同时又能捕获低层的原因进行失败分析。

6.每个方法抛出的异常都要有文档

描述一个方法所抛出的异常,是正确使用这个方法时所需文档的重要组成部分,仔细地为每个方法抛出的异常建立文档是特别重要的。
使用Javadoc的@throws标签记录方法可能抛出的每个未受检异常,但是不要使用throws关键字将未受检的异常包含在方法的声明中。对使用API的程序员来讲,面对受检异常和未受检异常,他们的责任是不同的,要能清晰区分。

要为你编写的每个方法所能抛出的每个异常建立文档。要为每个受检异常提供单独的throws子句,不要为未受检的异常提供throws子句。如果没有为可以抛出的异常建立文档,其他人就很难或根本不可能有效地使用你的类和接口。

7.在细节消息中包含能捕获失败的信息

打印异常信息是为了便于分析失败原因的,这些信息中应该包含有利于分析的细节内容。例如IndexOutOfBoundsException异常的细节消息应该包含下界、上界、没有落在界内的下标值。
与用户层级的错误消息不同,异常的字符串表示法主要是让程序员用来分析失败原因,信息的内容比可理解性重要的多。异常信息包含大量的描述信息往往没有什么意义。
Throwable提供了一些接口供获得相应的异常信息:

提供有助于分析异常的细节信息是非常重要的,因为有些异常情形可能是非常难以复现的。

8.努力使失败保持原子性

当对象抛出异常后,通常我们期望这个对象仍能保持在一种定义良好的可用状态中,因为调用者期望能从这种异常中进行恢复。一般而言,失败的方法调用应该使对象保持在被调用之前的状态。具有这种属性的方法被称为具有失败原子性
简而言之,方法执行可以失败,但不能破坏对象的状态。
想要获得失败原子性,通常有四种方法:
1. 设计一个不可变的对象
2. 在执行操作之前检查参数的有效性
即在对象被破坏之前,先抛出异常。

//如果不进行检查,从一个empty stack pop元素会破坏对象状态
public Object pop() {
    if (size == 0) {
        throw new EmptyStackException();
    }
    Object result = elements[--size];
    elements[size] = null;
    return result;
}

3. 编写一段恢复代码
由恢复代码来拦截操作过程中发生的失败,并使对象回滚到操作开始之前的状态上。这种办法主要用于永久性的(基于磁盘的)数据结构。
4. 在对象的一份临时拷贝上执行操作
先在对象拷贝数据上进行操作,再用临时拷贝中的结果代替对象的内容。如Collections.sort():

    default void sort(Comparator<? super E> c) {
        Object[] a = this.toArray();
        Arrays.sort(a, (Comparator) c);
        ListIterator<E> i = this.listIterator();
        for (Object e : a) {
            i.next();
            i.set((E) e);
        }
    }

一般而言,作为方法规范的一部分,产生的任何异常都应该让对象保持在该方法调用之前的状态。如果违反这条规则,API文档就应该清楚地指明对象将会处于什么样的状态。

9.不要忽略异常

声明一个方法可能抛出某个异常的时候,等同于在试图提醒某些可能会发生的一些事情,不应忽略它。

try {
    ...
} catch (SomeException e) {
}

空的catch块会使异常达不到应有的目的,它会使对象和系统处于一种不确定的状态,出现问题时,也不易追查错误源。

不管异常代表了可预见的异常条目,还是编程错误,用空的catch块忽略它,将会导致程序在遇到错误的情况下继续执行下去,有可能在将来的某个点上导致失败。正确地处理异常能够挽回失败。即使无法挽回,将异常传播给外界,至少会导致程序迅速失败,从而保留有助于调试该失败条件的信息。

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

推荐阅读更多精彩内容

  • 第五十七条、只针对异常的情况才使用异常 不要优先使用基于异常的模式:因为异常机制的设计初衷是用于不正常的情况,所以...
    Timorous阅读 665评论 0 1
  • 57、只针对异常的情况才使用异常 在这段代码中,当循环企图访问数组边界之外的元素时,抛出异常,以达到终止无限循环的...
    Alent阅读 300评论 0 3
  • 引言 在程序运行过程中(注意是运行阶段,程序可以通过编译),如果JVM检测出一个不可能执行的操作,就会出现运行时错...
    Steven1997阅读 2,414评论 1 6
  • 第57条:只针对异常的情况处理异常 用抛出(throw)、捕获(catch)、忽略ArrayIndexOutOfB...
    wangcanfeng阅读 285评论 0 0
  • 王家大院位于西安长安区翠华山水泥厂向东500米,是集农家美食、特色住宿和户外休闲为一体的农家乐。 特色美食:土鸡、...
    西安百晓生阅读 1,031评论 0 0