【Java原理系列】 Java PipedInputStream 原理用法源码分析

原创

已于 2023-12-24 09:07:58 修改 · 908 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#java

于 2023-09-11 22:40:01 首次发布

本文详细解析了JavaPipedInputStream的工作原理，介绍了其如何与PipedOutputStream配合进行线程间管道通信，以及如何使用示例代码。重点讨论了其内部结构、状态维护和主要方法，如连接、读取和接收数据等。

Java PipedInputStream 原理用法源码分析

原理

PipedInputStream 是 Java 中的一个输入流实现类，它主要用于与 PipedOutputStream 配合使用，在两个线程之间进行管道通信。

PipedInputStream 的原理如下：

PipedInputStream 内部维护了一个环形缓冲区，用于接收从 PipedOutputStream 写入的数据。
当 PipedOutputStream 写入数据时，PipedInputStream 会从缓冲区中读取数据。
如果 PipedOutputStream 写入速度过快导致缓冲区满了，PipedInputStream 将阻塞等待缓冲区中有可读取的数据。

用法示例

以下是一个简单的 PipedInputStream 的用法示例：

import java.io.*;

public class PipedStreamExample {
   
   
    public static void main(String[] args) throws IOException {
   
   
        PipedInputStream inputStream = new PipedInputStream();
        PipedOutputStream outputStream = new PipedOutputStream();

        // 将输入流和输出流连接起来
        inputStream.connect(outputStream);

        // 创建写入线程和读取线程，并启动
        Thread writerThread = new Thread(() -> {
   
   
            try {
   
   
                outputStream.write("Hello, World!".getBytes());
                outputStream.close();
            } catch (IOException e) {
   
   
                e.printStackTrace();
            }
        });

        Thread readerThread = new Thread(() -> {
   
   
            try {
   
   
                int byteValue;
                while ((byteValue = inputStream.read()) != -1) {
   
   
                    System.out.print((char) byteValue);
                }
                inputStream.close();
            } catch (IOException e) {
   
   
                e.printStackTrace();
            }
        });

        writerThread.start();
        readerThread.start();
    }
}

在上述示例中，我们创建了一个 PipedInputStream 对象 inputStream 和一个 PipedOutputStream 对象 outputStream。然后，通过调用 connect() 方法将它们连接起来，使数据从 outputStream 写入 inputStream 进行读取。

接下来，我们创建了一个写入线程 writerThread 和一个读取线程 readerThread。在写入线程中，我们使用 write() 方法将字符串 “Hello, World!” 写入 outputStream，并关闭流。在读取线程中，我们使用 read() 方法从 inputStream 中逐个字节地读取数据，并将其转换为字符进行打印。

最后，我们启动写入线程和读取线程，观察控制台输出结果。

通过使用 PipedInputStream 和 PipedOutputStream，我们可以实现多线程之间的管道通信，方便数据的传输和处理。需要注意的是，在使用完毕后，应及时关闭流以释放资源。

方法总结

PipedInputStream 是 Java I/O 库中的一个类，它继承自 InputStream 抽象类。该类实现了一个与 PipedOutputStream 相连接的管道输入流，即将一个 PipedOutputStream 写入的字节数据作为输入。

该类的主要特点和方法如下：

状态变量：closedByWriter、closedByReader、connected 用于维护流的状态和信息。
读写线程：readSide、writeSide 分别表示读取和写入线程。
缓冲区：buffer 是一个字节数组缓冲区，用于存储接收到的字节数据。
索引指针：in 表示下一个要存储的字节在缓冲区中的位置，out 表示下一个要读取的字节在缓冲区中的位置。

主要方法如下：

connect(PipedOutputStream src)：将此 PipedInputStream 连接到指定的 PipedOutputStream。如果已经连接到其他的 PipedOutputStream，则抛出异常。
receive(int b)：接收一个字节的数据，并存储到缓冲区中。
receive(byte b[], int off, int len)：接收数据到字节数组中，并存储到缓冲区中。
checkStateForReceive()：检查接收数据的状态，包括连接状态、关闭状态和写入方线程状态。
awaitSpace()：等待可用的空间，即等待缓冲区有空闲位置。
receivedLast()：通知所有等待的线程数据已经接收完毕。
read()：从输入流中读取下一个字节的数据。如果没有可用的数据，该方法将阻塞。
read(byte b[], int off, int len)：从输入流中最多读取 len 个字节的数据，并将其写入到字节数组 b 中。
available()：返回此输入流中可读取的字节数，而不会阻塞。
close()：关闭输入流。

此外，PipedInputStream 还提供了构造函数用于初始化管道和缓冲区。在使用前，需要先通过 connect() 方法与 PipedOutputStream 进行连接。

总体而言，PipedInputStream 实现了一个与 PipedOutputStream 相连接的管道输入流，它提供了从输出流中读取数据的功能。它适用于多线程环境下的数据传输。

中文源码

/**
 * PipedInputStream 是一个与 PipedOutputStream 相连接的管道输入流，它提供了从 PipedOutputStream 写入的字节数据。
 * 通常，一个线程从 PipedInputStream 对象中读取数据，而另一个线程将数据写入相应的 PipedOutputStream 对象中。
 * 不建议在同一线程中同时使用这两个对象，因为可能会导致线程死锁。
 * PipedInputStream 包含一个缓冲区，将读操作和写操作解耦，并且有一定的限制。
 * 如果向连接的 PipedOutputStream 提供数据的线程已经不再活动，那么管道被认为是“broken”。
 *
 * @see java.io.PipedOutputStream
 * @since JDK1.0
 */
public class PipedInputStream extends InputStream