当前位置:天才代写 > tutorial > JAVA 教程 > java io进修(三) 管道的简介,源码阐明和示例

java io进修(三) 管道的简介,源码阐明和示例

2017-11-02 08:00 星期四 所属: JAVA 教程 浏览:41

副标题#e#

管道(PipedOutputStream和PipedInputStream)的简介,源码阐明和示例

本章,我们对java 管道举办进修。

java 管道先容

在java中,PipedOutputStream和PipedInputStream别离是管道输出流和管道输入流。

它们的浸染是让多线程可以通过管道举办线程间的通讯。在利用管道通信时,必需将PipedOutputStream和PipedInputStream配套利用。

利用管道通信时,大抵的流程是:我们在线程A中向PipedOutputStream中写入数据,这些数据会自动的发送到与PipedOutputStream对应的PipedInputStream中,进而存储在PipedInputStream的缓冲中;此时,线程B通过读取PipedInputStream中的数据。就可以实现,线程A和线程B的通信。

PipedOutputStream和PipedInputStream源码阐明

下面先容PipedOutputStream和PipedInputStream的源码。在阅读它们的源码之前,发起先看看源码后头的示例。待领略管道的浸染和用法之后,再看源码,大概更容易领略。

另外,由于在“java io系列03之 ByteArrayOutputStream的简介,源码阐明和示例(包罗OutputStream)”中已经对PipedOutputStream的父类OutputStream举办了先容,这里就不再先容OutputStream。

在“java io系列02之 ByteArrayInputStream的简介,源码阐明和示例(包罗InputStream)”中已经对PipedInputStream的父类InputStream举办了先容,这里也不再先容InputStream。

1. PipedOutputStream 源码阐明(基于jdk1.7.40)

package java.io;
     
import java.io.*;
     
public class PipedOutputStream extends OutputStream {
     
    // 与PipedOutputStream通信的PipedInputStream工具
    private PipedInputStream sink;
     
    // 结构函数,指定配对的PipedInputStream
    public PipedOutputStream(PipedInputStream snk)  throws IOException {
        connect(snk);
    }
     
    // 结构函数
    public PipedOutputStream() {
    }
     
    // 将“管道输出流” 和 “管道输入流”毗连。
    public synchronized void connect(PipedInputStream snk) throws IOException {
        if (snk == null) {
            throw new NullPointerException();
        } else if (sink != null || snk.connected) {
            throw new IOException("Already connected");
        }
        // 配置“管道输入流”
        sink = snk;
        // 初始化“管道输入流”的读写位置
        // int是PipedInputStream中界说的,代表“管道输入流”的读写位置
        snk.in = -1;
        // 初始化“管道输出流”的读写位置。
        // out是PipedInputStream中界说的,代表“管道输出流”的读写位置
        snk.out = 0;
        // 配置“管道输入流”和“管道输出流”为已毗连状态
        // connected是PipedInputStream中界说的,用于暗示“管道输入流与管道输出流”是否已经毗连
        snk.connected = true;
    }
     
    // 将int范例b写入“管道输出流”中。
    // 将b写入“管道输出流”之后,它会将b传输给“管道输入流”
    public void write(int b)  throws IOException {
        if (sink == null) {
            throw new IOException("Pipe not connected");
        }
        sink.receive(b);
    }
     
    // 将字节数组b写入“管道输出流”中。
    // 将数组b写入“管道输出流”之后,它会将其传输给“管道输入流”
    public void write(byte b[], int off, int len) throws IOException {
        if (sink == null) {
            throw new IOException("Pipe not connected");
        } else if (b == null) {
            throw new NullPointerException();
        } else if ((off < 0) || (off > b.length) || (len < 0) ||
                   ((off + len) > b.length) || ((off + len) < 0)) {
            throw new IndexOutOfBoundsException();
        } else if (len == 0) {
            return;
        }
        // “管道输入流”吸收数据
        sink.receive(b, off, len);
    }
     
    // 清空“管道输出流”。
    // 这里会挪用“管道输入流”的notifyAll();
    // 目标是让“管道输入流”放弃对当前资源的占有,让其它的期待线程(期待读取管道输出流的线程)读取“管道输出流”的值。
    public synchronized void flush() throws IOException {
        if (sink != null) {
            synchronized (sink) {
                sink.notifyAll();
            }
        }
    }
     
    // 封锁“管道输出流”。
    // 封锁之后,会挪用receivedLast()通知“管道输入流”它已经封锁。
    public void close()  throws IOException {
        if (sink != null) {
            sink.receivedLast();
        }
    }
}


#p#副标题#e#

2. PipedInputStream 源码阐明(基于jdk1.7.40)

package java.io;
     
public class PipedInputStream extends InputStream {
    // “管道输出流”是否封锁的标志
    boolean closedByWriter = false;
    // “管道输入流”是否封锁的标志
    volatile boolean closedByReader = false;
    // “管道输入流”与“管道输出流”是否毗连的标志
    // 它在PipedOutputStream的connect()毗连函数中被配置为true
    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[];
     
    //下一个写入字节的位置。in==out代表满,说明“写入的数据”全部被读取了。
    protected int in = -1;
    //下一个读取字节的位置。in==out代表满,说明“写入的数据”全部被读取了。
    protected int out = 0;
     
    // 结构函数:指定与“管道输入流”关联的“管道输出流”
    public PipedInputStream(PipedOutputStream src) throws IOException {
        this(src, DEFAULT_PIPE_SIZE);
    }
     
    // 结构函数:指定与“管道输入流”关联的“管道输出流”,以及“缓冲区巨细”
    public PipedInputStream(PipedOutputStream src, int pipeSize)
            throws IOException {
         initPipe(pipeSize);
         connect(src);
    }
     
    // 结构函数:默认缓冲区巨细是1024字节
    public PipedInputStream() {
        initPipe(DEFAULT_PIPE_SIZE);
    }
     
    // 结构函数:指定缓冲区巨细是pipeSize
    public PipedInputStream(int pipeSize) {
        initPipe(pipeSize);
    }
     
    // 初始化“管道”:新建缓冲区巨细
    private void initPipe(int pipeSize) {
         if (pipeSize <= 0) {
            throw new IllegalArgumentException("Pipe Size <= 0");
         }
         buffer = new byte[pipeSize];
    }
     
    // 将“管道输入流”和“管道输出流”绑定。
    // 实际上,这里挪用的是PipedOutputStream的connect()函数
    public void connect(PipedOutputStream src) throws IOException {
        src.connect(this);
    }
     
    // 吸收int范例的数据b。
    // 它只会在PipedOutputStream的write(int b)中会被挪用
    protected synchronized void receive(int b) throws IOException {
        // 查抄管道状态
        checkStateForReceive();
        // 获取“写入管道”的线程
        writeSide = Thread.currentThread();
        // 若“写入管道”的数据正好全部被读取完,则期待。
        if (in == out)
            awaitSpace();
        if (in < 0) {
            in = 0;
            out = 0;
        }
        // 将b生存到缓冲区
        buffer[in++] = (byte)(b & 0xFF);
        if (in >= buffer.length) {
            in = 0;
        }
    }
     
    // 吸收字节数组b。
    synchronized void receive(byte b[], int off, int len)  throws IOException {
        // 查抄管道状态
        checkStateForReceive();
        // 获取“写入管道”的线程
        writeSide = Thread.currentThread();
        int bytesToTransfer = len;
        while (bytesToTransfer > 0) {
            // 若“写入管道”的数据正好全部被读取完,则期待。
            if (in == out)
                awaitSpace();
            int nextTransferAmount = 0;
            // 假如“管道中被读取的数据,少于写入管道的数据”;
            // 则配置nextTransferAmount=“buffer.length - in”
            if (out < in) {
                nextTransferAmount = buffer.length - in;
            } else if (in < out) { // 假如“管道中被读取的数据,大于/便是写入管道的数据”,则执行后头的操纵
                // 若in==-1(即管道的写入数据便是被读取数据),此时nextTransferAmount = buffer.length - in;
                // 不然,nextTransferAmount = out - in;
                if (in == -1) {
                    in = out = 0;
                    nextTransferAmount = buffer.length - in;
                } else {
                    nextTransferAmount = out - in;
                }
            }
            if (nextTransferAmount > bytesToTransfer)
                nextTransferAmount = bytesToTransfer;
            // assert断言的浸染是,若nextTransferAmount <= 0,则终止措施。
            assert(nextTransferAmount > 0);
            // 将数据写入到缓冲中
            System.arraycopy(b, off, buffer, in, nextTransferAmount);
            bytesToTransfer -= nextTransferAmount;
            off += nextTransferAmount;
            in += nextTransferAmount;
            if (in >= buffer.length) {
                in = 0;
            }
        }
    }
     
    // 查抄管道状态
    private void checkStateForReceive() throws IOException {
        if (!connected) {
            throw new IOException("Pipe not connected");
        } else if (closedByWriter || closedByReader) {
            throw new IOException("Pipe closed");
        } else if (readSide != null && !readSide.isAlive()) {
            throw new IOException("Read end dead");
        }
    }
     
    // 期待。
    // 若“写入管道”的数据正好全部被读取完(譬喻,管道缓冲满),则执行awaitSpace()操纵;
    // 它的目标是让“读取管道的线程”管道发生读取数据请求,从而才气继承的向“管道”中写入数据。
    private void awaitSpace() throws IOException {
             
        // 假如“管道中被读取的数据,便是写入管道的数据”时,
        // 则每隔1000ms查抄“管道状态”,并叫醒管道操纵:若有“读取管道数据线程被阻塞”,则叫醒该线程。
        while (in == out) {
            checkStateForReceive();
     
            /* full: kick any waiting readers */
            notifyAll();
            try {
                wait(1000);
            } catch (InterruptedException ex) {
                throw new java.io.InterruptedIOException();
            }
        }
    }
     
    // 当PipedOutputStream被封锁时,被挪用
    synchronized void receivedLast() {
        closedByWriter = true;
        notifyAll();
    }
     
    // 从管道(的缓冲)中读取一个字节,并将其转换成int范例
    public synchronized int read()  throws IOException {
        if (!connected) {
            throw new IOException("Pipe not connected");
        } else if (closedByReader) {
            throw new IOException("Pipe closed");
        } else if (writeSide != null && !writeSide.isAlive()
                   && !closedByWriter && (in < 0)) {
            throw new IOException("Write end dead");
        }
     
        readSide = Thread.currentThread();
        int trials = 2;
        while (in < 0) {
            if (closedByWriter) {
                /* closed by writer, return EOF */
                return -1;
            }
            if ((writeSide != null) && (!writeSide.isAlive()) && (--trials < 0)) {
                throw new IOException("Pipe broken");
            }
            /* might be a writer waiting */
            notifyAll();
            try {
                wait(1000);
            } catch (InterruptedException ex) {
                throw new java.io.InterruptedIOException();
            }
        }
        int ret = buffer[out++] & 0xFF;
        if (out >= buffer.length) {
            out = 0;
        }
        if (in == out) {
            /* now empty */
            in = -1;
        }
     
        return ret;
    }
     
    // 从管道(的缓冲)中读取数据,并将其存入到数组b中
    public synchronized int read(byte b[], int off, int len)  throws IOException {
        if (b == null) {
            throw new NullPointerException();
        } else if (off < 0 || len < 0 || len > b.length - off) {
            throw new IndexOutOfBoundsException();
        } else if (len == 0) {
            return 0;
        }
     
        /* possibly wait on the first character */
        int c = read();
        if (c < 0) {
            return -1;
        }
        b[off] = (byte) c;
        int rlen = 1;
        while ((in >= 0) && (len > 1)) {
     
            int available;
     
            if (in > out) {
                available = Math.min((buffer.length - out), (in - out));
            } else {
                available = buffer.length - out;
            }
     
            // A byte is read beforehand outside the loop
            if (available > (len - 1)) {
                available = len - 1;
            }
            System.arraycopy(buffer, out, b, off + rlen, available);
            out += available;
            rlen += available;
            len -= available;
     
            if (out >= buffer.length) {
                out = 0;
            }
            if (in == out) {
                /* now empty */
                in = -1;
            }
        }
        return rlen;
    }
     
    // 返回不受阻塞地以后输入流中读取的字节数。
    public synchronized int available() throws IOException {
        if(in < 0)
            return 0;
        else if(in == out)
            return buffer.length;
        else if (in > out)
            return in - out;
        else
            return in + buffer.length - out;
    }
     
    // 封锁管道输入流
    public void close()  throws IOException {
        closedByReader = true;
        synchronized (this) {
            in = -1;
        }
    }
}

查察本栏目

#p#副标题#e#

管道通信示例

下面,我们看看多线程中通过管道通信的例子。例子中包罗3个类:Receiver.java, PipedStreamTest.java 和 Sender.java。

#p#分页标题#e#

Receiver.java的代码如下:

import java.io.IOException;   
        
import java.io.PipedInputStream;   
        
@SuppressWarnings("all")   
/**  
 * 吸收者线程  
 */
public class Receiver extends Thread {   
            
    // 管道输入流工具。
    // 它和“管道输出流(PipedOutputStream)”工具绑定,
    // 从而可以吸收“管道输出流”的数据,再让用户读取。
    private PipedInputStream in = new PipedInputStream();   
        
    // 得到“管道输入流”工具
    public PipedInputStream getInputStream(){   
        return in;   
    }   
            
    @Override
    public void run(){   
        readMessageOnce() ;
        //readMessageContinued() ;
    }
     
    // 从“管道输入流”中读取1次数据
    public void readMessageOnce(){
        // 固然buf的巨细是2048个字节,但最多只会从“管道输入流”中读取1024个字节。
        // 因为,“管道输入流”的缓冲区巨细默认只有1024个字节。
        byte[] buf = new byte[2048];
        try {
            int len = in.read(buf);
            System.out.println(new String(buf,0,len));
            in.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    // 从“管道输入流”读取>1024个字节时,就遏制读取
    public void readMessageContinued() {
        int total=0;
        while(true) {
            byte[] buf = new byte[1024];
            try {
                int len = in.read(buf);
                total += len;
                System.out.println(new String(buf,0,len));
                // 若读取的字节总数>1024,则退出轮回。
                if (total > 1024)
                    break;
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
     
        try {
            in.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

#p#分页标题#e#

Sender.java的代码如下:

import java.io.IOException;   
        
import java.io.PipedOutputStream;   
@SuppressWarnings("all")
/**  
 * 发送者线程  
 */
public class Sender extends Thread {   
            
    // 管道输出流工具。
    // 它和“管道输入流(PipedInputStream)”工具绑定,
    // 从而可以将数据发送给“管道输入流”的数据,然后用户可以从“管道输入流”读取数据。
    private PipedOutputStream out = new PipedOutputStream();
     
    // 得到“管道输出流”工具
    public PipedOutputStream getOutputStream(){
        return out;
    }   
     
    @Override
    public void run(){   
        writeShortMessage();
        //writeLongMessage();
    }   
     
    // 向“管道输出流”中写入一则较简短的动静:"this is a short message" 
    private void writeShortMessage() {
        String strInfo = "this is a short message" ;
        try {
            out.write(strInfo.getBytes());
            out.close();   
        } catch (IOException e) {   
            e.printStackTrace();   
        }   
    }
    // 向“管道输出流”中写入一则较长的动静
    private void writeLongMessage() {
        StringBuilder sb = new StringBuilder();
        // 通过for轮回写入1020个字节
        for (int i=0; i<102; i++)
            sb.append("0123456789");
        // 再写入26个字节。
        sb.append("abcdefghijklmnopqrstuvwxyz");
        // str的总长度是1020+26=1046个字节
        String str = sb.toString();
        try {
            // 将1046个字节写入到“管道输出流”中
            out.write(str.getBytes());
            out.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

#p#副标题#e#

#p#分页标题#e#

PipedStreamTest.java的代码如下:

import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.io.IOException;
     
@SuppressWarnings("all")   
/**  
 * 管道输入流和管道输出流的交互措施
 */
public class PipedStreamTest {   
        
    public static void main(String[] args) {   
        Sender t1 = new Sender();   
                
        Receiver t2 = new Receiver();   
                
        PipedOutputStream out = t1.getOutputStream();   
      
        PipedInputStream in = t2.getInputStream();   
     
        try {   
            //管道毗连。下面2句话的本质是一样。
            //out.connect(in);   
            in.connect(out);   
                    
            /**  
             * Thread类的START要领:  
             * 使该线程开始执行;Java 虚拟机挪用该线程的 run 要领。   
             * 功效是两个线程并发地运行;当前线程(从挪用返回给 start 要领)和另一个线程(执行其 run 要领)。   
             * 多次启动一个线程是犯科的。出格是当线程已经竣事执行后,不能再从头启动。   
             */
            t1.start();
            t2.start();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

运行功效:

this is a short message

说明:

(01)

in.connect(out);
#p#分页标题#e#

将“管道输入流”和“管道输出流”关联起来。查察PipedOutputStream.java和PipedInputStream.java中connect()的源码;我们知道 out.connect(in); 等价于 in.connect(out);

(02)

t1.start(); // 启动“Sender”线程

t2.start(); // 启动“Receiver”线程

先查察Sender.java的源码,线程启动后执行run()函数;在Sender.java的run()中,挪用writeShortMessage();

writeShortMessage();的浸染就是向“管道输出流”中写入数据"this is a short message" ;这条数据会被“管道输入流”吸收到。下面看看这是如何实现的。

先看write(byte b[])的源码,在OutputStream.java中界说。PipedOutputStream.java担任于OutputStream.java;OutputStream.java中write(byte b[])的源码如下:

public void write(byte b[]) throws IOException {

   write(b, 0, b.length);

}

实际上write(byte b[])是挪用的PipedOutputStream.java中的write(byte b[], int off, int len)函数。查察write(byte b[], int off, int len)的源码,我们发明:它会挪用 sink.receive(b, off, len); 进一步查察receive(byte b[], int off, int len)的界说,我们知道sink.receive(b, off, len)的浸染就是:将“管道输出流”中的数据生存到“管道输入流”的缓冲中。而“管道输入流”的缓冲区buffer的默认巨细是1024个字节。

至此,我们知道:t1.start()启动Sender线程,而Sender线程会将数据"this is a short message"写入到“管道输出流”;而“管道输出流”又会将该数据传输给“管道输入流”,即而生存在“管道输入流”的缓冲中。

接下来,我们看看“用户如何从‘管道输入流’的缓冲中读取数据”。这实际上就是Receiver线程的行动。

t2.start() 会启动Receiver线程,从而执行Receiver.java的run()函数。查察Receiver.java的源码,我们知道run()挪用了readMessageOnce()。

而readMessageOnce()就是挪用in.read(buf)从“管道输入流in”中读取数据,并生存到buf中。

通过上面的阐明,我们已经知道“管道输入流in”的缓冲中的数据是"this is a short message";因此,buf的数据就是"this is a short message"。

为了加深对管道的领略。我们接着举办下面两个小试验。

试验一:修改Sender.java

public void run(){  

   writeShortMessage();

   //writeLongMessage();

}  

修改为

public void run(){  

   //writeShortMessage();

   writeLongMessage();

}

#p#副标题#e#

运行措施。运行功效为:

01234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789

01234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789

01234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789

01234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789

01234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789

01234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789

01234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789

01234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789

01234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789

012345678901234567890123456789abcd

这些数据是通过writeLongMessage()写入到“管道输出流”,然后传送给“管道输入流”,进而存储在“管道输入流”的缓冲中;再被用户从缓冲读取出来的数据。

然后,调查writeLongMessage()的源码。我们可以发明,str的长度是1046个字节,然后运行功效只有1024个字节!为什么会这样呢?

原理很简朴:管道输入流的缓冲区默认巨细是1024个字节。所以,最多只能写入1024个字节。

调查PipedInputStream.java的源码,我们能相识的更透彻。

private static final int DEFAULT_PIPE_SIZE = 1024;

public PipedInputStream() {

   initPipe(DEFAULT_PIPE_SIZE);

}

默认结构函数挪用initPipe(DEFAULT_PIPE_SIZE),它的源码如下:

private void initPipe(int pipeSize) {

    if (pipeSize <= 0) {

       throw new IllegalArgumentException("Pipe Size <= 0");

    }

    buffer = new byte[pipeSize];

}

从中,我们可以知道缓冲区buffer的默认巨细就是1024个字节。

试验二: 在“试验一”的基本上继承修改Receiver.java

public void run(){  

   readMessageOnce() ;

   //readMessageContinued() ;

}

修改为

public void run(){  

   //readMessageOnce() ;

   readMessageContinued() ;

}

运行措施。运行功效为:

01234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789

01234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789

01234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789

01234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789

01234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789

01234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789

01234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789

01234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789

01234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789

012345678901234567890123456789abcd

efghijklmnopqrstuvwxyz

这个功效才是writeLongMessage()写入到“输入缓冲区”的完整数据。

来历:http://www.cnblogs.com/skywang12345/p/io_04.html

 

    关键字:


天才代写-代写联系方式