从Closeable接口到更多使用方式 - Closeable详解

发布时间:2023-05-19

一、Closeable接口作用

Closeable接口是一个用来定义需要关闭资源的协议。该接口通常被IO类实现,用于确保IO使用完毕后正确关闭资源避免资源泄露。 其中,这个接口定义了一个方法:void close() throws IOException。关闭这种流会使任何以前尝试读取该流的尝试抛出IOException。 关闭Closeable接口的方法是关闭什么类型的资源都非常有效。因此,所有继承Closeable资源的类都应该实现close()方法,用以关闭它们管理的资源。

二、CloseableResponse不关闭

CloseableResponse作为Response的子类,同样是Closeable,表示需要关闭资源。但是在使用的时候,我们尤其是在OkHttp的使用中需要注意,需要关闭ResponseBody而不是CloseableResponse对象本身。 下面给出一个示例:

try (Response response = client.newCall(request).execute()) {
    // 需要手动关闭ResponseBody,而不是CloseableResponse
    ResponseBody body = response.body();
    // ... 执行相关操作 ...
    body.close();
}
catch (IOException e) { 
    // ... 异常处理 ...
}

三、CloseableResponse

CloseableResponse是OkHttp自己实现的一个Response实现。OkHttp创建的Response都是CloseableResponse的实例。同样,它需要在使用完毕后关闭资源。 示例代码如下:

try (Response response = client.newCall(request).execute()) {
    // ... 执行相关操作 ...
    // 需要手动关闭Response
    response.close();
} 
catch (IOException e) { 
    // ... 异常处理 ...
}

四、Closeable和AutoCloseable

Closeable继承了AutoCloseable接口,它也拥有与Closeable接口相同的close 方法。AutoCloseable是Java 7中引入的一个接口,它定义了一种在对象不再使用时可能需要执行的方法close。对象实现AutoCloseable接口可以使用try-with-resources块自动关闭。 try-with-resources是一个在Java 7中引入的新特性,可以自动关流。在try语句块外声明的对象,在try-with-resources块执行完毕时会自动调用close()方法关闭这些资源。 示例代码如下:

try (BufferedReader br = new BufferedReader(new FileReader(file))) {
    // ... 执行相关操作 ...
} 
catch (IOException e) { 
    // ... 异常处理 ...
}

五、Close, Closed, Closely, Close to, Clean

  • Close: 关闭的意思。在编程中,应用close()方法关闭流等资源。
  • Closed: 关闭的状态。close之后产生的状态。
  • Closely: 紧密地,也可以表达严密的意思。例如,Closeable和资源管理器之间的联系就是非常紧密的。
  • Close to: 离…很近。例如,错误处理应该在try语句块内部而不是close语句块内部。
  • Clean: 清理,清除掉和资源相关的状态。例如,在try-with-resources中关闭资源。

六、代码示例

示例代码如下:

public class Example implements Closeable {
    private final InputStream stream;
    public Example(InputStream stream) {
        this.stream = stream;
    }
    @Override
    public void close() throws IOException {
        stream.close();
    }
    public static void main(String[] args) {
        try (Example example = new Example(new FileInputStream("example.txt"))) {
            int data = example.stream.read();
            while (data != -1) {
                System.out.print((char) data);
                data = example.stream.read();
            }
        } 
        catch (IOException e) { 
            // ... 异常处理 ...
        }
    }
}

该示例代码演示了如何使用Closeable接口和try-with-resources来关闭一个文件输入流,并打印输出到控制台。

七、总结

本篇文章围绕Closeable接口展开,从它的作用,使用细节,到AutoCloseable的使用,以及衍生的一些相关术语进行了详细的讲解。希望本文能将Closeable接口的概念及其使用方式介绍的更清晰明了。同时,建议在实际开发中慎重对待资源关闭的问题,及时关闭资源以免产生意外问题。