关闭作为方法返回的资源

Question

我有一个带有返回流的静态方法的辅助类：

public static InputStream getDocument(File file) throws IOException {
    ZipFile zipFile = new ZipFile(file);
    return zipFile.getInputStream(zipFile.getEntry("entry"));
}

另一个类访问该方法并使用返回的流：

InputStream is = MyClass.getDocument(new File(str));

我的代码有效。

---

但是，according to the Java Documentation, 我应该关闭我的资源：

资源是程序完成后必须关闭的对象。 try-with-resources 语句确保每个资源在语句结束时关闭。

但是，当我实现try-with-resources:

public static InputStream getDocument(File file) throws IOException {
    try (ZipFile zipFile = new ZipFile(file);) {
        return zipFile.getInputStream(zipFile.getEntry("entry"));
    }
}

或try-finally:

public static InputStream getDocument(File file) throws IOException {
    InputStream is = null;
    try {
        ZipFile zipFile = new ZipFile(docx);
        is = zipFile.getInputStream(zipFile.getEntry("entry"));
        return is;
    } finally {
        is.close();
    }
}

我得到一个例外：

java.io.IOException: Stream closed

---

如何确保该资源将在使用后被关闭？

Answer 1

通常调用者负责关闭/释放资源。
您可以在方法外部使用 try-with-resource 或 try-finally 构造，如下所示：

try (InputStream is = getDocument(aFile) {
    //… do your stuff
}

如果我能给你一个建议，请写在方法文档中：

/**
  * The caller is required to close the returned {@link InputStream}
  */
public static InputStream getDocument(File file) throws IOException

Answer 2

try-with-resources 与您使用finally 的第二种方法隐含相同。没有办法关闭 zipFile，而是根据这个 zipFile 返回一个 inputStream。

通常最好避免使用这种辅助方法并使用具有多个资源的单个 try-with-resourcerces：

try (
   ZipFile zipFile = new ZipFile(file);
   inputStream inputStream = zipFile.getInputStream(zipFile.getEntry("entry"));
) {
    // Do stuff
} // Both zipFile and inputStream closed here implicitly

如果您需要创建这样的方法，但是您可以确保当流关闭时，zipFile 对象也被关闭。

来自相关问题Does a ZipEntry persist after a ZipFile is closed?

zipFile = new ZipFile(file);
InputStream zipInputStream = ...
return new InputStream() {
    @Override
    public int read() throws IOException {
        return zipInputStream.read();
    }
    @Override
    public void close() throws IOException {
        // Better add try/catch around each close()
        zipInputStream.close();
        zipFile.close();
    }
}

这样，当调用方法关闭它接收到的流时，压缩文件也将被关闭。