深入理解Java try-with-resource
来源:互联网 发布:如何撤销淘宝投诉 编辑:程序博客网 时间:2024/06/02 06:26
背景
众所周知,所有被打开的系统资源,比如流、文件或者Socket连接等,都需要被开发者手动关闭,否则随着程序的不断运行,资源泄露将会累积成重大的生产事故。
在Java的江湖中,存在着一种名为finally的功夫,它可以保证当你习武走火入魔之时,还可以做一些自救的操作。在远古时代,处理资源关闭的代码通常写在finally块中。然而,如果你同时打开了多个资源,那么将会出现噩梦般的场景:
12345678910111213141516171819202122232425262728293031323334353637
public class Demo {public static void main(String[] args) {BufferedInputStream bin = null;BufferedOutputStream bout = null;try {bin = new BufferedInputStream(new FileInputStream(new File("test.txt")));bout = new BufferedOutputStream(new FileOutputStream(new File("out.txt")));int b;while ((b = bin.read()) != -1) {bout.write(b);}}catch (IOException e) {e.printStackTrace();}finally {if (bin != null) {try {bin.close();}catch (IOException e) {e.printStackTrace();}finally {if (bout != null) {try {bout.close();}catch (IOException e) {e.printStackTrace();}}}}}}}
Oh My God!!!关闭资源的代码竟然比业务代码还要多!!!这是因为,我们不仅需要关闭BufferedInputStream
,还需要保证如果关闭BufferedInputStream
时出现了异常, BufferedOutputStream
也要能被正确地关闭。所以我们不得不借助finally中嵌套finally大法。可以想到,打开的资源越多,finally中嵌套的将会越深!!!
更为可恶的是,Python程序员面对这个问题,竟然微微一笑很倾城地说:“这个我们一点都不用考虑的嘞~”:
但是兄弟莫慌!我们可以利用Java 1.7中新增的try-with-resource语法糖来打开资源,而无需码农们自己书写资源来关闭代码。妈妈再也不用担心我把手写断掉了!我们用try-with-resource来改写刚才的例子:
1234567891011121314
public class TryWithResource {public static void main(String[] args) {try (BufferedInputStream bin = new BufferedInputStream(new FileInputStream(new File("test.txt")));BufferedOutputStream bout = new BufferedOutputStream(new FileOutputStream(new File("out.txt")))) {int b;while ((b = bin.read()) != -1) {bout.write(b);}}catch (IOException e) {e.printStackTrace();}}}
是不是很简单?是不是很刺激?再也不用被Python程序员鄙视了!好了,下面将会详细讲解其实现原理以及内部机制。
动手实践
为了能够配合try-with-resource,资源必须实现AutoClosable
接口。该接口的实现类需要重写close
方法:
12345678910
public class Connection implements AutoCloseable {public void sendData() {System.out.println("正在发送数据");}public void close() throws Exception {System.out.println("正在关闭连接");}}
调用类:
12345678910
public class TryWithResource {public static void main(String[] args) {try (Connection conn = new Connection()) {conn.sendData();}catch (Exception e) {e.printStackTrace();}}}
运行后输出结果:
12
正在发送数据正在关闭连接
通过结果我们可以看到,close方法被自动调用了。
原理
那么这个是怎么做到的呢?我相信聪明的你们一定已经猜到了,其实,这一切都是编译器大神搞的鬼。我们反编译刚才例子的class文件:
1234567891011121314151617181920212223242526272829303132
public class TryWithResource {public TryWithResource() {}public static void main(String[] args) {try {Connection e = new Connection();Throwable var2 = null;try {e.sendData();} catch (Throwable var12) {var2 = var12;throw var12;} finally {if(e != null) {if(var2 != null) {try {e.close();} catch (Throwable var11) {var2.addSuppressed(var11);}} else {e.close();}}}} catch (Exception var14) {var14.printStackTrace();}}}
看到没,在第15~27行,编译器自动帮我们生成了finally块,并且在里面调用了资源的close方法,所以例子中的close方法会在运行的时候被执行。
异常屏蔽
我相信,细心的你们肯定又发现了,刚才反编译的代码(第21行)比远古时代写的代码多了一个addSuppressed
。为了了解这段代码的用意,我们稍微修改一下刚才的例子:我们将刚才的代码改回远古时代手动关闭异常的方式,并且在sendData
和close
方法中抛出异常:
12345678910
public class Connection implements AutoCloseable {public void sendData() throws Exception {throw new Exception("send data");}public void close() throws Exception {throw new MyException("close");}}
修改main方法:
1234567891011121314151617181920212223
public class TryWithResource {public static void main(String[] args) {try {test();}catch (Exception e) {e.printStackTrace();}}private static void test() throws Exception {Connection conn = null;try {conn = new Connection();conn.sendData();}finally {if (conn != null) {conn.close();}}}}
运行之后我们发现:
12345
basic.exception.MyException: closeat basic.exception.Connection.close(Connection.java:10)at basic.exception.TryWithResource.test(TryWithResource.java:82)at basic.exception.TryWithResource.main(TryWithResource.java:7)......
好的,问题来了,由于我们一次只能抛出一个异常,所以在最上层看到的是最后一个抛出的异常——也就是close
方法抛出的MyException
,而sendData
抛出的Exception
被忽略了。这就是所谓的异常屏蔽。由于异常信息的丢失,异常屏蔽可能会导致某些bug变得极其难以发现,程序员们不得不加班加点地找bug,如此毒瘤,怎能不除!幸好,为了解决这个问题,从Java 1.7开始,大佬们为Throwable
类新增了addSuppressed
方法,支持将一个异常附加到另一个异常身上,从而避免异常屏蔽。那么被屏蔽的异常信息会通过怎样的格式输出呢?我们再运行一遍刚才用try-with-resource包裹的main方法:
12345678
java.lang.Exception: send dataat basic.exception.Connection.sendData(Connection.java:5)at basic.exception.TryWithResource.main(TryWithResource.java:14)......Suppressed: basic.exception.MyException: closeat basic.exception.Connection.close(Connection.java:10)at basic.exception.TryWithResource.main(TryWithResource.java:15)... 5 more
可以看到,异常信息中多了一个Suppressed
的提示,告诉我们这个异常其实由两个异常组成,MyException
是被Suppressed的异常。可喜可贺!
一个小问题
在使用try-with-resource的过程中,一定需要了解资源的close
方法内部的实现逻辑。否则还是可能会导致资源泄露。
举个例子,在Java BIO中采用了大量的装饰器模式。当调用装饰器的close
方法时,本质上是调用了装饰器内部包裹的流的close
方法。比如:
123456789101112131415
public class TryWithResource {public static void main(String[] args) {try (FileInputStream fin = new FileInputStream(new File("input.txt"));GZIPOutputStream out = new GZIPOutputStream(new FileOutputStream(new File("out.txt")))) {byte[] buffer = new byte[4096];int read;while ((read = fin.read(buffer)) != -1) {out.write(buffer, 0, read);}}catch (IOException e) {e.printStackTrace();}}}
在上述代码中,我们从FileInputStream
中读取字节,并且写入到GZIPOutputStream
中。GZIPOutputStream
实际上是FileOutputStream
的装饰器。由于try-with-resource的特性,实际编译之后的代码会在后面带上finally代码块,并且在里面调用fin.close()方法和out.close()方法。我们再来看GZIPOutputStream
类的close方法:
123456789
public void close() throws IOException {if (!closed) {finish();if (usesDefaultDeflater)def.end();out.close();closed = true;}}
我们可以看到,out变量实际上代表的是被装饰的FileOutputStream
类。在调用out变量的close
方法之前,GZIPOutputStream
还做了finish
操作,该操作还会继续往FileOutputStream
中写压缩信息,此时如果出现异常,则会out.close()
方法被略过,然而这个才是最底层的资源关闭方法。正确的做法是应该在try-with-resource中单独声明最底层的资源,保证对应的close
方法一定能够被调用。在刚才的例子中,我们需要单独声明每个FileInputStream
以及FileOutputStream
:
12345678910111213141516
public class TryWithResource {public static void main(String[] args) {try (FileInputStream fin = new FileInputStream(new File("input.txt"));FileOutputStream fout = new FileOutputStream(new File("out.txt"));GZIPOutputStream out = new GZIPOutputStream(fout)) {byte[] buffer = new byte[4096];int read;while ((read = fin.read(buffer)) != -1) {out.write(buffer, 0, read);}}catch (IOException e) {e.printStackTrace();}}}
由于编译器会自动生成fout.close()
的代码,这样肯定能够保证真正的流被关闭。
总结
怎么样,是不是很简单呢,如果学会了话
参考资料
官方文档
详解try-with-resource
- 深入理解Java try-with-resource
- 深入理解Java%20try-with-resource/
- 深入理解 Java 中的 try-with-resource
- 深入理解 Java 中的 try-with-resource
- 深入理解 Java try-with-resource 语法糖
- Java-try-with-resource
- java中try-with-resource
- Java新特性-try-with-resource
- 使用Java中的Try-With-Resource
- java7 try-with-resource
- try-with-resource
- jdk1.7 try-with-resource
- 深入理解java中的try-catch-finally
- java7中try-with-resource语法
- [Java开发之路](20)try-with-resource 异常声明
- LoadRunner:深入理解Resource 和Non-Resource
- 深入理解Resource 和Non-Resource
- 使用try-with-resource改进代码异常处理机制
- NSTimer 详解
- iPhone获取设备UDID
- MSSQL FOR XML PATH 用法
- 7.8 Git 工具 - 高级合并
- 我理解的优秀软件工程师
- 深入理解Java try-with-resource
- 微信浏览器清除缓存的方法
- vector的常用方法
- redis实现分布式锁
- css元素的水平垂直居中的整理
- Md5加密算法
- Codeforces---Barnicle
- sqoop的--query工作中的实际的使用
- Jenkins+Maven+SVN自动部署配置文档