ByteArrayOutputStream简介和使用_动力节点Java学院整理

ByteArrayOutputStream 介绍

ByteArrayOutputStream 是字节数组输出流。它继承于OutputStream。

ByteArrayOutputStream 中的数据被写入一个 byte 数组。缓冲区会随着数据的不断写入而自动增长。可使用 toByteArray() 和 toString() 获取数据。

OutputStream 函数列表

我们来看看ByteArrayOutputStream的父类OutputStream的函数接口。

// 构造函数
OutputStream()
     void  close()
     void  flush()
     void  write(byte[] buffer, int offset, int count)
     void  write(byte[] buffer)
abstract void  write(int oneByte)
ByteArrayOutputStream 函数列表
 // 构造函数
ByteArrayOutputStream()
ByteArrayOutputStream(int size)
       void  close()
synchronized void  reset()
       int   size()
synchronized byte[] toByteArray()
       String toString(int hibyte)
       String toString(String charsetName)
       String toString()
synchronized void  write(byte[] buffer, int offset, int len)
synchronized void  write(int oneByte)
synchronized void  writeTo(OutputStream out)

OutputStream和ByteArrayOutputStream源码分析

OutputStream是ByteArrayOutputStream的父类，我们先看看OutputStream的源码，然后再学ByteArrayOutputStream的源码。

1. OutputStream.java源码分析(基于jdk1.7.40) 

package java.io;
 public abstract class OutputStream implements Closeable, Flushable {
   // 将字节b写入到“输出流”中。
   // 它在子类中实现！
   public abstract void write(int b) throws IOException;
   // 写入字节数组b到“字节数组输出流”中。
   public void write(byte b[]) throws IOException {
    write(b, 0, b.length);
   }
   // 写入字节数组b到“字节数组输出流”中，并且off是“数组b的起始位置”，len是写入的长度
   public void write(byte b[], int off, int len) throws IOException {
     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;
     }
     for (int i = 0 ; i < len ; i++) {
      write(b[off + i]);
     }
   }
   public void flush() throws IOException {
   }
   public void close() throws IOException {
   }
 }

2. ByteArrayOutputStream 源码分析(基于jdk1.7.40) 

 package java.io;
  import java.util.Arrays;
  public class ByteArrayOutputStream extends OutputStream {
    // 保存“字节数组输出流”数据的数组
    protected byte buf[];
   // “字节数组输出流”的计数
   protected int count;
   // 构造函数：默认创建的字节数组大小是。
   public ByteArrayOutputStream() {
     this(32);
   }
   // 构造函数：创建指定数组大小的“字节数组输出流”
   public ByteArrayOutputStream(int size) {
     if (size < 0) {
       throw new IllegalArgumentException("Negative initial size: "
                         + size);
     }
     buf = new byte[size];
   }
   // 确认“容量”。
   // 若“实际容量 < minCapacity”，则增加“字节数组输出流”的容量
   private void ensureCapacity(int minCapacity) {
     // overflow-conscious code
     if (minCapacity - buf.length > 0)
       grow(minCapacity);
   }
   // 增加“容量”。
   private void grow(int minCapacity) {
     int oldCapacity = buf.length;
     // “新容量”的初始化 = “旧容量”x2
     int newCapacity = oldCapacity << 1;
     // 比较“新容量”和“minCapacity”的大小，并选取其中较大的数为“新的容量”。
     if (newCapacity - minCapacity < 0)
      newCapacity = minCapacity;
     if (newCapacity < 0) {
       if (minCapacity < 0) // overflow
         throw new OutOfMemoryError();
       newCapacity = Integer.MAX_VALUE;
     }
     buf = Arrays.copyOf(buf, newCapacity);
   }
   // 写入一个字节b到“字节数组输出流”中，并将计数+1
  public synchronized void write(int b) {
     ensureCapacity(count + 1);
     buf[count] = (byte) b;
     count += 1;
   }
   // 写入字节数组b到“字节数组输出流”中。off是“写入字节数组b的起始位置”，len是写入的长度
   public synchronized void write(byte b[], int off, int len) {
     if ((off < 0) || (off > b.length) || (len < 0) ||
       ((off + len) - b.length > 0)) {
       throw new IndexOutOfBoundsException();
     }
     ensureCapacity(count + len);
     System.arraycopy(b, off, buf, count, len);
     count += len;
   }
   // 写入输出流outb到“字节数组输出流”中。
   public synchronized void writeTo(OutputStream out) throws IOException {
     out.write(buf, 0, count);
   }
   // 重置“字节数组输出流”的计数。
   public synchronized void reset() {
     count = 0;
   }
   // 将“字节数组输出流”转换成字节数组。
   public synchronized byte toByteArray()[] {
     return Arrays.copyOf(buf, count);
   }
   // 返回“字节数组输出流”当前计数值
   public synchronized int size() {
     return count;
   }
   public synchronized String toString() {
     return new String(buf, 0, count);
   }
  public synchronized String toString(String charsetName)
     throws UnsupportedEncodingException
   {
     return new String(buf, 0, count, charsetName);
   }
   @Deprecated
   public synchronized String toString(int hibyte) {
    return new String(buf, hibyte, 0, count);
   }
   public void close() throws IOException {
   }
 }

说明：

ByteArrayOutputStream实际上是将字节数据写入到“字节数组”中去。

(01) 通过ByteArrayOutputStream()创建的“字节数组输出流”对应的字节数组大小是32。

(02) 通过ByteArrayOutputStream(int size) 创建“字节数组输出流”，它对应的字节数组大小是size。

(03) write(int oneByte)的作用将int类型的oneByte换成byte类型，然后写入到输出流中。

(04) write(byte[] buffer, int offset, int len) 是将字节数组buffer写入到输出流中，offset是从buffer中读取数据的起始偏移位置，len是读取的长度。

(05) writeTo(OutputStream out) 将该“字节数组输出流”的数据全部写入到“输出流out”中。

示例代码

关于ByteArrayOutputStream中API的详细用法，参考示例代码(ByteArrayOutputStreamTest.java)：

 import java.io.IOException;
 import java.io.OutputStream;
 import java.io.ByteArrayOutputStream;
 import java.io.ByteArrayInputStream;
 /**
  * ByteArrayOutputStream 测试程序
  *
  *
 */
 public class ByteArrayOutputStreamTest {
   private static final int LEN = 5;
   // 对应英文字母“abcddefghijklmnopqrsttuvwxyz”
   private static final byte[] ArrayLetters = {
     0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x6A, 0x6B, 0x6C, 0x6D, 0x6E, 0x6F,
     0x70, 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78, 0x79, 0x7A
   };
   public static void main(String[] args) {
     //String tmp = new String(ArrayLetters);
     //System.out.println("ArrayLetters="+tmp);
     tesByteArrayOutputStream() ;
   }
   /**
   * ByteArrayOutputStream的API测试函数
   */
   private static void tesByteArrayOutputStream() {
     // 创建ByteArrayOutputStream字节流
     ByteArrayOutputStream baos = new ByteArrayOutputStream();
     // 依次写入“A”、“B”、“C”三个字母。0x41对应A，0x42对应B，0x43对应C。
     baos.write(0x41);
     baos.write(0x42);
    baos.write(0x43);
    System.out.printf("baos=%s\n", baos);
    // 将ArrayLetters数组中从“3”开始的后5个字节写入到baos中。
    // 即对应写入“0x64, 0x65, 0x66, 0x67, 0x68”，即“defgh”
     baos.write(ArrayLetters, 3, 5);
    System.out.printf("baos=%s\n", baos);
     // 计算长度
     int size = baos.size();
     System.out.printf("size=%s\n", size);
     // 转换成byte[]数组
     byte[] buf = baos.toByteArray();
     String str = new String(buf);
     System.out.printf("str=%s\n", str);
     // 将baos写入到另一个输出流中
     try {
       ByteArrayOutputStream baos2 = new ByteArrayOutputStream();
       baos.writeTo((OutputStream)baos2);
       System.out.printf("baos2=%s\n", baos2);
     } catch (IOException e) {
       e.printStackTrace();
     }
   }
 }

运行结果：

baos=ABC
baos=ABCdefgh
size=8
str=ABCdefgh
baos2=ABCdefgh

以上所述是小编给大家介绍的ByteArrayOutputStream简介和使用，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对我们网站的支持！