Java NIO深入理解Buffer（缓冲区）

前言

Github：https://github.com/yihonglei/java-all

Project：java-nio

一 Buffer概述

Java NIO中的Buffer用于和NIO通道进行交互。数据是从通道读入缓冲区，从缓冲区写入到通道中的。

缓冲区本质上是一块可以写入数据，然后可以从中读取数据的内存。这块内存被包装成NIO Buffer对象，

并提供了一组方法，用来方便的访问该块内存。

二 Buffer重要知识点分析

1、Buffer基本用法

使用Buffer读写数据一般遵循以下四个步骤：

1）写入数据到Buffer，一般有可以从Channel读取到到缓冲区中，也可以调用put方法写入。

2）调用flip()方法，切换数据模式。

3）从Buffer中读取数据，一般从缓冲区读取数据写入到通道中，也可以调用get方法读取。

4）调用clear()方法或者compact()方法清空缓冲区。

当向buffer写入数据时，buffer会记录下写了多少数据。一旦要读取数据，需要通过flip()方法将Buffer从写模式切换到读模式。

在读模式下，可以读取之前写入到buffer的所有数据。一旦读完了所有的数据，就需要清空缓冲区，让它可以再次被写入。

有两种方式能清空缓冲区：

1）clear()方法会清空整个缓冲区。

2）compact()方法只会清除已经读过的数据。任何未读的数据都被移到缓冲区的起始处，新写入的数据将放到缓冲区

未读数据的后面。

package com.lanhuigu.nio.buffer;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.channels.FileChannel;

/**
 * 使用Buffer读写数据一般遵循以下四个步骤：
 * (1)写入数据到Buffer，一般有可以从Channel中读取到缓冲区，也可以调用put方法写入。
 * (2)调用flip()方法，切换数据模式。
 * (3)从Buffer中读取数据
 * (4)调用clear()方法或者compact()方法
 * 当向buffer写入数据时，buffer会记录下写了多少数据。一旦要读取数据，需要通过flip()方法将Buffer从写模式切换到读模式。
 * 在读模式下，可以读取之前写入到buffer的所有数据。一旦读完了所有的数据，就需要清空缓冲区，让它可以再次被写入。
 *
 * 有两种方式能清空缓冲区：
 * 1）clear()方法会清空整个缓冲区。
 * 2）compact()方法只会清除已经读过的数据。任何未读的数据都被移到缓冲区的起始处，新写入的数据将放到缓冲区未读数据的后面。
 */
public class BufferRWTest {
    /**
     *  文件复制实例
     */
    public static void main(String[] args) {
        // 源文件
        File fromFile = new File("C:\\mycode\\hello.txt");
        // 目标文件
        File toFile = new File("C:\\mycode\\hello-copy.txt");

        try (
                // 根据源文件创建文件输入流
                FileInputStream fis = new FileInputStream(fromFile);
                // 根据目标文件创建文件输出流，如果文件不存在，自动创建
                FileOutputStream fos = new FileOutputStream(toFile);
                // 1. 获取通道
                FileChannel inChannel = fis.getChannel();
                FileChannel outChannel = fos.getChannel();
        ) {
            // 2. 分配指定大小的缓冲区
            ByteBuffer buffer = ByteBuffer.allocate(48);
            // 3. 将通道中的数据读取到缓冲区
            while (inChannel.read(buffer) != -1) {
                // 切换成读数据模式
                buffer.flip();
                // 4. 从缓冲区读取数据写入到通道中
                outChannel.write(buffer);
                // 清空缓冲区
                buffer.clear();
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

2、Buffer的capacity、position和limit

缓冲区本质上是一块可以写入数据，然后可以从中读取数据的内存。这块内存被包装成NIO Buffer对象，

并提供了一组方法，用来方便的访问该块内存。为了理解Buffer的工作原理，需要熟悉它的三个属性:

.capacity

.position

.limit

position和limit的含义取决于Buffer处在读模式还是写模式。不管Buffer处在什么模式，capacity的含义总是一样的。

这里有一个关于capacity，position和limit在读写模式中的说明：

capacity

作为一个内存块，Buffer有一个固定的大小值，也叫"capacity"。你只能往里写capacity个byte、long，char等类型。

一旦Buffer满了，需要将其清空（通过读数据或者清除数据）才能继续写数据往里写数据。

position

当你写数据到Buffer中时，position表示当前的位置。初始的position值为0。

当一个byte、long等数据写到Buffer后，position会向前移动到下一个可插入数据的Buffer单元。

position最大可为capacity –1当读取数据时，也是从某个特定位置读。

当将Buffer从写模式切换到读模式，position会被重置为0。当从Buffer的position处读取数据时，

position向前移动到下一个可读的位置。

limit

在写模式下，Buffer的limit表示你最多能往Buffer里写多少数据。写模式下，limit等于Buffer的capacity。

当切换Buffer到读模式时，limit表示你最多能读到多少数据。因此，当切换Buffer到读模式时，

limit会被设置成写模式下的position值。

换句话说，你能读到之前写入的所有数据，即limit被设置成已写数据的数量，这个值在写模式下就是position。

3、Buffer的类型

如下是Java NIO中最重要的缓冲区的实现:

ByteBuffer

CharBuffer

DoubleBuffer

FloatBuffer

IntBuffer

LongBuffer

ShortBuffer

MappedByteBuffer

这些Buffer覆盖了你能通过IO发送的基本数据类型:byte, short, int, long, float, double和char。

4、Buffer的分配

要想获得一个Buffer对象首先要进行分配。每一个Buffer类都有一个allocate方法。

分配48字节capacity的ByteBuffer的例子:

ByteBuffer buf = ByteBuffer.allocate(48);

分配一个可存储1024个字符的CharBuffer:

CharBuffer buf = CharBuffer.allocate(1024);

5、向Buffer中写入数据

写数据到Buffer有两种方式:

1）从Channel写到Buffer。

2）通过Buffer的put()方法写到Buffer里。

从Channel写到Buffer的例子:

int bytesRead = inChannel.read(buf); // 从Channel(通道)读取到Buffer(缓冲区)中

通过put方法写Buffer的例子:

buf.put(127);

put方法有很多版本，允许你以不同的方式把数据写入到Buffer中。

例如，写到一个指定的位置，或者把一个字节数组写入到Buffer。

6、flip()方法使用

flip方法将Buffer从写模式切换到读模式。调用flip()方法会将position设回0，并将limit设置成之前position的值。

换句话说，position现在用于标记读的位置，limit表示之前写进了多少个byte、char等现在能读取多少个byte、char等。

7、从Buffer中读取数据

从Buffer中读取数据有两种方式:

1）从Buffer读取数据到Channel。

2）使用get()方法从Buffer中读取数据。

从Buffer读取数据到Channel的例子:

// 从Buffer中读取数据写入到通道中

int bytesWritten = inChannel.write(buf);

使用get()方法从Buffer中读取数据的例子:

byte aByte = buf.get();

get方法有很多版本，允许你以不同的方式从Buffer中读取数据。

例如，从指定position读取，或者从Buffer中读取数据到字节数组。

8、rewind()方法

Buffer.rewind()将position设回0，所以你可以重读Buffer中的所有数据。

limit保持不变，仍然表示能从Buffer中读取多少个元素（byte、char等）。

9、clear()和compact()方法

一旦读完Buffer中的数据，需要让Buffer准备好再次被写入。可以通过clear()或compact()方法来完成。

如果调用的是clear()方法，position将被设回0，limit被设置成capacity的值。换句话说，Buffer被清空了。

Buffer中的数据并未清除，只是这些标记告诉我们可以从哪里开始往Buffer里写数据。如果Buffer中有一些未读的数据，

调用clear()方法，数据将“被遗忘”，意味着不再有任何标记会告诉你哪些数据被读过，哪些还没有。

如果Buffer中仍有未读的数据，且后续还需要这些数据，但是此时想要先写些数据，那么使用compact()方法。

compact()方法将所有未读的数据拷贝到Buffer起始处。然后将position设到最后一个未读元素正后面。

limit属性依然像clear()方法一样，设置成capacity。现在Buffer准备好写数据了，但是不会覆盖未读的数据。

10、mark()和reset()方法

通过调用Buffer.mark()方法，可以标记Buffer中的一个特定position。

之后可以通过调用Buffer.reset()方法恢复到这个position。例如：

buffer.mark();

//调用buffer读写方法，下面通过调用reset恢复到调用前的position位置。

buffer.reset(); // set position back to mark

11、equals()和compareTo()方法

可以使用equals()和compareTo()方法两个Buffer。

equals()

当满足下列条件时，表示两个Buffer相等。

1）有相同的类型（byte、char、int等）。

2）Buffer中剩余的byte、char等的个数相等。

3）Buffer中所有剩余的byte、char等都相同。

如你所见，equals只是比较Buffer的一部分，不是每一个在它里面的元素都比较。

实际上，它只比较Buffer中的剩余元素。

compareTo()

compareTo()方法比较两个Buffer的剩余元素(byte、char等)，如果满足下列条件，则认为一个Buffer"小于"另一个Buffer。

1）第一个不相等的元素小于另一个Buffer中对应的元素。

2）所有元素都相等，但第一个Buffer比另一个先耗尽(第一个Buffer的元素个数比另一个少)。