[译]Java中9个处理Exception的最佳实践

标签： java exception 最佳实践 | 发表时间：2017-09-17 19:29 | 作者：
出处：http://www.rowkey.me/

在Java中处理异常并不是一个简单的事情。不仅仅初学者很难理解，即使一些有经验的开发者也需要花费很多时间来思考如何处理异常，包括需要处理哪些异常，怎样处理等等。这也是绝大多数开发团队都会制定一些规则来规范对异常的处理的原因。而团队之间的这些规范往往是截然不同的。

本文给出几个被很多团队使用的异常处理最佳实践。

1. 在Finall块中使清理资源或者使用try-with-resource语句

当使用类似InputStream这种需要使用后关闭的资源时，一个常见的错误就是在try块的最后关闭资源。

1
2
3
4
5
6
7
8
9
10
11
12
13
14

      public void doNotCloseResourceInTry() {
    FileInputStream inputStream = null;
    try {
        File file = new File("./tmp.txt");
        inputStream = new FileInputStream(file);
        // use the inputStream to read a file
        // do NOT do this
        inputStream.close();
    } catch (FileNotFoundException e) {
        log.error(e);
    } catch (IOException e) {
        log.error(e);
    }
}

上述代码在没有任何exception的时候运行时没有问题的。但是当try块中的语句抛出异常或者自己实现的代码抛出异常，那么久不会执行最后的关闭语句，从而资源也无法释放。

合理的做法则是将所有清理的代码都放到finally块中或者使用try-with-resource语句。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

      public void closeResourceInFinally() {
    FileInputStream inputStream = null;
    try {
        File file = new File("./tmp.txt");
        inputStream = new FileInputStream(file);
        // use the inputStream to read a file
    } catch (FileNotFoundException e) {
        log.error(e);
    } finally {
        if (inputStream != null) {
            try {
                inputStream.close();
            } catch (IOException e) {
                log.error(e);
            }
        }
    }
}

public void automaticallyCloseResource() {
    File file = new File("./tmp.txt");
    try (FileInputStream inputStream = new FileInputStream(file);) {
        // use the inputStream to read a file
    } catch (FileNotFoundException e) {
        log.error(e);
    } catch (IOException e) {
        log.error(e);
    }
}

2. 指定具体的异常

尽可能的使用最具体的异常来声明方法，这样才能使得代码更容易理解。

1
2
3
4
5
6

      public void doNotDoThis() throws Exception {
    ...
}
public void doThis() throws NumberFormatException {
    ...
}

3. 对异常进行文档说明

当在方法上声明抛出异常时，也需要进行文档说明。和前面的一点一样，都是为了给调用者提供尽可能多的信息，从而可以更好地避免/处理异常。

在Javadoc中加入throws声明，并且描述抛出异常的场景。

1
2
3
4
5
6
7
8
9

      /**
 * This method does something extremely useful ...
 *
 * @param input
 * @throws MyBusinessException if ... happens
 */
public void doSomething(String input) throws MyBusinessException {
    ...
}

4. 抛出异常的时候包含描述信息

在抛出异常时，需要尽可能精确地描述问题和相关信息，这样无论是打印到日志中还是监控工具中，都能够更容易被人阅读被定位具体信息、错误的严重程度等。

但这里并不是说你要对错误信息长篇大论，因为本来Exception的类名就能够反映错误的原因，因此只需要用一到两句话描述即可。

1
2
3
4
5

      try {
    new Long("xyz");
} catch (NumberFormatException e) {
    log.error(e);
}

NumberFormatException即告诉了这个异常是格式化错误，异常的额外信息只需要提供这个错误字符串即可。当异常的名称不够明显的时候，则需要提供尽可能具体的错误信息。

5. 首先捕获最具体的异常

现在很多IDE都能智能提示这个最佳实践，当你试图首先捕获最笼统的异常时，会提示 不能达到的代码。

当有多个catch块中，按照捕获顺序只有第一个匹配到的catch块才能执行。因此，如果先捕获IllegalArgumentException，那么则无法运行到对NumberFormatException的捕获。

1
2
3
4
5
6
7
8
9

      public void catchMostSpecificExceptionFirst() {
    try {
        doSomething("A message");
    } catch (NumberFormatException e) {
        log.error(e);
    } catch (IllegalArgumentException e) {
        log.error(e)
    }
}

6. 不要捕获Throwable

Throwable是所有异常和错误的父类。你可以在catch语句中捕获，但是永远不要这么做。

如果catch了throwable，那么不仅仅会捕获所有exception，还会捕获error。而error是表明无法恢复的jvm错误。因此除非绝对肯定能够处理或者被要求处理error，不要捕获throwable。

1
2
3
4
5
6
7

      public void doNotCatchThrowable() {
    try {
        // do something
    } catch (Throwable t) {
        // don't do this!
    }
}

7. 不要忽略异常

很多时候，开发者很有自信不会抛出异常，因此写了一个catch块，但是没有做任何处理或者日志。

1
2
3
4
5
6
7
8

      
public void doNotIgnoreExceptions() {
    try {
        // do something
    } catch (NumberFormatException e) {
        // this will never happen
    }
}

但现实是经常会出现无法预料的异常或者无法确定这里的代码未来是不是会改动(删除了阻止异常抛出的代码)，而此时异常由于被捕获了，因此无法拿到足够的错误信息来定位问题。

合理的做法是至少要记录异常的信息。

1
2
3
4
5
6
7

      public void logAnException() {
    try {
        // do something
    } catch (NumberFormatException e) {
        log.error("This should never happen: " + e);
    }
}

8. 不要记录并抛出异常

可以发现很多代码甚至类库中都会有捕获异常、日志记录并再次抛出的逻辑。如下：

1
2
3
4
5
6

      try {
    new Long("xyz");
} catch (NumberFormatException e) {
    log.error(e);
    throw e;
}

这个处理逻辑看着是合理的。但这经常会给同一个异常输出多条日志。如下：

1
2
3
4
5
6
7

      17:44:28,945 ERROR TestExceptionHandling:65 - java.lang.NumberFormatException: For input string: "xyz"
Exception in thread "main" java.lang.NumberFormatException: For input string: "xyz"
at java.lang.NumberFormatException.forInputString(NumberFormatException.java:65)
at java.lang.Long.parseLong(Long.java:589)
at java.lang.Long.(Long.java:965)
at com.stackify.example.TestExceptionHandling.logAndThrowException(TestExceptionHandling.java:63)
at com.stackify.example.TestExceptionHandling.main(TestExceptionHandling.java:58)

如上所示，后面的日志也没有附加更有用的信息。如果想要提供更加有用的信息，那么可以将异常包装为自定义异常。

1
2
3
4
5
6
7
8

      
public void wrapException(String input) throws MyBusinessException {
    try {
        // do something
    } catch (NumberFormatException e) {
        throw new MyBusinessException("A message that describes the error.", e);
    }
}

因此，仅仅当想要处理异常时才去捕获，否则只需要在方法签名中声明让调用者去处理。

9. 包装异常时不要去处理此异常

捕获标准异常并包装为自定义异常是一个很常见的做法。这样可以添加更为具体的异常信息并能够做针对的异常处理。

需要注意的是，包装异常时，一定要把原始的异常设置为cause(Exception有构造方法可以传入cause)。否则，丢失了原始的异常信息会让错误的分析变得困难。

1
2
3
4
5
6
7

      public void wrapException(String input) throws MyBusinessException {
    try {
        // do something
    } catch (NumberFormatException e) {
        throw new MyBusinessException("A message that describes the error.", e);
    }
}

总结

综上可知，当抛出或者捕获异常时，这里有很多不一样的东西需要考虑。其中的许多点都是为了提升代码的可阅读性或者api的可用性。

异常不仅仅是一个错误控制机制，也是一个沟通媒介，因此与你的协作者讨论这些最佳实践并制定一些规范能够让每个人都理解通用的概念并且能够按照同样的方式使用它们。

原文链接: https://dzone.com/articles/9-best-practices-to-handle-exceptions-in-java

相关 [java exception 最佳实践] 推荐：

[译]Java中9个处理Exception的最佳实践

- - 后端技术杂谈 | 飒然Hang
在Java中处理异常并不是一个简单的事情. 不仅仅初学者很难理解，即使一些有经验的开发者也需要花费很多时间来思考如何处理异常，包括需要处理哪些异常，怎样处理等等. 这也是绝大多数开发团队都会制定一些规则来规范对异常的处理的原因. 而团队之间的这些规范往往是截然不同的. 本文给出几个被很多团队使用的异常处理最佳实践.

Java SE 7 Exception的使用

- - ITeye博客
Java SE 7 Exception的使用. 在Java SE 7 中，作为Project Coin项目中众多有用的细小语言变化之一的加强型异常处理，现在来学习如何利用它. 在这边文章中，我们所涉及的一些变化是作为Java平台标准版7(Java SE 7)所发布，在JSR334(Java Specification Request)有详细的说明.

消除Java应用中的Exception开销

- - 舒の随想日记
抛异常最大的消耗在于构造整个异常栈的过程，如果你的栈很深，特别是用了一些框架的话，这个开销基本是不可忽视的，之前做的一个优化显示当时应用中的一个异常使得整个应用的性能下降至少30%. 最大开销的地方在这里，当你去new一个Exception的时候，会调用父类Throwable的构造函数， Throwable的构造函数中会调用native的fillInStackTrace()，这个方法就会构造整个异常栈了.

使用 Java Native Interface 的最佳实践

- - 博客 - 伯乐在线
简介： Java™ 本机接口（Java Native Interface，JNI）是一个标准的 Java API，它支持将 Java 代码与使用其他 编程语言编写的代码相集成. 如果您希望利用已有的代码资源，那么可以使用 JNI 作为您工具包中的关键组件 —— 比如在面向服务架构（SOA）和基于云的系统中.

Java 异步编程最佳实践

- - 鸟窝
最近异步编程非常流行， 主要是它能够在多核系统上提高吞吐率. 异步编程是一种编程方式，可以提高对UI的快速响应. Java中的异步编程模型提供了一致性的编程模型， 可以用来在程序中支持异步. 本文讨论了在使用Java执行异步操作应该遵循的最佳实践. 原文： Best Practices of Asynchronous Programming With Java.

Java的Exception和Error面试题10问10答

- - ITeye博客
JAVA 中Exception和Error 面试问题. 　　下面是我个人总结的在Java和J2EE开发者在面试中经常被问到的有关Exception和Error的知识. 回答的时候，我也给这些问题作了快速修订，并且提供源码以便深入理解. 我总结了各种难度的问题，适合新手码. 如果你遇到了我列表中没有的问题，并且这个问题非常好，请在下面评论中分享出来.

该如何良好的实践Java中的Exception机制

- - BlogJava-首页技术区
首先，我先声明一点，我讨论的仅限于互联网数据产品，当然可能会涉及到一些其他的抽象，但是所有的结论不代表能复用到所有场景.         几乎每个Java程序员都清楚知道Java的异常和错误机制，无论是在面试过程中，还是在学习中，你看到Exception，无非就是了解一下继承关系、子类、和Error的关系等等.

10个精妙的Java编码最佳实践

- - ImportNew
这是一个比Josh Bloch的 Effective Java规则更精妙的10条Java编码实践的列表. 和Josh Bloch的列表容易学习并且关注日常情况相比，这个列表将包含涉及API/SPI设计中不常见的情况，可能有很大影响. 我在编写和维护jOOQ(Java中内部DSL建模的SQL)时遇到过这些.

编写高性能 Java 代码的最佳实践

- - 码农网 » JAVA开发
摘要：本文首先介绍了负载测试、基于APM工具的应用程序和服务器监控，随后介绍了编写高性能Java代码的一些最佳实践. 最后研究了JVM特定的调优技巧、数据库端的优化和架构方面的调整. 在这篇文章中，我们将讨论几个有助于提升Java应用程序性能的方法. 我们首先将介绍如何定义可度量的性能指标，然后看看有哪些工具可以用来度量和监控应用程序性能，以及确定性能瓶颈.

Java 编程中关于异常处理的 10 个最佳实践

- - 博客 - 伯乐在线
英文原文： 10 Exception handling Best Practices in Java Programming 编译： oschina. 异常处理是书写 强健 Java应用的一个重要部分. 它是关乎每个应用的一个非功能性需求，是为了优雅的处理任何错误状况，比如资源不可访问，非法输入，空输入等等.