Java8 I/O源码-PipedInputStream与PipedOutputStream

前两篇文章Java8 I/O源码-ByteArrayInputStream和Java8 I/O源码-ByteArrayOutputStream介绍了ByteArrayInputStream和ByteArrayOutputStream。本文将详细介绍PipedInputStream与PipedOutputStream的实现。

PipedInputStream与PipedOutputStream分别为管道输入流和管道输出流。管道输入流通过连接到管道输出流实现了类似管道的功能，用于线程之间的通信。

通常，由某个线程向管道输出流中写入数据。根据管道的特性，这些数据会自动发送到与管道输出流对应的管道输入流中。这时其他线程就可以从管道输入流中读取数据，这样就实现了线程之间的通信。

不建议对这两个流对象尝试使用单个线程，因为这样可能死锁线程。

PipedInputStream

outline

定义

public class PipedInputStream extends InputStream

字段

字段	说明
boolean closedByWriter = false;	管道输出流是否关闭
volatile boolean closedByReader = false;	管道输入流是否关闭
boolean connected = false;	管道输入流是否被连接
Thread readSide;	从管道中读取数据的线程
Thread writeSide;	向管道中写入数据的线程
private static final int DEFAULT_PIPE_SIZE = 1024;	管道循环输入缓冲区的默认大小。
protected static final int PIPE_SIZE = DEFAULT_PIPE_SIZE;	管道循环输入缓冲区的默认大小。
protected byte buffer[];	放置数据的循环缓冲区。
protected int in = -1;	缓冲区的位置，当从连接的管道输出流中接收到下一个数据字节时，会将其存储到该位置。
protected int out = 0;	缓冲区的位置，此管道输入流将从该位置读取下一个数据字节。

构造方法

构造方法	说明
public PipedInputStream(PipedOutputStream src) throws IOException {…}	创建PipedInputStream，使其连接到管道输出流src。
public PipedInputStream(PipedOutputStream src, int pipeSize) throws IOException { …}	创建一个PipedInputStream，使其连接到管道输出流src，并对管道缓冲区使用指定的管道大小。
public PipedInputStream() {…}	创建尚未连接的PipedInputStream。
public PipedInputStream(int pipeSize) {…}	创建一个尚未连接的PipedInputStream，并对管道缓冲区使用指定的管道大小。

方法

修饰符	字段
private void initPipe(int pipeSize) {…}	创建PipedInputStream时指定缓冲区大小
public void connect(PipedOutputStream src) throws IOException {…}	将PipedInputStream连接到指定的PipedOutputStream
protected synchronized void receive(int b) throws IOException {…}	接收数据字节到缓冲区中
synchronized void receive(byte b[], int off, int len) throws IOException {…}	从此byte数组中从位置off开始接收最多len个数据字节。
private void checkStateForReceive() throws IOException {…}	检查PipedInputStream是否可以接收数据。
private void awaitSpace() throws IOException {…}	等待。
synchronized void receivedLast() {…}	当所有数据被接收完，关闭PipedOutputStream，唤醒所有等待的线程
public synchronized int read() throws IOException {…}	读取此管道输入流中的下一个数据字节。
public synchronized int read(byte b[], int off, int len) throws IOException {	将最多len个数据字节从此管道输入流读入byte 数组。
public synchronized int available() throws IOException {…}	返回可以不受阻塞地从此输入流中读取的字节数。
public void close() throws IOException {…}	关闭此管道输入流并释放与该流相关的所有系统资源。

构造方法

PipedInputStream( PipedOutputStream src)

/**
 * 创建PipedInputStream，并指定其对应的PipedOutputStream
 */
public PipedInputStream(PipedOutputStream src) throws IOException {
    this(src, DEFAULT_PIPE_SIZE);
}

PipedInputStream( PipedOutputStream src, int pipeSize)

/**
 * 创建PipedInputStream，并指定其对应的PipedOutputStream 和缓冲区大小。
 */
public PipedInputStream(PipedOutputStream src, int pipeSize)
        throws IOException {
     initPipe(pipeSize);
     connect(src);
}

PipedInputStream()

/**
 * 创建PipedInputStream，并指定其缓冲区大小为默认大小。
 */
public PipedInputStream() {
    initPipe(DEFAULT_PIPE_SIZE);
}

PipedInputStream( int pipeSize)

/**
 * 创建PipedInputStream，并指定其缓冲区大小。
 */
public PipedInputStream(int pipeSize) {
    initPipe(pipeSize);
}

方法

initPipe( int pipeSize)

//创建PipedInputStream时指定其缓冲区大小
private void initPipe(int pipeSize) {
     //如果参数pipeSize小于等于0，抛出异常。
     if (pipeSize <= 0) {
        throw new IllegalArgumentException("Pipe Size <= 0");
     }
     buffer = new byte[pipeSize];
}

connect( PipedOutputStream src)

/**
 * 将PipedInputStream连接到指定的PipedOutputStream。
 * 
 * 如果PipedInputStream已经被连接到了其他PipedOutputStream，
 * 抛出IOException。
 */
public void connect(PipedOutputStream src) throws IOException {
    src.connect(this);
}

receive( int b)

/**
 * 接收一个数据字节，将其插入到缓冲区。如果没有可用的输入，方法会阻塞。
 * 
 * @param b 接收的字节
 * @exception IOException 如果管道损坏、未连接、关闭，或者发生I/O错误。
 * @since     JDK1.1
 */
protected synchronized void receive(int b) throws IOException {
    //检查PipedInputStream的状态是否正常。
    checkStateForReceive();
    //获取将数据写入管道的线程
    writeSide = Thread.currentThread();
    //如果被写入管道的数据刚好被读完
    if (in == out)
        //等待
        awaitSpace();
    //？
    if (in < 0) {
        in =