try-with-resources语句

Posted 2020-12-27 lxyit

翻译自：https://docs.oracle.com/javase/tutorial/essential/exceptions/tryResourceClose.html

try-with-resources语句是一种声明了一种或多种资源的try语句。资源是指在程序用完了之后必须要关闭的对象。try-with-resources语句保证了每个声明了的资源在语句结束的时候都会被关闭。任何实现了java.lang.AutoCloseable接口的对象，和实现了java.io.Closeable接口的对象，都可以当做资源使用。

下面的例子读取了一个文件的第一行。它使用了一个BufferedReader实例去读取文件，BufferedReader是一种资源，用完之后必须关闭。

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

在这个例子中，try-with-resources语句种声明的是BufferedReader资源。声明语句紧跟着在try关键词的圆括号里面。BufferedReader从Java SE7开始就实现了java.lang.AutoCloseable接口。因为BufferedReader声明在了try-with-resources里面，所以无论try语句是正常结束还是异常结束（比方说BufferedReader.readLine方法抛出一个IOException异常），它都会被关闭。

在Java SE7之前，你可以用finally代码块来确保资源一定被关闭，无论try语句正常结束还是异常结束。下面的例子用finally代码块代替try-with-resources语句：

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

然而，在这个例子中，如果readLine和close方法都抛出异常，那么readFirstLineFromFileWithFinallyBlock方法最终会在finally代码块抛出异常，从try代码块里面抛出的那个异常被抑制住了。相比之下，readFirstLineFromFile方法中，如果try代码块和try-with-resources语句同时抛出异常，这个方法将会最终抛出try代码块里面的异常，try-with-resources语句里面抛出的异常被压抑了。在Java SE7之后，你可以找回被压抑的异常。参看后面的“被压抑的异常”部分。

你可以在一个try-with-resources语句里面声明多个资源。下面的例子展示了从一个名字为zipFileName的zip文件中检索出里面所有文件的名称，并创建一个文本文件存储所有文件名称。

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

    java.nio.charset.Charset charset =
        java.nio.charset.StandardCharsets.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语句包含了两个用分号隔开的声明：ZipFile和BufferedWriter。当代码块中代码终止，不管是正常还是异常，BufferedWriter和ZipFile对象的close方法都会自动按声明的相反顺序调用。

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

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

例子中的资源java.sql.Statement是JDBC 4.1及其后面版本的一部分。

注意：try-with-resources语句也可以像普通的try语句一样，有catch和finally代码块。在try-with-resources语句中，任何的catch和finally代码块都在所有被声明的资源被关闭后执行。

被压抑的异常

try-with-resources语句相关联的代码块可能会抛出异常。在writeToFileZipFileContents例子中，try代码块中可能会抛出异常，并且有高达两个异常可能会在try-with-resources语句抛出，当试图去关闭ZipFile和BufferedWriter对象的时候。如果在try代码块中抛出一个异常，同时在try-with-resources语句中抛出一个或多个异常，那么在try-with-resources语句中抛出的异常就被压抑了，并且最终在writeToFileZipFileContents方法抛出的异常就是try代码块中抛出的那个异常。你可以通过被try代码块抛出的异常的Throwable.getSuppressed方法找回被压抑的异常。

实现了AutoCloseable或Closeable接口的类

看 AutoCloseable 和 Closeable 接口的javadoc，看看实现了它们的类都有哪些。Closeable接口继承了AutoCloseable接口。不同之处在于，Closeable接口的close方法抛出的是IOException异常，AutoCloseable接口的close方法抛出的是Exception异常。 因此，AutoCloseable的子类可以重写close方法的行为，抛出指定的异常，比如IOException异常，甚至可以不抛出异常。