Java 异常处理的 20 个最佳实践，你知道几个？

异常处理是 java 开发中的一个重要部分，是为了处理任何错误状况，比如资源不可访问，非法输入，空输入等等。java 提供了几个异常处理特性，以try，catch 和 finally 关键字的形式内建于语言自身之中。java 编程语言也允许创建新的自定义异常，并通过使用 throw 和 throws关键字抛出它们。在java编程中，java 的异常处理不单单是知道语法这么简单，它必须遵循标准的 jdk 库，和处理错误和异常的开源代码。

这里我们将讨论一些关于异常处理的 java 最佳实践。在我们讨论异常处理的最佳实践之前，先让我们了解下几个重要的概念，那就是什么是异常以及异常的分类。

什么是异常？

异常的英文单词是 exception，异常本质上是程序上的错误，包括程序逻辑错误和系统错误。比如使用空的引用、数组下标越界、内存溢出错误等，这些都是意外的情况，背离我们程序本身的意图。错误在我们编写程序的过程中会经常发生，包括编译期间和运行期间的错误，在编译期间出现的错误有编译器帮助我们一起修正，然而运行期间的错误便不是编译器力所能及了，并且运行期间的错误往往是难以预料的。假若程序在运行期间出现了错误，如果置之不理，程序便会终止或直接导致系统崩溃，显然这不是我们希望看到的结果。

如何对运行期间出现的错误进行处理和补救呢？java 提供了异常机制来进行处理，通过异常机制来处理程序运行期间出现的错误。通过异常机制，我们可以更好地提升程序的健壮性。

异常分类

java 把异常当作对象来处理，并定义一个基类 java.lang.throwable 作为所有异常的超类。

java 包括三种类型的异常: 检查性异常(checked exceptions)、非检查性异常(unchecked exceptions) 和错误(errors)。

• 检查性异常(checked exceptions) 是必须在在方法的 throws 子句中声明的异常。它们扩展了异常，旨在成为一种“在你面前”的异常类型。java希望你能够处理它们，因为它们以某种方式依赖于程序之外的外部因素。检查的异常表示在正常系统操作期间可能发生的预期问题。 当你尝试通过网络或文件系统使用外部系统时，通常会发生这些异常。 大多数情况下，对检查性异常的正确响应应该是稍后重试，或者提示用户修改其输入。
• 非检查性异常(unchecked exceptions) 是不需要在throws子句中声明的异常。 由于程序错误，jvm并不会强制你处理它们，因为它们大多数是在运行时生成的。 它们扩展了 runtimeexception。 最常见的例子是 nullpointerexception， 未经检查的异常可能不应该重试，正确的操作通常应该是什么都不做，并让它从你的方法和执行堆栈中出来。
• 错误(errors) 是严重的运行时环境问题，肯定无法恢复。 例如 outofmemoryerror，linkageerror 和 *error，通常会让程序崩溃。

所有不是 runtime exception 的异常，统称为 checked exception，又被称为检查性异常。这类异常的产生不是程序本身的问题，通常由外界因素造成的。为了预防这些异常产生时，造成程序的中断或得到不正确的结果，java 要求编写可能产生这类异常的程序代码时，一定要去做异常的处理。

java 语言将派生于 runtimeexception 类或 error 类的所有异常称为非检查性异常。

java 异常层次结构图如下图所示：

在了解了异常的基本概念以及分类后，现在让我们开始探索异常处理的最佳实践吧。

异常处理最佳实践

不要忽略捕捉的异常

catch (nosuchmethodexception e) {
   return null;
}

虽然捕捉了异常但是却没有做任何处理，除非你确信这个异常可以忽略，不然不应该这样做。这样会导致外面无法知晓该方法发生了错误，无法确定定位错误原因。

在你的方法里抛出定义具体的检查性异常

public void foo() throws exception { //错误方式
}

一定要避免出现上面的代码示例，它破坏了检查性异常的目的。 声明你的方法可能抛出的具体检查性异常，如果只有太多这样的检查性异常，你应该把它们包装在你自己的异常中，并在异常消息中添加信息。 如果可能的话，你也可以考虑代码重构。

public void foo() throws specificexception1, specificexception2 { //正确方式
}

捕获具体的子类而不是捕获 exception 类

try {
   somemethod();
} catch (exception e) { //错误方式
   logger.error("method has failed", e);
}

捕获异常的问题是，如果稍后调用的方法为其方法声明添加了新的检查性异常，则开发人员的意图是应该处理具体的新异常。如果你的代码只是捕获异常（或 throwable），永远不会知道这个变化，以及你的代码现在是错误的，并且可能会在运行时的任何时候中断。

永远不要捕获 throwable 类

这是一个更严重的麻烦，因为 java error 也是 throwable 的子类，error 是 jvm 本身无法处理的不可逆转的条件，对于某些 jvm 的实现，jvm 可能实际上甚至不会在 error 上调用 catch 子句。

始终正确包装自定义异常中的异常，以便堆栈跟踪不会丢失

catch (nosuchmethodexception e) {
   throw new myserviceexception("some information: " + e.getmessage());  //错误方式
}

这破坏了原始异常的堆栈跟踪，并且始终是错误的，正确的做法是：

catch (nosuchmethodexception e) {
   throw new myserviceexception("some information: " , e);  //正确方式
}

要么记录异常要么抛出异常，但不要一起执行

catch (nosuchmethodexception e) {  
//错误方式 
   logger.error("some information", e);
   throw e;
}

正如上面的代码中，记录和抛出异常会在日志文件中产生多条日志消息，代码中存在单个问题，并且对尝试分析日志的同事很不友好。

finally 块中永远不要抛出任何异常

try {
  somemethod();  //throws exceptionone
} finally {
  cleanup();    //如果finally还抛出异常，那么exceptionone将永远丢失
}

只要 cleanup() 永远不会抛出任何异常，上面的代码没有问题，但是如果 somemethod() 抛出一个异常，并且在 finally 块中，cleanup() 也抛出另一个异常，那么程序只会把第二个异常抛出来，原来的第一个异常（正确的原因）将永远丢失。如果在 finally 块中调用的代码可能会引发异常，请确保要么处理它，要么将其记录下来。永远不要让它从 finally 块中抛出来。

始终只捕获实际可处理的异常

catch (nosuchmethodexception e) {
   throw e; //避免这种情况，因为它没有任何帮助
}

这是最重要的概念，不要为了捕捉异常而捕捉，只有在想要处理异常时才捕捉异常，或者希望在该异常中提供其他上下文信息。如果你不能在 catch 块中处理它，那么最好的建议就是不要只为了重新抛出它而捕获它。

不要使用 printstacktrace() 语句或类似的方法

完成代码后，切勿忽略 printstacktrace()，最终别人可能会得到这些堆栈，并且对于如何处理它完全没有任何方法，因为它不会附加任何上下文信息。

对于不打算处理的异常，直接使用 finally

try {
  somemethod();  //method 2
} finally {
  cleanup();    //do cleanup here
}

这是一个很好的做法，如果在你的方法中你正在访问 method 2，而 method 2 抛出一些你不想在 method 1 中处理的异常，但是仍然希望在发生异常时进行一些清理，然后在 finally 块中进行清理，不要使用 catch 块。

记住早 throw 晚 catch 原则

这可能是关于异常处理最著名的原则，简单说，应该尽快抛出(throw)异常，并尽可能晚地捕获(catch)它。应该等到有足够的信息来妥善处理它。

这个原则隐含地说，你将更有可能把它放在低级方法中，在那里你将检查单个值是否为空或不适合。而且你会让异常堆栈跟踪上升好几个级别，直到达到足够的抽象级别才能处理问题。

在异常处理后清理资源

如果你正在使用数据库连接或网络连接等资源，请确保清除它们。如果你正在调用的 api 仅使用非检查性异常，则仍应使用 try-finally 块来清理资源。 在 try 模块里面访问资源，在 finally 里面最后关闭资源。即使在访问资源时发生任何异常，资源也会优雅地关闭。

只抛出和方法相关的异常

相关性对于保持应用程序清洁非常重要。一种尝试读取文件的方法，如果抛出 nullpointerexception，那么它不会给用户任何相关的信息。相反，如果这种异常被包裹在自定义异常中，则会更好。nosuchfilefoundexception 则对该方法的用户更有用。

切勿在程序中使用异常来进行流程控制

不要在项目中出现使用异常来处理应用程序逻辑。永远不要这样做，它会使代码很难阅读和理解。

尽早验证用户输入以在请求处理的早期捕获异常

始终要在非常早的阶段验证用户输入，甚至在达到 controller 之前，它将帮助你把核心应用程序逻辑中的异常处理代码量降到最低。如果用户输入出现错误，还可以保证与应用程序一致。

例如：如果在用户注册应用程序中，遵循以下逻辑：

1. 验证用户
2. 插入用户
3. 验证地址
4. 插入地址
5. 如果出问题回滚一切

这是不正确的做法，它会使数据库在各种情况下处于不一致的状态，应该首先验证所有内容，然后将用户数据置于 dao 层并进行数据库更新。正确的做法是：

1. 验证用户
2. 验证地址
3. 插入用户
4. 插入地址
5. 如果问题回滚一切

一个异常只能包含在一个日志中

logger.debug("using cache sector a");
logger.debug("using retry sector b");

不要像上面这样做，对多个 logger.debug() 调用使用多行日志消息可能在你的测试用例中看起来不错，但是当它在具有 100 个并行运行的线程的应用程序服务器的日志文件中显示时，所有信息都输出到相同的日志文件，即使它们在实际代码中为前后行，但是在日志文件中这两个日志消息可能会间隔 100 多行。应该这样做：

logger.debug("using cache sector a, using retry sector b");

将所有相关信息尽可能地传递给异常

有用的异常消息和堆栈跟踪非常重要，如果你的日志不能定位异常位置，那要日志有什么用呢？

终止掉被中断线程

while (true) {
  try {
    thread.sleep(100000);
  } catch (interruptedexception e) {} //别这样做
  dosomethingcool();
}

interruptedexception 异常提示应该停止程序正在做的事情，比如事务超时或线程池被关闭等。

应该尽最大努力完成正在做的事情，并完成当前执行的线程，而不是忽略 interruptedexception。修改后的程序如下：

while (true) {
  try {
    thread.sleep(100000);
  } catch (interruptedexception e) {
    break;
  }
}
dosomethingcool();

对于重复的 try-catch，使用模板方法

在代码中有许多类似的 catch 块是无用的，只会增加代码的重复性，针对这样的问题可以使用模板方法。

例如，在尝试关闭数据库连接时的异常处理。

class dbutil{
    public static void closeconnection(connection conn){
        try{
            conn.close();
        } catch(exception ex){
            //log exception - cannot close connection
        }
    }
}

这类的方法将在应用程序很多地方使用。不要把这块代码放的到处都是，而是定义上面的方法，然后像下面这样使用它：

public void dataaccesscode() {
    connection conn = null;
    try{
        conn = getconnection();
        ....
    } finally{
        dbutil.closeconnection(conn);
    }
}

使用 javadoc 中记录应用程序中的所有异常

把用 javadoc 记录运行时可能抛出的所有异常作为一种习惯，其中也尽量包括用户应该遵循的操作，以防这些异常发生。

总结

这篇文章首先介绍了什么是异常，以及异常的三种分类，然后通过 20 个最佳实践来讨论如何处理异常，希望能在以后异常处理的时候有所改进及感悟。