Java NIO教程（三） Buffer

Java NIO中的Buffer用於和NIO通道進行互動。如你所知，資料是從通道讀入緩衝區，從緩衝區寫入到通道中的。

緩衝區本質上是一塊可以寫入資料，然後可以從中讀取資料的記憶體。這塊記憶體被包裝成NIO Buffer物件，並提供了一組方法，用來方便的訪問該塊記憶體。

Buffer的基本用法

使用Buffer讀寫資料一般遵循以下四個步驟：

1. 寫入資料到Buffer
2. 呼叫flip()方法
3. 從Buffer中讀取資料
4. 呼叫clear()方法或者compact()方法

當向buffer寫入資料時，buffer會記錄下寫了多少資料。一旦要讀取資料，需要通過flip()方法將Buffer從寫模式切換到讀模式。在讀模式下，可以讀取之前寫入到buffer的所有資料。

一旦讀完了所有的資料，就需要清空緩衝區，讓它可以再次被寫入。有兩種方式能清空緩衝區：呼叫clear()或compact()方法。clear()方法會清空整個緩衝區。compact()方法只會清除已經讀過的資料。任何未讀的資料都被移到緩衝區的起始處，新寫入的資料將放到緩衝區未讀資料的後面。

下面是一個使用Buffer的例子：

RandomAccessFile aFile = new RandomAccessFile("data/nio-data.txt", "rw");
FileChannel inChannel = aFile.getChannel();

//create buffer with capacity of 48 bytes
ByteBuffer buf = ByteBuffer.allocate(48);

int bytesRead = inChannel.read(buf); //read into buffer.
while (bytesRead != -1) {

  buf.flip();  //make buffer ready for read

  while(buf.hasRemaining()){
      System.out.print((char) buf.get()); // read 1 byte at a time
  }

  buf.clear(); //make buffer ready for writing
  bytesRead = inChannel.read(buf);
}
aFile.close();
 

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）

Buffer的型別

Java NIO 有以下Buffer型別

• ByteBuffer
• MappedByteBuffer
• CharBuffer
• DoubleBuffer
• FloatBuffer
• IntBuffer
• LongBuffer
• ShortBuffer
• 
  

如你所見，這些Buffer型別代表了不同的資料型別。換句話說，就是可以通過char，short，int，long，float 或 double型別來操作緩衝區中的位元組。

MappedByteBuffer 有些特別，在涉及它的專門章節中再講。

Buffer的分配

要想獲得一個Buffer物件首先要進行分配。 每一個Buffer類都有一個allocate方法。下面是一個分配48位元組capacity的ByteBuffer的例子。

ByteBuffer buf = ByteBuffer.allocate(48);

這是分配一個可儲存1024個字元的CharBuffer：

CharBuffer buf = CharBuffer.allocate(1024);

向Buffer中寫資料

寫資料到Buffer有兩種方式：

• 從Channel寫到Buffer。
• 通過Buffer的put()方法寫到Buffer裡。

從Channel寫到Buffer的例子

int bytesRead = inChannel.read(buf); //read into buffer.

通過put方法寫Buffer的例子：

buf.put(127);

put方法有很多版本，允許你以不同的方式把資料寫入到Buffer中。例如， 寫到一個指定的位置，或者把一個位元組陣列寫入到Buffer。 更多Buffer實現的細節參考JavaDoc。

flip()方法

flip方法將Buffer從寫模式切換到讀模式。呼叫flip()方法會將position設回0，並將limit設定成之前position的值。

換句話說，position現在用於標記讀的位置，limit表示之前寫進了多少個byte、char等 —— 現在能讀取多少個byte、char等。

從Buffer中讀取資料

從Buffer中讀取資料有兩種方式：

1. 從Buffer讀取資料到Channel。
2. 使用get()方法從Buffer中讀取資料。

從Buffer讀取資料到Channel的例子：

//read from buffer into channel.
int bytesWritten = inChannel.write(buf);

使用get()方法從Buffer中讀取資料的例子

byte aByte = buf.get();

get方法有很多版本，允許你以不同的方式從Buffer中讀取資料。例如，從指定position讀取，或者從Buffer中讀取資料到位元組陣列。更多Buffer實現的細節參考JavaDoc。

rewind()方法

Buffer.rewind()將position設回0，所以你可以重讀Buffer中的所有資料。limit保持不變，仍然表示能從Buffer中讀取多少個元素（byte、char等）。

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準備好寫資料了，但是不會覆蓋未讀的資料。

mark()與reset()方法

通過呼叫Buffer.mark()方法，可以標記Buffer中的一個特定position。之後可以通過呼叫Buffer.reset()方法恢復到這個position。例如：

buffer.mark();

//call buffer.get() a couple of times, e.g. during parsing.

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

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的元素個數比另一個少)。

（譯註：剩餘元素是從 position到limit之間的元素）