使用 try-with-resources 優雅關閉資源

我們知道，在 Java 編程過程中，如果打開了外部資源（文件、數據庫連接、網絡連接等、redis)，我們必須在這些外部資源使用完畢後，手動關閉它們。

因爲外部資源不由 JVM 管理，無法享用 JVM 的垃圾回收機制，如果我們不在編程時確保在正確的時機關閉外部資源，就會導致外部資源泄露，緊接着就會出現文件被異常佔用，數據庫連接過多導致連接池溢出**等諸多很嚴重的問題。

JDK7 之前的資源關閉方式

/**
 * jdk7以前關閉流的方式
 * */
public class CloseResourceBefore7 {
    private static final String FileName = "file.txt";

    public static void main(String[] args) throws IOException {
        FileInputStream inputStream = null;

        try {
            inputStream = new FileInputStream(FileName);
            char c1 = (char) inputStream.read();
            System.out.println("c1=" + c1);
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (inputStream != null) {
                inputStream.close();
            }
        }
    }
}

JDK7 之後用 try-with-resource 語法關閉

在 JDK7 以前，Java 沒有自動關閉外部資源的語法特性，直到 JDK7 中新增了try-with-resource 語法，才實現了這一功能。

try-with-resource Resource 的定義：所有實現了 java.lang.AutoCloseable 接口（其中，它包括實現了 java.io.Closeable 的所有對象），可以使用作爲資源。

1. 一個例子

一個實現了 java.lang.AutoCloseable 接口的 Resource 類：

/**
 * 資源類
 * */
public class Resource implements AutoCloseable {
    public void sayHello() {
        System.out.println("hello");
    }

    @Override
    public void close() throws Exception {
        System.out.println("Resource is closed");
    }
}

測試類 CloseResourceIn7.java

/**
 * jdk7及以後關閉流的方式
 * */
public class CloseResourceIn7 {
    public static void main(String[] args) {
        try(Resource resource = new Resource()) {
            resource.sayHello();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

打印結果：

hello
Resource is closed

當存在多個打開資源的時候： 資源二 Resource2.java

/**
 * 資源2
 * */
public class Resource2 implements AutoCloseable {
    public void sayhello() {
        System.out.println("Resource say hello");
    }

    @Override
    public void close() throws Exception {
        System.out.println("Resource2 is closed");
    }
}

測試類 CloseResourceIn7.java

/**
 * jdk7及以後關閉流的方式
 * */
public class CloseResourceIn7 {
    public static void main(String[] args) {
        try(Resource resource = new Resource(); Resource2 resource2 = new Resource2()) {
            resource.sayHello();
            resource2.sayhello();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

結果：

hello
hello2
Resource2 is closed
Resource is closed

注意：打開多個資源的時候，關閉順序是倒敘的

原理

查看編譯的 class 文件 CloseResourceIn7.class

public class CloseResourceIn7 {
    public CloseResourceIn7() {
    }

    public static void main(String[] args) {
        try {
            Resource resource = new Resource();
            Throwable var2 = null;
            try {
                resource.sayHello();
            } catch (Throwable var12) {
                var2 = var12;
                throw var12;
            } finally {
                if (resource != null) {
                    if (var2 != null) {
                        try {
                            resource.close();
                        } catch (Throwable var11) {
                            var2.addSuppressed(var11);
                        }
                    } else {
                        resource.close();
                    }
                }
            }
        } catch (Exception var14) {
            var14.printStackTrace();
        }
    }
}

可以發現編譯以後生成了 try-catch-finally 語句塊 finally 中的 var2.addSuppressed(var11)，這麼做是爲了處理異常屏蔽的。

我們將代碼修改一下 資源 Resource.java，讓兩個方法裏都拋出異常

/**
 * 資源類
 * */
public class Resource implements AutoCloseable {
    public void sayHello() throws Exception {
        throw new Exception("Resource throw Exception");
    }

    @Override
    public void close() throws Exception {
        throw new Exception("Close method throw Exception");
    }
}

測試類 CloseResourceBefore7.java

/**
 * jdk7以前關閉流的方式
 * */
public class CloseResourceBefore7 {

    public static void main(String[] args) {
        try {
            errorTest();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    private static void errorTest() throws Exception {
        Resource resource = null;
        try {
            resource = new Resource();
            resource.sayHello();
        }

        finally {
            if (resource != null) {
                resource.close();
            }
        }
    }
}

打印結果：

java.lang.Exception: Close method throw Exception
	at com.shuwen.Resource.close(Resource.java:15)
	at com.shuwen.CloseResourceIn7.errorTest(CloseResourceIn7.java:27)
	at com.shuwen.CloseResourceIn7.main(CloseResourceIn7.java:12)

只打印了最後出現的關閉異常【異常屏蔽】這樣會給開發人員排查錯誤帶來一定的困難 我們換成 try-with-resource 方法實現CloseResourceIn7.java

/**
 * jdk7及以後關閉流的方式
 * */
public class CloseResourceIn7 {

    public static void main(String[] args) {
        try {
            errorTest();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    private static void errorTest() throws Exception {
        try(Resource resource = new Resource()) {
            resource.sayHello();
        }

    }
}

打印信息：

java.lang.Exception: Resource throw Exception
	at com.shuwen.Resource.sayHello(Resource.java:10)
	at com.shuwen.CloseResourceIn7.errorTest(CloseResourceIn7.java:20)
	at com.shuwen.CloseResourceIn7.main(CloseResourceIn7.java:12)
	Suppressed: java.lang.Exception: Close method throw Exception
		at com.shuwen.Resource.close(Resource.java:15)
		at com.shuwen.CloseResourceIn7.errorTest(CloseResourceIn7.java:21)
		... 1 more

可以發現，異常信息中多了一個 Suppressed 的提示，告訴我們這個異常其實由兩個異常組成，Close method throw Exception這個異常是被 Suppressed【屏蔽】的異常。

應用：在 Jedis 中的使用

import redis.clients.jedis.Jedis;
import redis.clients.jedis.JedisPool;

public class JedisTest {

  public static void main(String[] args) {
    JedisPool pool = new JedisPool();
    try (Jedis jedis = pool.getResource()) { // 用完自動 close
      doSomething(jedis);
    }
  }

  private static void doSomething(Jedis jedis) {
    // code it here
  }
}

這樣 Jedis 對象肯定會歸還給連接池 (死循環除外)，避免應用程序卡死的慘劇發生。