足智多谋的

时间:2019-10-08 20:13来源:编程技术
当通过 Java实现业务实例时,对资源进行处理是司空见惯的。一般情况下,资源(如文件或socket句柄)封装在对象中,使用后必须关闭才能释放资源。通常开发人员有责任关闭自己所创

当通过 Java 实现业务实例时,对资源进行处理是司空见惯的。一般情况下,资源(如文件或 socket 句柄)封装在对象中,使用后必须关闭才能释放资源。通常开发人员有责任关闭自己所创建的资源,以避免资源冲突,一般都会放在 finally 语句块中处理。不这样做其实也不会产生编译错误,但很容易导致资源泄露。虽然现在静态代码检查工具足够聪明,也可以做出提示。但不是每个人都使用工具,而且这些警告也容易被忽略。

try-with-resources语句是一个声明一个或多个资源的 try 语句。一个资源作为一个对象,必须在程序结束之后随之关闭。 try-with-resources语句确保在语句的最后每个资源都被关闭 。任何实现了 java.lang.AutoCloseable的对象, 包括所有实现了 java.io.Closeable 的对象, 都可以用作一个资源。
 下面的例子读取文件的第一行。它使用了 BufferedReader 的一个实例来读取文件中的数据。BufferedReader是一个资源,它必须在程序结束之后随之关闭:

Java 7 中首次引入了一种新的处理资源的方式——try-with-resources。它使得在 try-catch 语句块中的资源能按照正确顺序自动关闭,更加容易地处理资源。

static String readFirstLineFromFile(String path) throws IOException {
      try (BufferedReader br = new BufferedReader(new FileReader(path))) {
        return br.readLine();
    }
}

我们来一起看一个业务实例的实现,其需要从数据库中获取指定账户的状态码。首先可以看到它是如何以传统方式实现,紧接着是足智多谋的 try-with-resources 如何实现。最后,还将看到 Java 9 引入的更加简洁的版本。

 在这个例子中,try-with-resources语句声明的资源是一个 BufferedReader。声明语句在紧跟在 try 关键字的括号里面。Java SE 7以及后续版本中,BufferedReader类实现了java.lang.AutoCloseable接口。 因为 BufferedReader实例是在 try-with-resource 语句中声明的, 所以不管 try 语句正常地完成或是 发生意外 (结果就是 BufferedReader.readLine 方法抛出IOException),BufferedReader都将会关闭。

传统的方式处理资源(Java 7 之前)

 在 Java SE 7之前, 可以使用 finally 块来确保资源被关闭,不管 try 语句正常地完成或是发生意外。下面的例子使用 finally 块替换 try-with-resources 语句:

// 代码已简化,只保留跟眼下话题相关的内容。

public static int getAccountStatusCodeFromDataStore_traditional(String accountId) throws SQLException {

String accountStatusCodeQuery = getAccountStatusCodeQuery(accountId);

Statement statement = null;

ResultSet resultSet = null;

try {

statement = createStatementFromConnection();

resultSet = statement.executeQuery(accountStatusCodeQuery);

return getAccountStatusCodeFromResultSet(resultSet);

} finally {

if (resultSet != null)

resultSet.close();

if (statement != null)

statement.close();

}

}

static String readFirstLineFromFileWithFinallyBlock(String path) throws IOException {
      BufferedReader br = new BufferedReader(new FileReader(path));
      try {
        return br.readLine();
      } finally {
        if (br != null) br.close();
      }
    }

如上所示,我们必须增加 finally 语句块来处理资源关闭。在调用 close 方法之前,须显示地检查 null 值,并且同时要保证关闭资源的逻辑顺序。代码不但变得冗长,而且我们曾经遇到过许多开发人员会忘记编写 finally 语句块来关闭资源,导致资源泄露的情况。

 然而,在这个例子中,如果 readLine 和 close 方法均抛出异常,那么 readFirstLineFromFileWithFinallyBlock 方法将抛出从 finally 块中抛出的异常; try 块中抛出的异常被抑制了。与此相反, 在 readFirstLineFromFile 这个例子中, 如果 try 块和 try-with-resources 语句均抛出异常, 那么 readFirstLineFromFile 将抛出从 try 块中抛出的异常; try-with-resources 块抛出的异常被抑制了。在Java SE 7 以及后续的版本中, 你可以检索被抑制的异常;详情参见 Suppressed Exceptions。

顺便提一下,假如 try 和 finally 语句块都抛出异常,finally 语句块抛出的异常会屏蔽对方。

 可以在一个 try-with-resources 语句中声明一个或多个资源。下面的例子检索zip文件 zipFileName 中所有文件的名称并创建一个包含那些文件名称的文本文件:

Java 7/8 中通过 try-with-resources 处理资源

    public static void writeToFileZipFileContents(String zipFileName, String outputFileName)
      throws java.io.IOException {

      java.nio.charset.Charset charset = java.nio.charset.Charset.forName("US-ASCII");
      java.nio.file.Path outputFilePath = java.nio.file.Paths.get(outputFileName);

      // Open zip file and create output file with try-with-resources statement

      try (
        java.util.zip.ZipFile zf = new java.util.zip.ZipFile(zipFileName);
        java.io.BufferedWriter writer = java.nio.file.Files.newBufferedWriter(outputFilePath, charset)
      ) {

        // Enumerate each entry

        for (java.util.Enumeration entries = zf.entries(); entries.hasMoreElements();) {

          // Get the entry name and write it to the output file

          String newLine = System.getProperty("line.separator");
          String zipEntryName = ((java.util.zip.ZipEntry)entries.nextElement()).getName() + newLine;
          writer.write(zipEntryName, 0, zipEntryName.length());
        }
      }
    }

现通过 try-with-resources 实现与上面相同的代码块,如下所示:

 在这个例子中, try-with-resources 语句包含两个由分号隔开的声明: ZipFile 和 BufferedWriter。当代码块直接伴随着它正常地或由于一个异常终止时, BufferedWriter 和 ZipFile 对象的 close 方法以这种顺序自动地调用 。注意:资源的 close 方法调用顺序与它们的创建顺序相反。

// 代码已简化,只保留跟眼下话题相关的内容。

public static int getAccountStatusCodeFromDataStore_tryWithResourcesJava7(String accountId) throws SQLException {

String accountStatusCodeQuery = getAccountStatusCodeQuery(accountId);

try (Statement statement = createStatementFromConnection();

ResultSet resultSet = statement.executeQuery(accountStatusCodeQuery)) {

return getAccountStatusCodeFromResultSet(resultSet);

}

}

 下面的例子使用一个 try-with-resources 语句来自动关闭一个 java.sql.Statement 对象:

在本例中可以看到简洁的代码有助于提高整体可读性,资源管理也自动完成。try-with-resources 语句中可以包含多个资源,它们之间应通过分号隔开。资源会在保持逻辑顺序的前提下自动关闭(最后声明的将第一个关闭)。

    public static void viewTable(Connection con) throws SQLException {

      String query = "select COF_NAME, SUP_ID, PRICE, SALES, TOTAL from COFFEES";

      try (Statement stmt = con.createStatement()) {

        ResultSet rs = stmt.executeQuery(query);

        while (rs.next()) {
          String coffeeName = rs.getString("COF_NAME");
          int supplierID = rs.getInt("SUP_ID");
          float price = rs.getFloat("PRICE");
          int sales = rs.getInt("SALES");
          int total = rs.getInt("TOTAL");
          System.out.println(coffeeName + ", " + supplierID + ", " + price +
                           ", " + sales + ", " + total);
        }

      } catch (SQLException e) {
        JDBCTutorialUtilities.printSQLException(e);
      }
    }

如果在 try-with-resources 和 try 语句块中抛出异常,从 try 中抛出的异常将会屏蔽对方。假如有需要,可从 try 语句块抛出的异常中,通过调用 Throwable.getSuppressed 方法找回屏蔽的异常。

 这个例子中使用的 java.sql.Statement 这个资源是JDBC 4.1以及后续版本API的一部分。

try-with-resources 语句中也可以写 catch 和 finally 语句块。任何 catch 和 finally 语句块会在声明的资源关闭后运行。

 注意: 一个 try-with-resources 语句可以像普通的 try 语句那样有 catch 和 finally 块。在try-with-resources 语句中, 任意的 catch 或者 finally 块都是在声明的资源被关闭以后才运行。
被抑制的异常

Java 9 中通过 try-with-resources 处理资源

 与 try-with-resources 语句关联的代码块可能会抛出异常。在 writeToFileZipFileContents这个例子中, 当试图关闭 ZipFile 和 BufferedWriter 对象时,try 块可能会抛出一个异常,并且 try-with-resources 语句可能抛出多达两个异常 。如果 try 块抛出异常并且 try-with-resources 语句抛出一个或多个异常,那么从 try-with-resources 语句中抛出的异常将会被抑制, 并且块抛出的异常是由 writeToFileZipFileContents 方法抛出的那一个。你可以通过调用由 try块抛出的异常的Throwable.getSuppressed 方法检索这些被抑制的异常信息。
实现了AutoCloseable 或 Closeable 接口的类

Java 9 中引入了更加简练的版本。如果已经把资源声明为 final 或 effective final,则在 try-with-resources 中无需创建任何新的变量,可直接使用。这使得能够利用自动资源管理。现通过更简洁的 try-with-resources 语句来实现与上面相同的代码块,如下所示:

 参见 AutoCloseable 和 Closeable 接口的Javadoc可以看到实现了两者当中的任何一个接口的类集。Closeable 接口继承了 AutoCloseable 接口。 Closeable接口的 close 方法抛出IOException 类型的异常而 AutoCloseable 接口的 close 方法抛出 Exception 类型的异常。因此, subclasses of the AutoCloseable 接口的子类可以重写 close 方法的这个行为来抛出指定的异常,例如 IOException, 或者没有异常。

// 代码已简化,只保留跟眼下话题相关的内容。

public static int getAccountStatusCodeFromDataStore_tryWithResourcesJava9(String accountId) throws SQLException {

String accountStatusCodeQuery = getAccountStatusCodeQuery(accountId);

// 显示地声明 final

final Statement statement = createStatementFromConnection();

// effective final

ResultSet resultSet = statement.executeQuery(accountStatusCodeQuery);

try (statement; resultSet) {

return getAccountStatusCodeFromResultSet(resultSet);

}

}

幕后如何运行

Java 7 引入了专门设计用于 try-with-resources 语句的 AutoCloseable 接口。Java 5 引入的 Closeable 接口也修改为继承 AutoCloseable 接口。这两个接口都拥有抽象的 close 方法,资源应该实现它并提供有效的方法。任何实现 AutoCloseable 和 Closeable 接口的资源都可以通过 try-with-resources 来关闭。所有基于 JDK 资源的类和接口都已修改成继承这两个接口其中之一,使之能与现有的 try-with-resources 语句兼容。

然而,若处理的资源没有实现 AutoCloseable 或 Closeable 接口,则必须使用传统的方法来关闭。

关键要点

try-with-resources 有助于自动资源管理,不需要编写显示的 finally 语句块来处理关闭资源。下面是对 try-with-resources 关键点的总结:

有助于实现简练清晰的代码。

可以在 try-with-resources 语句中同时处理多个资源。

在 Java 7/8 ,try-with-resources 语句中必须声明要关闭的资源。通过这种方式声明的资源属于隐式 final。

Java 9 中甚至能使用预先创建的资源,只要所引用的资源声明为 final 或者是 effective final。

在幕后施展魔法的是 AutoCloseable 或者 Closeable 接口,它们与 try-with-resources 语句协同工作。

JDK 中大多数基于资源的类和接口已修改成实现 AutoCloseable 或 Closeable 接口,使它们能与现有的 try-with-resources 兼容。

可以使自定义的资源实现 AutoCloseable 或 Closeable 接口,以便能够在 try-with-resources 语句中使用。

欢迎工作一到五年的Java工程师朋友们加入Java架构开发: 854393687

群内提供免费的Java架构学习资料(里面有高可用、高并发、高性能及分布式、Jvm性能调优、Spring源码,MyBatis,Netty,Redis,Kafka,Mysql,Zookeeper,Tomcat,Docker,Dubbo,Nginx等多个知识点的架构资料)合理利用自己每一分每一秒的时间来学习提升自己,不要再用"没有时间“来掩饰自己思想上的懒惰!趁年轻,使劲拼,给未来的自己一个交代!

编辑:编程技术 本文来源:足智多谋的

关键词: