Google_Guava官方教程(中文版)1.5-Throwables:简化异常和错误的传播与检查
reprint
Fri Oct 01 20:48:00 CST 2010

Throwables:简化异常和错误的传播与检查

异常传播

有时候,你会想把捕获到的异常再次抛出。这种情况通常发生在Error或RuntimeException 被捕获的时候,你没想捕获它们,但是声明 捕获Throwable和Exception的时候,也包括了 了Error或RuntimeException。Guava提供了若干方法,来判断异常类 型并且重新传播异常。 例如:

try {
    someMethodThatCouldThrowAnything();
} catch (IKnowWhatToDoWithThisException e) {
    handle(e);
} catch (Throwable t) {
    Throwables.propagateIfInstanceOf(t, IOException.class);
    Throwables.propagateIfInstanceOf(t, SQLException.class);
    throw Throwables.propagate(t);
}

所有这些方法都会自己决定是否要抛出异常,但也能直接抛出方法返回的结果——例如, throw Throwables.propagate(t);—— 这样可以向编译器声明这里一定会抛出异常。Guava中 的异常传播方法简要列举如下:

RuntimeException   propagate(Throwable) 如果Throwable是Error或RuntimeException,直接抛出;
否则把Throwable包装成RuntimeException抛出。
返回类型是RuntimeException,所以你可以像上面说的那样写成throw Throwables.propagate(t),
Java编译器会意识到这行代码保证抛出异常。
void propagateIfInstanceOf( Throwable, Class<X extends   Exception>) throws X Throwable类型为X才抛出
void propagateIfPossible( Throwable) Throwable类型为Error或RuntimeException才抛出
void propagateIfPossible( Throwable, Class<X extends Throwable>) throws X Throwable类型为X, Error或RuntimeException才抛出

Throwables.propagate的用法

模仿Java7的多重异常捕获和再抛出。

通常来说,如果调用者想让异常传播到栈顶,他不需要写任何catch代码块。因为他不打算 从异常中恢复,他可能就不应该记录异常,或者有其他的动作。他可能是想做一些清理工作, 但通常来说,无论操作是否成功,清理工作都要进行,所以清理工作可能会放在finallly代 码块中。但有时候,捕获异常然后再抛出也是有用的:也许调用者想要在异常传播之前统计 失败的次数,或者有条件地传播异常。当只对一种异常进行捕获和再抛出时,代码可能还是 简单明了的。但当多种异常需要处理时,却可能变得一团糟:

@Override public void run() {
    try {
        delegate.run();
    } catch (RuntimeException e) {
        failures.increment();
        throw e;
    }catch (Error e) {
        failures.increment();
        throw e;
    }
}

Java7用多重捕获解决了这个问题:

try {
   ...
} catch (RuntimeException | Error e) {
    failures.increment();
    throw e;
}

非Java7用户却受困于这个问题。他们想要写如下代码来统计所有异常,但是编译器不允许 他们抛出Throwable(译者注:这种写法把原本是Error或RuntimeException类型的异常修改 成了Throwable,因此调用者不得不修改方法签名):

try {
  ...
} catch (Throwable t) {
    failures.increment();
    throw t;
}

解决办法是用throw Throwables.propagate(t)替换throw t。在限定情况下(捕获Error和 RuntimeException),Throwables.propagate和原始代码有相同行为。然而,用 Throwables.propagate也很容易写出有其他隐藏行为的代码。尤其要注意的是,这个方案只 适用于处理 RuntimeException 或Error。如果catch块捕获了受检异常,你需要调用 propagateIfInstanceOf来保留原始代码的行为,因为Throwables.propagate不能直接传播 受检异常。

总之,Throwables.propagate的这种用法也就马马虎虎,在Java7中就没必要这样做了。在 其他Java版本中,它可以减少少量的代码重复,但简单地提取方法进行重构也能做到这一点。 此外,使用propagate会意外地包装受检异常。

非必要用法:把抛出的Throwable转为Exception

有少数API,尤其是Java反射API和(以此为基础的)Junit,把方法声明成抛出Throwable。 和这样的API交互太痛苦了,因为即 使是最通用的API通常也只是声明抛出Exception。当确 定代码会抛出Throwable,而不是Exception或Error时,调用者可能会 用 Throwables.propagate转化Throwable。这里有个用Callable执行Junit测试的范例:

public Void call() throws Exception {
    try {
        FooTest.super.runTest();
    } catch (Throwable t) {
        Throwables.propagateIfPossible(t, Exception.class);
        Throwables.propagate(t);
    }
    return null;
}

在这儿没必要调用propagate()方法,因为propagateIfPossible传播了Throwable之外的所 有异常类型,第二行的 propagate就变得完全等价于throw new RuntimeException(t)。 (题外话:这个例子也提醒我们,propagateIfPossible可能也会引起混乱,因为它不但会 传播参 数中给定的异常类型,还抛出Error和RuntimeException)

这种模式(或类似于throw new RuntimeException(t)的模式)在Google代码库中出现了超 过30次。(搜索’propagateIfPossible[^;]* Exception.class[)];’)绝大多数情况下都明 确用了”throw new RuntimeException(t)”。我们也曾想过有 个”throwWrappingWeirdThrowable”方法处理Throwable到 Exception的转化。但考虑到我们 用两行代码实现了这个模式,除非我们也丢弃propagateIfPossible方法,不然定义这个 throwWrappingWeirdThrowable方法也并没有太大必要。

Throwables.propagate的有争议用法

争议一:把受检异常转化为非受检异常

原则上,非受检异常代表bug,而受检异常表示不可控的问题。但在实际运用中,即使JDK也 有所误用——如Object.clone()、 Integer. parseInt(String)、URI(String)——或者至少对 某些方法来说,没有让每个人都信服的答案,如 URI.create(String)的异常声明。

try {
    return Integer.parseInt(userInput);
} catch (NumberFormatException e) {
    throw new InvalidInputException(e);
}

try {
    return publicInterfaceMethod.invoke();
} catch (IllegalAccessException e) {
    throw new AssertionError(e);
}

有时候,调用者会使用Throwables.propagate转化异常。这样做有没有什么缺点?最主要的 恐怕是代码的含义不太明显。throw Throwables.propagate(ioException)做了什么?throw new RuntimeException(ioException)做了什么?这两者做了同样的事情,但后者的意思更 简单直接。前者却引起了疑问:”它做了什么?它并不只是把异常包装进RuntimeException 吧?如果它真的只做了包装,为什么还非得要写个方法?”。应该承认,这些问题部分是因 为”propagate”的语义太模糊了(用来抛出未声明的异常吗?)。 也许”wrapIfChecked”更 能清楚地表达含义。但即使方法叫做”wrapIfChecked”,用它来包装一个已知类型的受检异 常也没什么优点。甚至会有其他缺点:也许比起RuntimeException,还有更合适的类型—— 如IllegalArgumentException。

我们有时也会看到propagate被用于传播可能为受检的异常,结果是代码相比以前会稍微简 短点,但也稍微有点不清晰:

try {

} catch (RuntimeException e) {
    throw e;
} catch (Exception e) {
    throw new RuntimeException(e);
}

} catch (Exception e) {
 throw Throwables.propagate(e);
}

然而,我们似乎故意忽略了把检查型异常转化为非检查型异常的合理性。在某些场景中,这 无疑是正确的做法,但更多时候它被用于避免处理受检异常。这让 我们的话题变成了争论 受检异常是不是坏主意了,我不想对此多做叙述。但可以这样说,Throwables.propagate不 是为了鼓励开发者忽略 IOException这样的异常。

争议二:异常穿隧

但是,如果你要实现不允许抛出异常的方法呢?有时候你需要把异常包装在非受检异常内。 这种做法挺好,但我们再次强调,没必要用propagate方法做这种简单的包装。实际上,手 动包装可能更好:如果你手动包装了所有异常(而不仅仅是受检异常),那你就可以在另一 端解包所有异常,并处理极少数特殊场景。此外,你可能还想把异常包装成特定的类型,而 不是像propagate这样统一包装成RuntimeException。

争议三:重新抛出其他线程产生的异常

try {
    return future.get();
} catch (ExecutionException e) {
    throw Throwables.propagate(e.getCause());
}

对这样的代码要考虑很多方面:

异常原因链

Guava提供了如下三个有用的方法,让研究异常的原因链变得稍微简便了,这三个方法的签名是不言自明的:

Throwable   getRootCause(Throwable)
List<Throwable>   getCausalChain(Throwable)
String   getStackTraceAsString(Throwable)
其它文章