Java try-with-resource语法使用解析
背景
众所周知，所有被打开的系统资源，比如流、文件或者Socket连接等，都需要被开发者手动关闭，否则随着程序的不断运行，资源泄露将会累积成重大的生产事故。
在Java的江湖中，存在着一种名为finally的功夫，它可以保证当你习武走火入魔之时，还可以做一些自救的操作。在远古时代，处理资源关闭的代码通常写在finally块中。然而，如果你同时打开了多个资源，那么将会出现噩梦般的场景：
publicclassDemo{
publicstaticvoidmain(String[]args){
BufferedInputStreambin=null;
BufferedOutputStreambout=null;
try{
bin=newBufferedInputStream(newFileInputStream(newFile("test.txt")));
bout=newBufferedOutputStream(newFileOutputStream(newFile("out.txt")));
intb;
while((b=bin.read())!=-1){
bout.write(b);
}
}
catch(IOExceptione){
e.printStackTrace();
}
finally{
if(bin!=null){
try{
bin.close();
}
catch(IOExceptione){
e.printStackTrace();
}
finally{
if(bout!=null){
try{
bout.close();
}
catch(IOExceptione){
e.printStackTrace();
}
}
}
}
}
}
}
OhMyGod！！！关闭资源的代码竟然比业务代码还要多！！！这是因为，我们不仅需要关闭BufferedInputStream，还需要保证如果关闭BufferedInputStream时出现了异常，BufferedOutputStream也要能被正确地关闭。所以我们不得不借助finally中嵌套finally大法。可以想到，打开的资源越多，finally中嵌套的将会越深！！！
更为可恶的是，Python程序员面对这个问题，竟然微微一笑很倾城地说：“这个我们一点都不用考虑的嘞~”：
但是兄弟莫慌！我们可以利用Java1.7中新增的try-with-resource语法糖来打开资源，而无需码农们自己书写资源来关闭代码。妈妈再也不用担心我把手写断掉了！我们用try-with-resource来改写刚才的例子：
publicclassTryWithResource{
publicstaticvoidmain(String[]args){
try(BufferedInputStreambin=newBufferedInputStream(newFileInputStream(newFile("test.txt")));
BufferedOutputStreambout=newBufferedOutputStream(newFileOutputStream(newFile("out.txt")))){
intb;
while((b=bin.read())!=-1){
bout.write(b);
}
}
catch(IOExceptione){
e.printStackTrace();
}
}
}
是不是很简单？是不是很刺激？再也不用被Python程序员鄙视了！好了，下面将会详细讲解其实现原理以及内部机制。
动手实践
为了能够配合try-with-resource，资源必须实现AutoClosable接口。该接口的实现类需要重写close方法：
publicclassConnectionimplementsAutoCloseable{
publicvoidsendData(){
System.out.println("正在发送数据");
}
@Override
publicvoidclose()throwsException{
System.out.println("正在关闭连接");
}
}
调用类：
publicclassTryWithResource{
publicstaticvoidmain(String[]args){
try(Connectionconn=newConnection()){
conn.sendData();
}
catch(Exceptione){
e.printStackTrace();
}
}
}
运行后输出结果：
正在发送数据
正在关闭连接
通过结果我们可以看到，close方法被自动调用了。
原理
那么这个是怎么做到的呢？我相信聪明的你们一定已经猜到了，其实，这一切都是编译器大神搞的鬼。我们反编译刚才例子的class文件：
publicclassTryWithResource{
publicTryWithResource(){
}
publicstaticvoidmain(String[]args){
try{
Connectione=newConnection();
Throwablevar2=null;
try{
e.sendData();
}catch(Throwablevar12){
var2=var12;
throwvar12;
}finally{
if(e!=null){
if(var2!=null){
try{
e.close();
}catch(Throwablevar11){
var2.addSuppressed(var11);
}
}else{
e.close();
}
}
}
}catch(Exceptionvar14){
var14.printStackTrace();
}
}
}
看到没，在第15~27行，编译器自动帮我们生成了finally块，并且在里面调用了资源的close方法，所以例子中的close方法会在运行的时候被执行。
异常屏蔽
我相信，细心的你们肯定又发现了，刚才反编译的代码（第21行）比远古时代写的代码多了一个addSuppressed。为了了解这段代码的用意，我们稍微修改一下刚才的例子：我们将刚才的代码改回远古时代手动关闭异常的方式，并且在sendData和close方法中抛出异常：
publicclassConnectionimplementsAutoCloseable{
publicvoidsendData()throwsException{
thrownewException("senddata");
}
@Override
publicvoidclose()throwsException{
thrownewMyException("close");
}
}
修改main方法：
publicclassTryWithResource{
publicstaticvoidmain(String[]args){
try{
test();
}
catch(Exceptione){
e.printStackTrace();
}
}
privatestaticvoidtest()throwsException{
Connectionconn=null;
try{
conn=newConnection();
conn.sendData();
}
finally{
if(conn!=null){
conn.close();
}
}
}
}
运行之后我们发现：
basic.exception.MyException:close
atbasic.exception.Connection.close(Connection.java:10)
atbasic.exception.TryWithResource.test(TryWithResource.java:82)
atbasic.exception.TryWithResource.main(TryWithResource.java:7)
......
好的，问题来了，由于我们一次只能抛出一个异常，所以在最上层看到的是最后一个抛出的异常——也就是close方法抛出的MyException，而sendData抛出的Exception被忽略了。这就是所谓的异常屏蔽。由于异常信息的丢失，异常屏蔽可能会导致某些bug变得极其难以发现，程序员们不得不加班加点地找bug，如此毒瘤，怎能不除！幸好，为了解决这个问题，从Java1.7开始，大佬们为Throwable类新增了addSuppressed方法，支持将一个异常附加到另一个异常身上，从而避免异常屏蔽。那么被屏蔽的异常信息会通过怎样的格式输出呢？我们再运行一遍刚才用try-with-resource包裹的main方法：
java.lang.Exception:senddata atbasic.exception.Connection.sendData(Connection.java:5) atbasic.exception.TryWithResource.main(TryWithResource.java:14) ...... Suppressed:basic.exception.MyException:close atbasic.exception.Connection.close(Connection.java:10) atbasic.exception.TryWithResource.main(TryWithResource.java:15) ...5more
可以看到，异常信息中多了一个Suppressed的提示，告诉我们这个异常其实由两个异常组成，MyException是被Suppressed的异常。可喜可贺！
一个小问题
在使用try-with-resource的过程中，一定需要了解资源的close方法内部的实现逻辑。否则还是可能会导致资源泄露。
举个例子，在JavaBIO中采用了大量的装饰器模式。当调用装饰器的close方法时，本质上是调用了装饰器内部包裹的流的close方法。比如：
publicclassTryWithResource{
publicstaticvoidmain(String[]args){
try(FileInputStreamfin=newFileInputStream(newFile("input.txt"));
GZIPOutputStreamout=newGZIPOutputStream(newFileOutputStream(newFile("out.txt")))){
byte[]buffer=newbyte[4096];
intread;
while((read=fin.read(buffer))!=-1){
out.write(buffer,0,read);
}
}
catch(IOExceptione){
e.printStackTrace();
}
}
}
在上述代码中，我们从FileInputStream中读取字节，并且写入到GZIPOutputStream中。GZIPOutputStream实际上是FileOutputStream的装饰器。由于try-with-resource的特性，实际编译之后的代码会在后面带上finally代码块，并且在里面调用fin.close()方法和out.close()方法。我们再来看GZIPOutputStream类的close方法：
publicvoidclose()throwsIOException{
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：
publicclassTryWithResource{
publicstaticvoidmain(String[]args){
try(FileInputStreamfin=newFileInputStream(newFile("input.txt"));
FileOutputStreamfout=newFileOutputStream(newFile("out.txt"));
GZIPOutputStreamout=newGZIPOutputStream(fout)){
byte[]buffer=newbyte[4096];
intread;
while((read=fin.read(buffer))!=-1){
out.write(buffer,0,read);
}
}
catch(IOExceptione){
e.printStackTrace();
}
}
}
由于编译器会自动生成fout.close()的代码，这样肯定能够保证真正的流被关闭。
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持毛票票。