深入理解Java try-with-resource

文章来源:http://www.kissyu.org/2016/10/06/深入理解Java%20try-with-resource/

作者:Young


子曾经曰过:所有的炒冷饭都是温故而知新。


背景


众所周知,所有被打开的系统资源,比如流、文件或者Socket连接等,都需要被开发者手动关闭,否则随着程序的不断运行,资源泄露将会累积成重大的生产事故。

在Java的江湖中,存在着一种名为finally的功夫,它可以保证当你习武走火入魔之时,还可以做一些自救的操作。在远古时代,处理资源关闭的代码通常写在finally块中。然而,如果你同时打开了多个资源,那么将会出现噩梦般的场景:


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来改写刚才的例子:


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方法:


public class Connection implements AutoCloseable {

    public void sendData() {

        System.out.println("正在发送数据");

    }

    @Override

    public void close() throws Exception {

        System.out.println("正在关闭连接");

    }

}


调用类:

public class TryWithResource {

    public static void main(String[] args) {

        try (Connection conn = new Connection()) {

            conn.sendData();

        }

        catch (Exception e) {

            e.printStackTrace();

        }

    }

}

运行后输出结果:

  1. 正在发送数据

  2. 正在关闭连接

通过结果我们可以看到,close方法被自动调用了。


原理

那么这个是怎么做到的呢?我相信聪明的你们一定已经猜到了,其实,这一切都是编译器大神搞的鬼。我们反编译刚才例子的class文件:


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。为了了解这段代码的用意,我们稍微修改一下刚才的例子:我们将刚才的代码改回远古时代手动关闭异常的方式,并且在sendDataclose方法中抛出异常:

public class Connection implements AutoCloseable {

    public void sendData() throws Exception {

        throw new Exception("send data");

    }

    @Override

    public void close() throws Exception {

        throw new MyException("close");

    }

}


修改main方法:


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();

            }

        }

    }

}


运行之后我们发现:

basic.exception.MyException: close

at 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方法:


java.lang.Exception: send data

at basic.exception.Connection.sendData(Connection.java:5)

at basic.exception.TryWithResource.main(TryWithResource.java:14)

......

Suppressed: basic.exception.MyException: close

at 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方法。比如:


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方法:


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


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()的代码,这样肯定能够保证真正的流被关闭。


总结

怎么样,是不是很简单呢,如果学会了话



点击阅读原文,查看更多干货内容!


阅读原文:http://dreawer.blog.163.com/blog/static/26163604820169146253280/
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,688评论 1 330
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,559评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,749评论 0 226
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,581评论 0 191
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,741评论 3 271
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,684评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,122评论 2 292
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,847评论 0 182
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,441评论 0 228
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,939评论 2 232
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,333评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,783评论 2 236
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,275评论 3 220
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,830评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,444评论 0 180
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,553评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,618评论 2 249

推荐阅读更多精彩内容

  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,275评论 18 399
  • 一. Java基础部分.................................................
    wy_sure阅读 3,724评论 0 11
  • (一)Java部分 1、列举出JAVA中6个比较常用的包【天威诚信面试题】 【参考答案】 java.lang;ja...
    独云阅读 6,898评论 0 62
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,050评论 18 139
  • 海尼曼10本,牛津树5本
    韦钰阅读 156评论 0 0