`
san_yun
  • 浏览: 2652084 次
  • 来自: 杭州
文章分类
社区版块
存档分类
最新评论

实现一个自动关闭InputStream的类

 
阅读更多

在日志操作IO时候,经常忘记关闭输入输出流,如果能在读取结束之后自动关闭就好了,发现httpclient内部实现了一个。

/*
 * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//httpclient/src/java/org/apache/commons/httpclient/AutoCloseInputStream.java,v 1.9 2004/04/18 23:51:34 jsdever Exp $
 * $Revision: 505890 $
 * $Date: 2007-02-11 12:25:25 +0100 (Sun, 11 Feb 2007) $
 *
 * ====================================================================
 *
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */

package org.apache.commons.httpclient;

import java.io.FilterInputStream;
import java.io.IOException;
import java.io.InputStream;

/**
 * Closes an underlying stream as soon as the end of the stream is reached, and
 * notifies a client when it has done so.
 *
 * @author Ortwin Glueck
 * @author Eric Johnson
 * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
 *
 * @since 2.0
 */
class AutoCloseInputStream extends FilterInputStream {

    /** 
     * True if this stream is open.  Assume that the underlying stream 
     * is open until we get an EOF indication.
     */
    private boolean streamOpen = true;

    /** True if the stream closed itself. */
    private boolean selfClosed = false;

    /** 
     * The watcher is notified when the contents of the stream have
     * been  exhausted
     */ 
    private ResponseConsumedWatcher watcher = null;

    /**
     * Create a new auto closing stream for the provided connection
     *
     * @param in the input stream to read from
     * @param watcher   To be notified when the contents of the stream have been
     *  consumed.
     */
    public AutoCloseInputStream(
            final InputStream in, final ResponseConsumedWatcher watcher) {
        super(in);
        this.watcher = watcher;
    }

    /**
     * Reads the next byte of data from the input stream.
     *
     * @throws IOException when there is an error reading
     * @return the character read, or -1 for EOF
     */
    public int read() throws IOException {
        int l = -1;

        if (isReadAllowed()) {
            // underlying stream not closed, go ahead and read.
            l = super.read();
            checkClose(l);
        }

        return l;
    }

    /**
     * Reads up to <code>len</code> bytes of data from the stream.
     *
     * @param b a <code>byte</code> array to read data into
     * @param off an offset within the array to store data
     * @param len the maximum number of bytes to read
     * @return the number of bytes read or -1 for EOF
     * @throws IOException if there are errors reading
     */
    public int read(byte[] b, int off, int len) throws IOException {
        int l = -1;

        if (isReadAllowed()) {
            l = super.read(b,  off,  len);
            checkClose(l);
        }

        return l;
    }

    /**
     * Reads some number of bytes from the input stream and stores them into the
     * buffer array b.
     *
     * @param b a <code>byte</code> array to read data into
     * @return the number of bytes read or -1 for EOF
     * @throws IOException if there are errors reading
     */
    public int read(byte[] b) throws IOException {
        int l = -1;

        if (isReadAllowed()) {
            l = super.read(b);
            checkClose(l);
        }
        return l;
    }

    /**
     * Obtains the number of bytes that can be read without blocking.
     *
     * @return  the number of bytes available without blocking
     * @throws IOException in case of a problem
     */
    public int available() throws IOException {
        int a = 0; // not -1

        if (isReadAllowed()) {
            a = super.available();
            // no checkClose() here, available() can't trigger EOF
        }

        return a;
    }

    /**
     * Close the stream, and also close the underlying stream if it is not
     * already closed.
     * @throws IOException If an IO problem occurs.
     */
    public void close() throws IOException {
        if (!selfClosed) {
            selfClosed = true;
            notifyWatcher();
        }
    }

    /**
     * Close the underlying stream should the end of the stream arrive.
     *
     * @param readResult    The result of the read operation to check.
     * @throws IOException If an IO problem occurs.
     */
    private void checkClose(int readResult) throws IOException {
        if (readResult == -1) {
            notifyWatcher();
        }
    }

    /**
     * See whether a read of the underlying stream should be allowed, and if
     * not, check to see whether our stream has already been closed!
     *
     * @return <code>true</code> if it is still OK to read from the stream.
     * @throws IOException If an IO problem occurs.
     */
    private boolean isReadAllowed() throws IOException {
        if (!streamOpen && selfClosed) {
            throw new IOException("Attempted read on closed stream.");
        }
        return streamOpen;
    }

    /**
     * Notify the watcher that the contents have been consumed.
     * @throws IOException If an IO problem occurs.
     */
    private void notifyWatcher() throws IOException {
        if (streamOpen) {
            super.close();
            streamOpen = false;

            if (watcher != null) {
                watcher.responseConsumed();
            }
        }
    }
}

 

分享到:
评论

相关推荐

    java实现ftp自动上传文件

    同时,为了实现自动上传,可能需要定时任务或者监听文件系统变化的机制。 在提供的文件名列表中,315a3f2d6f0b4d85923fe420b59140b7可能是一个哈希值或文件路径,但没有具体的文件内容,因此无法提供进一步的分析。...

    RabbitMQ工具类实现配置文件动态创建队列和绑定

    本篇文章将重点讲解如何使用RabbitMQ结合Java实现一个工具类,动态地根据配置文件创建队列和绑定。 首先,我们需要了解RabbitMQ的基本概念。在RabbitMQ中,队列(Queue)是存储消息的地方,生产者(Producer)发送...

    Android应用自动更新功能实现的方法

    这个类通常会包含以下核心组件和方法: 1. **初始化上下文(Context)**: - 类中的`mContext`字段用于保存应用的上下文,以便进行UI操作和文件读写。 2. **定义更新提示信息和下载URL**: - `updateMsg`存储...

    SocketInputStream.rar_网络编程_Unix_Linux_

    文件"SocketInputStream.c"可能是一个示例代码,展示了如何在C语言环境下实现类似SocketInputStream的功能。尽管Java和C在处理网络编程上有不同方式,但基本原理是相似的,都是通过系统调用来进行网络通信。 总之,...

    Java实现串口通信

    Java实现串口通信是计算机编程中的一个重要领域,特别是在嵌入式系统、自动化设备以及物联网(IoT)设备的控制和数据传输中。Java虽然不是直接支持串口操作的语言,但通过一些库和API,我们可以创建应用程序来实现串口...

    android客户端自动检测更新

    这可以通过发送一个广播或者在安装完成后立即调用`finish()`关闭当前活动,然后让用户手动重启应用。另一种方法是在应用启动时检查版本信息,如果发现新版本,引导用户完成首次启动流程。 以上就是`android客户端...

    java实现模拟SSH和telnet登陆(实现命令的发送和接受)

    JSch 是一个纯 Java 实现的 SSH2 客户端,可以用来连接到 SSH 服务器,进行文件传输、命令执行等操作。下面是一个简单的 SSH 连接示例: ```java import com.jcraft.jsch.*; public class SSHConnection { public...

    POI导出Excel工具类,自动设置标题 列名 文件名,可插入图片,合并单元格

    在这个场景中,我们关注的是如何使用POI来创建一个功能丰富的Excel导出工具类,它能够自动设置标题、列名、文件名,并且支持插入图片以及合并单元格。下面将详细介绍这些功能的实现。 首先,要创建一个Excel工作簿...

    安卓wifi蓝牙相关-Android蓝牙2.0串口通信代码自动搜索自动连接.rar

    蓝牙串口模拟(RFCOMM)是蓝牙经典技术的一部分,它允许创建类似于串行端口的连接,使开发者可以轻松地在Android设备和另一个蓝牙设备之间进行双向数据传输。在Android中,通过创建一个BluetoothServerSocket监听...

    java socket server 机器人

    1. **服务器端创建**:首先,我们需要创建一个`ServerSocket`实例,指定一个端口号。这通常在`main`方法中完成,例如: ```java ServerSocket serverSocket = new ServerSocket(12345); ``` 这里的12345是服务器...

    java代码实现文件的拷贝

    最后,使用try-with-resources语句自动关闭所有的流,确保资源得到正确释放。 除了基本的字节流拷贝,还可以使用字符流,特别是当处理包含文本内容的文件时。`FileReader`和`FileWriter`是字符流的直接子类,它们...

    蓝牙自动配对连接通信

    `BluetoothDevice`类表示一个蓝牙设备。 4. **创建蓝牙Socket**:为了实现自动配对连接,通常使用`BluetoothSocket`。在Android中,有两种主要类型的Socket:`RfcommSocket`(用于SPP服务,串行端口配置文件)和`L2...

    基于Java的网络通信的设计与实现

    - **实现Runnable接口**:创建一个实现了`Runnable`接口的类,重写`run()`方法。然后通过`Thread(Runnable target)`构造函数创建线程。 - **继承Thread类**:直接继承`Thread`类并重写`run()`方法。这种方式较为...

    mysql自动备份和自动导入

    以上内容介绍了如何通过Java程序实现MySQL数据库的自动备份和自动导入功能。这种方式不仅能够提高数据安全性,还能减少人工操作带来的错误风险。需要注意的是,在实际应用中还需要考虑异常处理机制,确保程序的健壮...

    自定义view类实现展示gif

    另外,我们还添加了一个`setAutoClose()`方法,允许设置一个定时器在指定时间后自动关闭弹窗。 在实际使用`MyGifView`时,可以通过以下方式创建和配置: ```java MyGifView myGifView = new MyGifView(this); ...

    java源码包---java 源码 大量 实例

     用JAVA开发的一个小型的目录监视系统,系统会每5秒自动扫描一次需要监视的目录,可以用来监视目录中文件大小及文件增减数目的变化。 Java日期选择控件完整源代码 14个目标文件 内容索引:JAVA源码,系统相关,日历,...

    实现蓝牙传输文件源代码

    5. **发送文件**:实现文件传输功能,通常会有一个`sendFile()`方法,它接收文件路径作为参数,打开文件,然后逐块将文件内容写入`OutputStream`。为了防止阻塞,通常会在子线程中执行此操作。 6. **接收文件**:...

    安卓wifi蓝牙相关-安卓蓝牙工具类ClsUtils.rar

    "安卓wifi蓝牙相关-安卓蓝牙工具类ClsUtils.rar" 提供了一个名为 ClsUtils 的工具类,这个类可能包含了处理蓝牙功能的各种实用方法。在这个压缩包中,开发者可以找到关于如何在安卓应用中操作蓝牙的示例代码。 首先...

    androidAPP 自动更新下载

    一个完整的Android App自动更新Demo通常包括以下组件:检查更新服务、下载管理器(用于处理多任务下载)、UI界面(展示更新信息和控制下载)等。在提供的`AndroidAppUpdate`压缩包中,可能包含了这些组件的示例代码...

    Android WIFI热点 自动连接 大文件小文件传输稳定 多文件传输

    在Android平台上,开发一个能够利用WIFI热点进行自动连接,并且能稳定传输大文件和小文件,甚至支持多文件传输的应用是一项技术性较强的任务。这个应用的核心在于理解Android系统的网络编程,尤其是WiFi热点功能的...

Global site tag (gtag.js) - Google Analytics