Java 中的自动化资源管理

  • Alex Blewitt
  • 张龙

2010 年 8 月 25 日

话题:Java编程语言语言 & 开发文化 & 方法

Project Coin的一个突出特点就是具备了自动化资源管理(即 ARM)能力。其目的在于当遇到错误或是成功执行完代码块后能够轻松处理好外部资源。其最初实现位于 OpenJDK 中。考虑如下繁琐的文件拷贝操作,代码来自于Java Bytestream 教程

 
FileInputStream in = null;
FileOutputStream out = null;
try {
  in = new FileInputStream("xanadu.txt");
  out = new FileOutputStream("outagain.txt");
  int c;
  while ((c = in.read()) != -1)
    out.write(c);
} finally {
  if (in != null)
    in.close();
  if (out != null)
    out.close();
}

上面不仅有大量的样版代码,而且InputStream.close()的文档表明它会抛出 IOException(OutputStream 也存在类似的异常,无论何种情况,要想成功编译这些代码,要么在外面加上 catch 块,要么将异常继续往外抛)。

try-catch-finally 块的语义范围还要求变量 FileInputStream in 与 FileOutputStream out 声明在块的外面(如果定义在 try 块内,那么 catch 块与 finally 块就访问不到了)。

为了减少上面这些样版代码并且收紧块中所用的资源范围,Java 语言在 try 块中新增了一些内容。最初的 try-with-resources 块(或者叫做 ARM 块)规范已经拥有实现了,随后该规范被纳入到 JDK 7 build 105中。

新的接口 java.lang.AutoCloseable 被加到了提案 API中,它只定义了一个会抛出 Exception 的方法 close()。该接口是java.io.Closeable的父接口,这意味着所有的 InputStream 与 OutputStream 都会自动享受到该行为所带来的好处。此外,FileLock 与 ImageInputStream 也实现了 AutoCloseable 接口。

这样,上面的代码就可以这样来写:

 
try (
  FileInputStream in = new FileInputStream("xanadu.txt");
  FileOutputStream out = new FileOutputStream("outagain.txt")
) {
  int c;
  while((c=in.read()) != -1 )
    out.write();
}

在 try 块的末尾,无论是正常结束还是抛出了异常,out 与 in 资源都会自动调用 close() 方法。此外,与之前示例不同的是 out.close() 与 in.close() 保证会执行(在之前的示例中,一旦 in.close() 方法抛出了异常,随后的 out.close() 方法就没有机会执行了)。

关于这种方式,还有一些微妙之处值得我们注意:

  • 如上代码所示,在资源部分中,最后一个资源后面是不允许使用分号的。
  • 资源块使用 () 分隔,而不是常见的{},以此将其与现有的 try 块分隔开来。如果存在资源块,那么里面必须要包含一个或多个资源定义语句。
  • 每个资源定义具有如下形式:type var = expression; 在资源块中不能使用通常的语句。
  • 资源都是隐式 final 的,也就是说即便没有使用 final,这些资源也都是 final 的。如果尝试为资源变量赋值会得到一个编译期错误。
  • 资源必须是 AutoCloseable 的子类型,如果不是的话会得到一个编译期错误。
  • 资源关闭的顺序与定义的顺序正好相反。换句话说,在上面的代码示例中,out.close() 要先于 in.close() 得到调用。这么做可以构建嵌套的流,然后从外向内关闭流,这要比按顺序关闭更好(也就是说,可以在底层的流关闭前先清空缓存)。
  • 每个块可以生成 n+1 个异常,n 是资源的数量。这出现在代码主体抛出了异常,然后每个资源关闭语句也都抛出异常的情况下。在这种情况下,代码主体的异常将被抛出,但其他的异常将会被添加到异常的抑制列表(suppressed exception list)中。可以通过getSuppressedExceptions()方法访问这些异常信息。
  • 异常堆栈追踪信息可以带有 Suppressed 前缀:在这些情况下,序列化的 Throwable 格式也有所不同(如果 Java 6 客户端调用了远程 Java 7 运行时中的服务会出现这个问题,反之亦然)。
  • javax.swing 与 java.sql 目前并不会加入到 ARM 中;类需要继承 AutoCloseable 才能为 ARM 所用。JDBC 4.1 如果能够成为 JDK 7 的一部分,那么它也将支持 ARM,但具体时间尚未确定。

能够移除 Java 开发者每天都要编写的样版代码对生产力的提升是个促进,虽然 JDK 7 具备了这种能力,但有时需要在编写代码前利用这种能力。很多库都需要重新编译以适应 Java 6 的需要,无论何时,只要使用了自动化资源管理,那么它就只能用于使用 -target 7 编译的代码。等到 Java 6 寿终正寝,并且 Java 8 发布后,使用 ARM 就会成为自然而然的事情了。

查看英文原文:Automatic Resource Management in Java

Java编程语言语言 & 开发文化 & 方法