Java ByteBuffer使用全解析

ByteBuffer 总体介绍

ByteBuffer 是 Java NIO（New I/O）库中的一个类，用于处理字节数据。它提供了一种灵活且高效的方式来操作字节缓冲区，适用于处理大量的字节数据，例如文件 I/O、网络通信等。

ByteBuffer 的一些重要特性和用法：

1. 容量（Capacity）： ByteBuffer 有一个固定的容量，一旦分配，就不能更改。可以通过 allocate 静态方法或 wrap 静态方法来创建一个 ByteBuffer。

   ByteBuffer buffer = ByteBuffer.allocate(1024);  // 分配 1024 字节的缓冲区
   

2. 位置（Position）和限制（Limit）： ByteBuffer 有一个位置和限制的概念，它们用于跟踪读写的位置。position 表示下一个要读写的位置，而 limit 表示当前位置可读写的最大位置。

3. 读写操作： ByteBuffer 提供了一系列读写方法，包括 get、put、read、write 等。这些方法允许你从缓冲区读取数据或将数据写入缓冲区。

   // 写入数据到缓冲区
   buffer.put((byte) 10);
   
   // 从缓冲区读取数据
   byte value = buffer.get();
   

4. 翻转（Flip）： 为了从写模式切换到读模式，或者从读模式切换到写模式，可以使用 flip 方法。这个方法将 limit 设置为当前位置，然后将 position 设置为 0，准备读取数据或写入数据。

   buffer.flip();  // 切换到读模式
   

5. 清空（Clear）： clear 方法用于清空缓冲区，将 position 设置为 0，limit 设置为容量，准备写入数据。

   buffer.clear();  // 清空缓冲区，准备写入数据
   

6. Compact： compact 方法用于在读写模式之间移动数据。它将缓冲区中未读取的数据复制到缓冲区的开始位置，然后将 position 设置为未读取数据的末尾。

   buffer.compact();  // 在读写模式之间移动数据
   

ByteBuffer 的灵活性和高效性使其成为处理字节数据的强大工具，特别适用于网络编程、文件 I/O 和其他需要高性能的场景。

使用示例

put

    @Test
    public void put() {
        ByteBuffer buffer = ByteBuffer.allocate(10);
        System.out.println("buffer = " + buffer);
        buffer.put((byte) 0x01);
        System.out.println("buffer.toString() = " + Arrays.toString(buffer.array()));
        System.out.println("buffer = " + buffer);
        buffer.put(5, (byte) 42);
        System.out.println("buffer.toString() = " + Arrays.toString(buffer.array()));
        System.out.println("buffer = " + buffer);
    }
输出：
buffer = java.nio.HeapByteBuffer[pos=0 lim=10 cap=10]
buffer.toString() = [1, 0, 0, 0, 0, 0, 0, 0, 0, 0]
buffer = java.nio.HeapByteBuffer[pos=1 lim=10 cap=10]
buffer.toString() = [1, 0, 0, 0, 0, 42, 0, 0, 0, 0]
buffer = java.nio.HeapByteBuffer[pos=1 lim=10 cap=10]

  @Test
    public void put2() {
        ByteBuffer buffer = ByteBuffer.allocate(10);
        System.out.println("buffer = " + buffer);

        buffer.put(new byte[] { 0X01, 0X02 });
        System.out.println("buffer = " + buffer);
        System.out.println("buffer.toString() = " + Arrays.toString(buffer.array()));
    }
buffer = java.nio.HeapByteBuffer[pos=0 lim=10 cap=10]
buffer = java.nio.HeapByteBuffer[pos=2 lim=10 cap=10]
buffer.toString() = [1, 2, 0, 0, 0, 0, 0, 0, 0, 0]

    @Test
    public void put3() {
        ByteBuffer buffer = ByteBuffer.allocate(10);
        System.out.println("buffer = " + buffer);

        buffer.put(new byte[] { 0X01, 0X02 }, 1, 1);
        System.out.println("buffer = " + buffer);
        System.out.println("buffer.toString() = " + Arrays.toString(buffer.array()));
    }
buffer = java.nio.HeapByteBuffer[pos=0 lim=10 cap=10]
buffer = java.nio.HeapByteBuffer[pos=1 lim=10 cap=10]
buffer.toString() = [2, 0, 0, 0, 0, 0, 0, 0, 0, 0]

get

   @Test
    public void get() {
        ByteBuffer buffer = ByteBuffer.allocate(10);
        System.out.println("buffer = " + buffer);

        for (int i = 0; i < buffer.limit(); i++) {
            buffer.put((byte) i);
        }
        System.out.println("buffer = " + buffer);
        System.out.println("buffer.toString() = " + Arrays.toString(buffer.array()));

        //获取第3到第5的数据
        byte[] bytes = new byte[3];
        buffer.position(3);
        buffer.get(bytes);
        System.out.println("bytes.toString() = " + Arrays.toString(bytes));
    }

buffer = java.nio.HeapByteBuffer[pos=0 lim=10 cap=10]
buffer = java.nio.HeapByteBuffer[pos=10 lim=10 cap=10]
buffer.toString() = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
bytes.toString() = [3, 4, 5]

position

    @Test
    public void test() {
        ByteBuffer buffer = ByteBuffer.allocate(10);
        System.out.println("buffer = " + buffer);

        buffer.put((byte) 0x01);
        buffer.put(new byte[] { 0x00, 0x00 });
        buffer.put((byte) 0x01);
        System.out.println("buffer.toString() = " + Arrays.toString(buffer.array()));
        System.out.println("buffer = " + buffer);

        buffer.position(1);
        buffer.put(new byte[] { 0x0A, 0x0A });
        System.out.println("buffer.toString() = " + Arrays.toString(buffer.array()));
        System.out.println("buffer = " + buffer);
    }
buffer = java.nio.HeapByteBuffer[pos=0 lim=10 cap=10]
buffer.toString() = [1, 0, 0, 1, 0, 0, 0, 0, 0, 0]
buffer = java.nio.HeapByteBuffer[pos=4 lim=10 cap=10]
buffer.toString() = [1, 10, 10, 1, 0, 0, 0, 0, 0, 0]
buffer = java.nio.HeapByteBuffer[pos=3 lim=10 cap=10]

  @Test
    public void test2() {
        ByteBuffer buffer = ByteBuffer.allocate(10);
        System.out.println("buffer = " + buffer);

        for (int i = 0; i < 7; i++) {
            buffer.put((byte) i);
        }
        System.out.println("buffer = " + buffer);
        System.out.println("buffer.toString() = " + Arrays.toString(buffer.array()));

        buffer.position(3);
        System.out.println("buffer = " + buffer);
        buffer.put((byte) 0xff);
        System.out.println("buffer = " + buffer);
        System.out.println("buffer.toString() = " + Arrays.toString(buffer.array()));

        //回到最后一个有元素的position
        buffer.position(buffer.limit() - 1);
        System.out.println("buffer = " + buffer);
    }
buffer = java.nio.HeapByteBuffer[pos=0 lim=10 cap=10]
buffer = java.nio.HeapByteBuffer[pos=7 lim=10 cap=10]
buffer.toString() = [0, 1, 2, 3, 4, 5, 6, 0, 0, 0]
buffer = java.nio.HeapByteBuffer[pos=3 lim=10 cap=10]
buffer = java.nio.HeapByteBuffer[pos=4 lim=10 cap=10]
buffer.toString() = [0, 1, 2, -1, 4, 5, 6, 0, 0, 0]
buffer = java.nio.HeapByteBuffer[pos=9 lim=10 cap=10]

flip

ByteBuffer的flip()方法用于将缓冲区切换为读模式，即将limit设置为当前position的值，并将position重置为0，以准备读取缓冲区中的数据。

下面是一个使用flip方法的示例：

 @Test
    public void flip() {
        ByteBuffer buffer = ByteBuffer.allocate(10);

        buffer.put((byte) 1);
        buffer.put((byte) 2);
        buffer.put((byte) 3);
        buffer.put((byte) 4);
        buffer.put((byte) 5);

        buffer.flip();

        while (buffer.hasRemaining()) {
            System.out.println(buffer.get());
        }

        System.out.println("切换到读模式后的position: " + buffer.position()); // 输出5
        System.out.println("切换到读模式后的limit: " + buffer.limit()); // 输出5

        buffer.clear();

        System.out.println("切换到写模式后的position: " + buffer.position()); // 输出0
        System.out.println("切换到写模式后的limit: " + buffer.limit()); // 输出10
    }
输出：
1
2
3
4
5
切换到读模式后的position: 5
切换到读模式后的limit: 5
切换到写模式后的position: 0
切换到写模式后的limit: 10

在上面的例子中，我们创建了一个大小为10的ByteBuffer。然后依次向缓冲区中写入了5个字节。

接着调用flip方法将缓冲区切换为读模式。在读模式下，我们可以通过get方法逐个获取缓冲区中的字节。

在打印输出数据后，我们可以看到当前的position和limit都被重新设置为5。

最后，我们调用clear方法将缓冲区切换为写模式。在写模式下，position被重置为0，limit被设置为缓冲区的容量（10）。

limit

ByteBuffer的limit()方法用于设置或获取缓冲区的限制，即缓冲区中可操作数据的大小。它定义了缓冲区中第一个不能读写的元素的索引。

下面是一个使用limit方法的例子：

  @Test
    public void limit2() {
        ByteBuffer buffer = ByteBuffer.allocate(10);

        System.out.println("初始limit: " + buffer.limit() + " position : " + buffer.position()); //
        // 输出10

        buffer.limit(5);
        System.out.println("设置limit为5后: " + buffer.limit() + " position : " + buffer.position()); // 输出5

        buffer.put((byte) 1);
        buffer.put((byte) 2);
        buffer.put((byte) 3);
        buffer.put((byte) 4);
        buffer.put((byte) 5);

		//buffer.put((byte) 6); // 超过limit，抛出异常

        System.out.println("buffer = " + buffer);
        System.out.println("buffer.array() = " + Arrays.toString(buffer.array()));
    }
输出：
初始limit: 10 position : 0
设置limit为5后: 5 position : 0
buffer = java.nio.HeapByteBuffer[pos=5 lim=5 cap=10]
buffer.array() = [1, 2, 3, 4, 5, 0, 0, 0, 0, 0]

假如再put一个字节就会抛出异常。

QA

allocate 静态方法或 wrap 静态方法有什么区别？

ByteBuffer 类提供了两种主要方法用于创建新的 ByteBuffer 实例：allocate 和 wrap。它们有一些关键区别：

1. allocate 方法：

   • allocate 方法是静态方法，通过该方法可以分配新的字节缓冲区。
   • 该方法会在堆上分配一块新的字节数组，作为底层的缓冲区。
   • 这个方法总是创建一个新的缓冲区，不管传递给它的参数是什么。

   ByteBuffer buffer = ByteBuffer.allocate(1024);
   

2. wrap 方法：

   • wrap 方法也是一个静态方法，用于包装一个已有的字节数组，创建一个新的 ByteBuffer。
   • 通过 wrap 方法创建的缓冲区与传递给它的字节数组共享相同的底层数据。
   • wrap 方法不会为传递的字节数组创建新的副本，而是直接使用它。

   byte[] byteArray = new byte[1024];
   ByteBuffer buffer = ByteBuffer.wrap(byteArray);
   

选择使用哪个方法取决于需求和情境：

• 如果需要一个新的缓冲区，并且不想与现有的字节数组共享数据，那么使用 allocate 方法是合适的。

• 如果你已经有一个字节数组，并且想要使用它来创建一个 ByteBuffer，并且希望对 ByteBuffer 的修改会反映在原始数组中，那么使用 wrap 方法是更合适的选择。

allocate 适用于创建新的、独立的缓冲区，而 wrap 适用于共享已有字节数组的缓冲区。

怎么理解limit？

ByteBuffer的limit是一个标记，表示缓冲区中可以读取或写入的最后一个元素的位置的下一个位置。换句话说，limit是第一个不应该读取或写入的元素的索引。在写模式下，limit通常设置为缓冲区的容量（即，你可以写入数据的最大数量）。在切换到读模式时，limit通常设置为写模式下的position值（即，你写入的数据的数量），这样你就可以读取所有写入的数据。

例如，如果你在一个容量为10的ByteBuffer中写入了5个字节的数据，那么在写模式下，limit将是10，position将是5。当你切换到读模式时，limit将设置为5，这意味着你可以读取5个字节的数据，这正是你之前写入的数据量。