Java try/catch/finally 获取/关闭资源时的最佳实践

Question

在做一个学校项目时，我编写了以下代码：

FileOutputStream fos;
ObjectOutputStream oos;
try {
    fos = new FileOutputStream(file);
    oos = new ObjectOutputStream(fos);

    oos.writeObject(shapes);
} catch (FileNotFoundException ex) {
    // complain to user
} catch (IOException ex) {
    // notify user
} finally {
    if (oos != null) oos.close();
    if (fos != null) fos.close();
}

问题是 Netbeans 告诉我 resource.close() 行会抛出 IOException ，因此必须被捕获或声明。它还抱怨oos 和fos 可能尚未初始化（尽管进行了空检查）。

这似乎有点奇怪，因为关键是如何将IOException 停在那里。

我的下意识的解决办法是这样做：

} finally {
    try {
        if (oos != null) oos.close();
        if (fos != null) fos.close();
    } catch (IOException ex) { }
}

但在内心深处，这让我很困扰，感觉很脏。

我来自 C# 背景，我会简单地利用 using 块，所以我不确定处理这个问题的“正确”方法是什么。

什么是处理这个问题的正确方法？

Answer 1

请注意，以下内容仅适用于 Java 6 及更早版本。对于 Java 7 及更高版本，您应该切换到使用 try-with-resources ...，如其他答案中所述。

如果您试图从源头（Java 6 或更早版本）捕获和报告所有异常，更好的解决方案是：

ObjectOutputStream oos = null;
try {
   oos = new ObjectOutputStream(new FileOutputStream(file));
   oos.writeObject(shapes);
   oos.flush();
} catch (FileNotFoundException ex) {
    // complain to user
} catch (IOException ex) {
    // notify user
} finally {
    if (oos != null) {
        try {
            oos.close();
        } catch (IOException ex) {
            // ignore ... any significant errors should already have been
            // reported via an IOException from the final flush.
        }
    }
}

注意事项：

• 标准的 Java 包装器流、读取器和写入器都将 close 和 flush 传播到其包装的流等。因此您只需关闭或刷新最外层的包装器。
• 在 try 块末尾显式刷新的目的是让 IOException 的（实际）处理程序能够看到任何写入失败¹。
• 当您对输出流执行关闭或刷新时，由于磁盘错误或文件系统已满而引发异常的可能性“千载难逢”。 你不应该压制这个例外！。

如果您经常需要“关闭一个可能为空的流而忽略 IOExceptions”，那么您可以为自己编写一个这样的辅助方法：

public void closeQuietly(Closeable closeable) {
    if (closeable != null) {
        try {
            closeable.close();
        } catch (IOException ex) {
            // ignore
        }
    }
}

那么你可以将前面的 finally 块替换为：

} finally {
    closeQuietly(oos);
}

另一个答案指出 closeQuietly 方法已经在 Apache Commons 库中可用...如果您不介意为项目添加 10 行方法的依赖项。

但请注意，您只能在 IO 异常确实无关紧要的流上使用 closeQuietly。

更新：closeQuietly 在 Apache Commons API 2.6 版中已弃用。 Java 7+ try-with-resources 让它变得多余。

---

关于人们在 cmets 中询问的 flush() 与 close() 的问题：

• 标准的“过滤器”和“缓冲”输出流和写入器有一个 API 协定，规定 close() 会导致所有缓冲输出被刷新。您应该发现执行输出缓冲的所有其他（标准）输出类的行为方式相同。因此，对于标准类，在 close() 之前立即调用 flush() 是多余的。

• 对于自定义和第 3 方类，您需要进行调查（例如阅读 javadoc，查看代码），但任何不刷新缓冲数据的 close() 方法都可能是损坏 .

• 最后，还有flush() 实际作用的问题。 javadoc 说的是这个（对于OutputStream ...）

  如果此流的预期目的地是底层操作系统提供的抽象，例如文件，则刷新流仅保证先前写入流的字节被传递给操作系统进行写入；它不能保证它们实际上被写入了物理设备，例如磁盘驱动器。

  所以...如果您希望/想象调用flush() 可以保证您的数据将持续存在，您错了！（如果您需要这样做，请查看@ 987654340@方法...)

Answer 2

Java 7 将添加 Automatic Resource Management 块。它们与 C# 的 using 非常相似。

Josh Bloch 写了the technical proposal，我强烈推荐阅读。不仅因为它可以让您在即将推出的 Java 7 语言功能上占得先机，还因为规范激发了对这种结构的需求，并且这样做说明了即使在没有 ARM 的情况下如何编写正确的代码。

这是一个 Asker 的代码示例，翻译成 ARM 形式：

try (FileOutputStream fos = new FileOutputStream(file);
        ObjectOutputStream oos = new ObjectOutputStream(fos)) 
{
    oos.writeObject(shapes);
}
catch (FileNotFoundException ex) 
{
    // handle the file not being found
}
catch (IOException ex) 
{
    // handle some I/O problem
}

Answer 3

当前涉及可关闭对象（例如文件）的 try/catch/finally 的最佳实践是使用 Java 7 的 try-with-resource 语句，例如：

try (FileReader reader = new FileReader("ex.txt")) {
    System.out.println((char)reader.read());
} catch (IOException ioe) {
    ioe.printStackTrace();
}

在这种情况下，FileReader 会在 try 语句结束时自动关闭，而无需在显式 finally 块中关闭它。这里有几个例子：

http://ppkwok.blogspot.com/2012/11/java-cafe-2-try-with-resources.html

官方Java描述在：

http://docs.oracle.com/javase/7/docs/technotes/guides/language/try-with-resources.html

Answer 4

你做得对。它也困扰着我。您应该将这些流显式初始化为 null - 这是常见的约定。你所能做的就是加入俱乐部并想要using。

Answer 5

这家伙怎么样？没有空检查，不足为奇。退出时一切都被清理干净。

try {
    final FileOutputStream fos = new FileOutputStream(file);
    try {
        final ObjectOutputStream oos = new ObjectOutputStream(fos);
        try {
            oos.writeObject(shapes);
            oos.flush();
        }
        catch(IOException ioe) {
            // notify user of important exception
        }
        finally {
            oos.close();
        }
    }
    finally {
        fos.close();
    }
}
catch (FileNotFoundException ex) {
    // complain to user
}
catch (IOException ex) {
    // notify user
}

Answer 6

我通常有小类 IOUtil，方法如下：

public static void close(Closeable c) {
    if (c != null) {
        try {
            c.close();
        }
        catch (IOException e) {
            // ignore or log
        }
    }
}

Answer 7

不是对您的观点的直接回答，但不幸的是，因为finally 和catch 都与try 相关联，人们认为它们属于同一类。 try 块的最佳设计是拥有 catch 或 finally，但不能同时拥有。

在这种情况下，您的 cmets 暗示有问题。为什么，在处理文件 IO 的方法中，我们向用户抱怨任何事情。我们可能在某个地方的服务器上运行很深，看不到任何用户。

因此，您在上面提供的代码应该有一个finally，以便在出现问题时优雅地失败。但是，它缺乏智能处理错误的能力，因此您的 catch 属于调用链中更高的位置。

Answer 8

很遗憾，没有语言级别的支持。但是有很多库可以让这变得简单。检查 commons-io 库。或现代 google-guava @http://guava-libraries.googlecode.com/svn/trunk/javadoc/index.html