try-catch-finally中的4個巨坑！
在 Java 語言中 try-catch-finally 看似簡單，一副人畜無害的樣子，但想要真正的“掌控”它，卻并不是一件容易的事。
別的不說，咱就拿 fianlly 來說吧，別看它的功能單一，但使用起來卻“暗藏殺機”，若您不信，咱來看下面的這幾個例子...
坑1：finally中使用return
若在 finally 中使用 return，那么即使 try-catch 中有 return 操作，也不會立馬返回結果，而是再執行完 finally 中的語句再返回。
此時問題就產生了：如果 finally 中存在 return 語句，則會直接返回 finally 中的結果，從而無情的丟棄了 try 中的返回值。
① 反例代碼
- public static void main(String[] args) throws FileNotFoundException {
- System.out.println("執行結果:" + test());
- }
- private static int test() {
- int num = 0;
- try {
- // num=1,此處不返回
- num++;
- return num;
- } catch (Exception e) {
- // do something
- } finally {
- // num=2,返回此值
- num++;
- return num;
- }
- }
以上代碼的執行結果如下：
② 原因分析
如果在 finally 中存在 return 語句，那么 try-catch 中的 return 值都會被覆蓋，如果程序員在寫代碼的時候沒有發現這個問題，那么就會導致程序的執行結果出錯。
③ 解決方案
如果 try-catch-finally 中存在 return 返回值的情況，一定要確保 return 語句只在方法的尾部出現一次。
④ 正例代碼
- public static void main(String[] args) throws FileNotFoundException {
- System.out.println("執行結果:" + testAmend());
- }
- private static int testAmend() {
- int num = 0;
- try {
- num = 1;
- } catch (Exception e) {
- // do something
- } finally {
- // do something
- }
- // 確保 return 語句只在此處出現一次
- return num;
- }
坑2：finally中的代碼“不執行”
如果說上面的示例比較簡單，那么下面這個示例會給你不同的感受，直接來看代碼。
① 反例代碼
- public static void main(String[] args) throws FileNotFoundException {
- System.out.println("執行結果:" + getValue());
- }
- private static int getValue() {
- int num = 1;
- try {
- return num;
- } finally {
- num++;
- }
- }
以上代碼的執行結果如下：
② 原因分析
本以為執行的結果會是 2，但萬萬沒想到竟然是 1，用馬大師的話來講：「我大意了啊，沒有閃」。
有人可能會問：如果把代碼換成 ++num，那么結果會不會是 2 呢？
很抱歉的告訴你，并不會，執行的結果依然是 1。那為什么會這樣呢？想要真正的搞懂它，我們就得從這段代碼的字節碼說起了。
以上代碼最終生成的字節碼如下：
- // class version 52.0 (52)
- // access flags 0x21
- public class com/example/basic/FinallyExample {
- // compiled from: FinallyExample.java
- // access flags 0x1
- public <init>()V
- L0
- LINENUMBER 5 L0
- ALOAD 0
- INVOKESPECIAL java/lang/Object.<init> ()V
- RETURN
- L1
- LOCALVARIABLE this Lcom/example/basic/FinallyExample; L0 L1 0
- MAXSTACK = 1
- MAXLOCALS = 1
- // access flags 0x9
- public static main([Ljava/lang/String;)V throws java/io/FileNotFoundException
- L0
- LINENUMBER 13 L0
- GETSTATIC java/lang/System.out : Ljava/io/PrintStream;
- NEW java/lang/StringBuilder
- DUP
- INVOKESPECIAL java/lang/StringBuilder.<init> ()V
- LDC "\u6267\u884c\u7ed3\u679c:"
- INVOKEVIRTUAL java/lang/StringBuilder.append (Ljava/lang/String;)Ljava/lang/StringBuilder;
- INVOKESTATIC com/example/basic/FinallyExample.getValue ()I
- INVOKEVIRTUAL java/lang/StringBuilder.append (I)Ljava/lang/StringBuilder;
- INVOKEVIRTUAL java/lang/StringBuilder.toString ()Ljava/lang/String;
- INVOKEVIRTUAL java/io/PrintStream.println (Ljava/lang/String;)V
- L1
- LINENUMBER 14 L1
- RETURN
- L2
- LOCALVARIABLE args [Ljava/lang/String; L0 L2 0
- MAXSTACK = 3
- MAXLOCALS = 1
- // access flags 0xA
- private static getValue()I
- TRYCATCHBLOCK L0 L1 L2 null
- L3
- LINENUMBER 18 L3
- ICONST_1
- ISTORE 0
- L0
- LINENUMBER 20 L0
- ILOAD 0
- ISTORE 1
- L1
- LINENUMBER 22 L1
- IINC 0 1
- L4
- LINENUMBER 20 L4
- ILOAD 1
- IRETURN
- L2
- LINENUMBER 22 L2
- FRAME FULL [I] [java/lang/Throwable]
- ASTORE 2
- IINC 0 1
- L5
- LINENUMBER 23 L5
- ALOAD 2
- ATHROW
- L6
- LOCALVARIABLE num I L0 L6 0
- MAXSTACK = 1
- MAXLOCALS = 3
- }
這些字節碼的簡易版本如下圖所示：
想要讀懂這些字節碼，首先要搞懂這些字節碼所代表的含義，這些內容可以從 Oracle 的官網查詢到（英文文檔）：https://docs.oracle.com/javase/specs/jvms/se8/html/jvms-6.html
磊哥在這里對這些字節碼做一個簡單的翻譯：
iconst 是將 int 類型的值壓入操作數棧。istore 是將 int 存儲到局部變量。iload 從局部變量加載 int 值。iinc 通過下標遞增局部變量。ireturn 從操作數堆棧中返回 int 類型的值。astore 將引用存儲到局部變量中。
有了這些信息之后，我們來翻譯一下上面的字節碼內容：
- 0 iconst_1 在操作數棧中存儲數值 1
- 1 istore_0 將操作數棧中的數據存儲在局部變量的位置 0
- 2 iload_0 從局部變量讀取值到操作數棧
- 3 istore_1 將操作數棧中存儲 1 存儲在局部變量的位置 1
- 4 iinc 0 by 1 把局部變量位置 0 的元素進行遞增（+1）操作
- 7 iload_1 將局部位置 1 的值加載到操作數棧中
- 8 ireturn 返回操作數棧中的 int 值
通過以上信息也許你并不能直觀的看出此方法的內部執行過程，沒關系磊哥給你準備了方法執行流程圖：
通過以上圖片我們可以看出：在 finally 語句（iinc 0, 1）執行之前，本地變量表中存儲了兩個信息，位置 0 和位置 1 都存儲了一個值為 1 的 int 值。而在執行 finally（iinc 0, 1）之前只把位置 0 的值進行了累加，之后又將位置 1 的值（1）返回給了操作數棧，所以當執行返回操作（ireturn）時會從操作數棧中讀到返回值為 1 的結果，因此最終的執行是 1 而不是 2。
③ 解決方案
關于 Java 虛擬機是如何編譯 finally 語句塊的問題，有興趣的讀者可以參考《The JavaTM Virtual Machine Specification, Second Edition》中 7.13 節 Compiling finally。那里詳細介紹了 Java 虛擬機是如何編譯 finally 語句塊。
實際上，Java 虛擬機會把 finally 語句塊作為 subroutine（對于這個 subroutine 不知該如何翻譯為好，干脆就不翻譯了，免得產生歧義和誤解）直接插入到 try 語句塊或者 catch 語句塊的控制轉移語句之前。但是，還有另外一個不可忽視的因素，那就是在執行 subroutine（也就是 finally 語句塊）之前，try 或者 catch 語句塊會保留其返回值到本地變量表（Local Variable Table）中，待 subroutine 執行完畢之后，再恢復保留的返回值到操作數棧中，然后通過 return 或者 throw 語句將其返回給該方法的調用者（invoker）。
因此如果在 try-catch-finally 中如果有 return 操作，**一定要確保 return 語句只在方法的尾部出現一次！**這樣就能保證 try-catch-finally 中所有操作代碼都會生效。
④ 正例代碼
- private static int getValueByAmend() {
- int num = 1;
- try {
- // do something
- } catch (Exception e) {
- // do something
- } finally {
- num++;
- }
- return num;
- }
坑3：finally中的代碼“非最后”執行
① 反例代碼
- public static void main(String[] args) throws FileNotFoundException {
- execErr();
- }
- private static void execErr() {
- try {
- throw new RuntimeException();
- } catch (RuntimeException e) {
- e.printStackTrace();
- } finally {
- System.out.println("執行 finally.");
- }
- }
以上代碼的執行結果如下：
從以上結果可以看出 finally 中的代碼并不是最后執行的，而是在 catch 打印異常之前執行的，這是為什么呢？
② 原因分析
產生以上問題的真實原因其實并不是因為 try-catch-finally，當我們打開 e.printStackTrace 的源碼就能看出一些端倪了，源碼如下：
從上圖可以看出，當執行 e.printStackTrace() 和 finally 輸出信息時，使用的并不是同一個對象。finally 使用的是標準輸出流：System.out，而 e.printStackTrace() 使用的卻是標準錯誤輸出流：System.err.println，它們執行的效果等同于：
- public static void main(String[] args) {
- System.out.println("我是標準輸出流");
- System.err.println("我是標準錯誤輸出流");
- }
而以上代碼執行結果的順序也是隨機的，而產生這一切的原因，我們或許可以通過標準錯誤輸出流（System.err）的注釋和說明文檔中看出：
我們簡單的對以上的注釋做一個簡單的翻譯：
“標準”錯誤輸出流。該流已經打開，并準備接受輸出數據。通常，此流對應于主機環境或用戶指定的顯示輸出或另一個輸出目標。按照慣例，即使主要輸出流（out 輸出流）已重定向到文件或其他目標位置，該輸出流（err 輸出流）也能用于顯示錯誤消息或其他信息，這些信息應引起用戶的立即注意。
從源碼的注釋信息可以看出，標準錯誤輸出流（System.err）和標準輸出流（System.out）使用的是不同的流對象，即使標準輸出流并定位到其他的文件，也不會影響到標準錯誤輸出流。那么我們就可以大膽的猜測：二者是獨立執行的，并且為了更高效的輸出流信息，二者在執行時是并行執行的，因此我們看到的結果是打印順序總是隨機的。
為了驗證此觀點，我們將標準輸出流重定向到某個文件，然后再來觀察 System.err 能不能正常打印，實現代碼如下：
- public static void main(String[] args) throws FileNotFoundException {
- // 將標準輸出流的信息定位到 log.txt 中
- System.setOut(new PrintStream(new FileOutputStream("log.txt")));
- System.out.println("我是標準輸出流");
- System.err.println("我是標準錯誤輸出流");
- }
以上代碼的執行結果如下：
當程序執行完成之后，我們發現在項目的根目錄出現了一個新的 log.txt 文件，打開此文件看到如下結果：
從以上結果可以看出標準輸出流和標準錯誤輸出流是彼此獨立執行的，且 JVM 為了高效的執行會讓二者并行運行，所以最終我們看到的結果是 finally 在 catch 之前執行了。
③ 解決方案
知道了原因，那么問題就好處理，我們只需要將 try-catch-finally 中的輸出對象，改為統一的輸出流對象就可以解決此問題了。
④ 正例代碼
- private static void execErr() {
- try {
- throw new RuntimeException();
- } catch (RuntimeException e) {
- System.out.println(e);
- } finally {
- System.out.println("執行 finally.");
- }
- }
改成了統一的輸出流對象之后，我手工執行了 n 次，并沒有發現任何問題。
坑4：finally中的代碼“不執行”
finally 中的代碼一定會執行嗎？如果是之前我會毫不猶豫的說“是的”，但在遭受了社會的毒打之后，我可能會這樣回答：正常情況下 finally 中的代碼一定會執行的，但如果遇到特殊情況 finally 中的代碼就不一定會執行了，比如下面這些情況：
- 在 try-catch 語句中執行了 System.exit；
- 在 try-catch 語句中出現了死循環；
- 在 finally 執行之前掉電或者 JVM 崩潰了。
如果發生了以上任意一種情況，finally 中的代碼就不會執行了。雖然感覺這一條有點“抬杠”的嫌疑，但墨菲定律告訴我們，如果一件事有可能會發生，那么他就一定會發生。所以從嚴謹的角度來說，這個觀點還是成立的，尤其是對于新手來說，神不知鬼不覺的寫出一個自己發現不了的死循環是一件很容易的事，不是嘛？
① 反例代碼
- public static void main(String[] args) {
- noFinally();
- }
- private static void noFinally() {
- try {
- System.out.println("我是 try~");
- System.exit(0);
- } catch (Exception e) {
- // do something
- } finally {
- System.out.println("我是 fially~");
- }
- }
以上代碼的執行結果如下：
從以上結果可以看出 finally 中的代碼并沒有執行。
② 解決方案
排除掉代碼中的 System.exit 代碼，除非是業務需要，但也要注意如果在 try-cacth 中出現了 System.exit 的代碼，那么 finally 中的代碼將不會被執行。
總結
本文我們展示了 finally 中存在的一些問題，有很實用的干貨，也有一些看似“杠精”的示例，但這些都從側面印證了一件事，那就是想完全掌握的 try-catch-finally 并不是一件簡單的事。最后，在強調一點，如果 try-catch-finally 中存在 return 返回值的操作，那么一定要確保 return 語句只在方法的尾部出現一次！
