Java InputStream 转 Byte Array 和 ByteBuffer

Java InputStream 转 Byte Array 和 ByteBuffer

本文介绍如何实现InputStream 转 Byte Array 和 ByteBuffer，首先使用Java原生方式，然后介绍Guava和Commons IO。

1. 转成Byte数组

首先，我们看如何从简单输入流中获取字节数组。字节数组重要特性是应用索引按照每八个bit位方式快速访问内存中的值，因此可以操作这些字节至每一位。下面看使用不同方式实现转换。

1.1 使用纯Java方式

先从java处理固定长度流开始：

@Test
public void givenUsingPlainJava_whenConvertingAnInputStreamToAByteArray_thenCorrect() 
  throws IOException {
    InputStream initialStream = new ByteArrayInputStream(new byte[] { 0, 1, 2 });
 
    byte[] targetArray = new byte[initialStream.available()];
    initialStream.read(targetArray);
}

对于应缓冲流，我们无法知道其底层数据确切大小，实现需更加灵活：

@Test
public void
  givenUsingPlainJavaOnUnknownSizeStream_whenConvertingAnInputStreamToAByteArray_thenCorrect() 
  throws IOException {
    InputStream is = new ByteArrayInputStream(new byte[] { 0, 1, 2 }); // not really unknown
 
    ByteArrayOutputStream buffer = new ByteArrayOutputStream();
    int nRead;
    byte[] data = new byte[1024];
    while ((nRead = is.read(data, 0, data.length)) != -1) {
        buffer.write(data, 0, nRead);
    }
 
    buffer.flush();
    byte[] byteArray = buffer.toByteArray();
}

1.2 使用Guava实现

下面看Guava实现解决方案，使用便捷ByteStreams工具类：

@Test
public void givenUsingGuava_whenConvertingAnInputStreamToAByteArray_thenCorrect() 
  throws IOException {
    InputStream initialStream = ByteSource.wrap(new byte[] { 0, 1, 2 }).openStream();
     
    byte[] targetArray = ByteStreams.toByteArray(initialStream);
}

1.3 使用Commons IO

最后使用更直接的方法，使用Commons IO提供的IOUtils工具类：

@Test
public void givenUsingCommonsIO_whenConvertingAnInputStreamToAByteArray_thenCorrect() 
  throws IOException {
    ByteArrayInputStream initialStream = new ByteArrayInputStream(new byte[] { 0, 1, 2 });
     
    byte[] targetArray = IOUtils.toByteArray(initialStream);
}

IOUtils.toByteArray() 方法内部缓存输入流，因此不再需要使用BufferedInputStream实例。

2. 转成ByteBuffer

接着我们看如何转InputStream输入流至ByteBuffer。当需要对内存进行快速、直接底层IO级操作时非常有用。与上节类似，也提供多种方式实现。

2.1 使用纯Java方式

对于已经知道确切大小的字节流，可以使用ByteArrayInputStream#available方法读字节流值ByteBuffer：

@Test
public void givenUsingCoreClasses_whenByteArrayInputStreamToAByteBuffer_thenLengthMustMatch() 
  throws IOException {
    byte[] input = new byte[] { 0, 1, 2 };
    InputStream initialStream = new ByteArrayInputStream(input);
    ByteBuffer byteBuffer = ByteBuffer.allocate(3);
    while (initialStream.available() > 0) {
        byteBuffer.put((byte) initialStream.read());
    }
 
    assertEquals(byteBuffer.position(), input.length);
}

2.2 使用Guava实现

下面看简单Guava实现，使用便捷的ByteStreams工具类：

@Test
public void givenUsingGuava__whenByteArrayInputStreamToAByteBuffer_thenLengthMustMatch() 
  throws IOException {
    InputStream initialStream = ByteSource
      .wrap(new byte[] { 0, 1, 2 })
      .openStream();
    byte[] targetArray = ByteStreams.toByteArray(initialStream);
    ByteBuffer bufferByte = ByteBuffer.wrap(targetArray);
    while (bufferByte.hasRemaining()) {
        bufferByte.get();
    }
 
    assertEquals(bufferByte.position(), targetArray.length);
}

这里使用while循环配合使用hasRemaining方法展示不一样的方式读所有字节至ByteBuffer中。

2.3 使用Commons IO

最后使用Apache Commons IO 的 IOUtils工具类：

@Test
public void givenUsingCommonsIo_whenByteArrayInputStreamToAByteBuffer_thenLengthMustMatch() 
  throws IOException {
    byte[] input = new byte[] { 0, 1, 2 };
    InputStream initialStream = new ByteArrayInputStream(input);
    ByteBuffer byteBuffer = ByteBuffer.allocate(3);
    ReadableByteChannel channel = newChannel(initialStream);
    IOUtils.readFully(channel, byteBuffer);
 
    assertEquals(byteBuffer.position(), input.length);
}

3. 总结

本文介绍不同方式实现原始输入流转字节数组和ByteBuffer。