Movatterモバイル変換

Buffer（ByteBuffer・CharBuffer）

JDK1.4で新設されたnew I/O関連に、バッファークラスがある。
でもちょっと癖があって分かりづらい(苦笑)

概要（特徴）

Bufferの用途・存在意義は、「バッファー」という名前が示す通り、データを保存（追加）し、そこから取得する為のもの。ではあるのだけれど。

• 基本的に、「データをある程度まとめてバッファーに入れ、入れたもの全てを読み取る」という使い方をする。
  （キューの様な、追加して少し読み取って（まだデータが残ってるけど）また追加して…という使い方ではない）
  （書き込みと読み取りを順不同に行うのがキュー。バッファーは基本的に交互に行う）
• バッファーサイズ（キャパシティー）の上限まで行ったら、それ以上追加できない。オーバーフロー（例外が発生）する。
  （StringBuffer（StringBuilder）の様な、上限まで行ったら自動拡張される…という事はない）

Bufferを使う上でややこしいのが、そのBufferインスタンスを今「書き込みに使用しているのか」「読み取りに使用しているのか」をプログラマーが把握・意識して、それに応じた使い方（メソッド呼び出し）をしなければならない（制御する必要がある）こと。
また、同一メソッドでも、読み取りの場合と書き込みの場合で意味合いが異なるものがある。→メソッド一覧

java.nio.Bufferは全てのバッファーの親である抽象クラスであり、データ型に応じて実装クラスがある。
例えばbyteを扱うのはByteBuffer、charを扱うのはCharBuffer。
ただし、実際にはさらにByteBufferやCharBufferを継承したクラス（publicでない）が使われる。

データ例

Bufferは、position・limit・capacityというパラメーターを持っている。
capacityは、バッファーサイズ（上限）。不変。
positionは、バッファー内での読み書きをする開始/現在位置。
limitは、書き込みの場合、書き込める最大サイズ（書き込める上限）。読み取りの場合、保持しているデータサイズ（読み込める上限）。

capacityは変わらないが、positionやlimitは読み書き操作に応じて変わっていく。
書き込みも読み取りも、現在のpositionの位置から開始する。

注意点

バッファー作成直後にいきなり読み取ろうと（get）すると、limitはcapacity位置なので、いきなり最大サイズまで読み込むことになってしまう。

また、書き込み（put）し終わった後にflip()せずに読み込もうとすると、positionは書き込んだ直後の位置なのでそこから読み取りをスタートすることになり、書き込んだデータでなく初期化されている（あるいは以前書き込んだ）データをlimit位置（＝capacity）まで読み込むことになってしまう。

同様に、全部読み終わった後にclear()せずに書き込もうとすると、positionがlimit位置に居るのでそれ以上書き込めない。いきなりオーバーフローになってしまう。

読んだ後にclear()でなくflip()したとすると、（limitにはpositionが代入されるので）limitは最後に読み込んだ直後の位置となり、positionは0になる。
この状態で書き込み（put）を始めると、前回読み込んだサイズ（＝limit位置）までしか書き込めないという妙な事態になる。

Bufferのメソッド

Bufferには、以下のようなメソッドがある。
（中には、バッファーの実装特有（ByteBuffer・CharBuffer等の専用）のメソッドもある）

※「クラス」のBはBuffer、BBはByteBuffer、CBはCharBuffer
※「使用可能タイミング」とは、そのメソッドを呼び出すことに意味のある状態
※「実行後のモード」は、メソッド呼出し後に可能な、意味のある操作ができる状態

1文字ずつ文字コードを変換する例

文字コードを変換するCharsetDecoder#decode()やCharsetEncoder#encode()は、入出力にバッファーを使用する。
（ファイルの文字コードを変換しつつ読み込むにはInputStreamReaderを使えばよいが、ここでは敢えて1文字ずつ変換するメソッドを自作してみる）

public static void main(String[] args) throws IOException {String encoding = "MS932";Charset cs =Charset.forName(encoding);FileInputStream fis = new FileInputStream("ファイル名");try {decode(fis, cs);} finally {fis.close();}}

public static voiddecode(InputStream is, Charset cs) throws IOException {CharsetDecoderdecoder = cs.newDecoder();booleanend = false; //ファイルの終わりまで読み込んだかどうか// バッファーを用意する。// 今回は1文字ずつしか変換しないので、そんなに大きなバッファーは要らないByteBuffer bb = ByteBuffer.allocateDirect(16);// bbは書き込める状態CharBuffer cb = CharBuffer.allocate(16);// cbは書き込める状態do {int d = is.read();if (d >= 0) {System.out.printf("%02x→", d);bb.put((byte) d);// bbへの書き込み} else {end = true;}bb.flip();// bbを読み込み状態に変更CoderResult cr =decoder.decode(bb, cb,end);// bbから読み込み、cbへ書き込むif (!cr.isUnderflow()) {cr.throwException();}if (end) {cr =decoder.flush(cb);// cbへ書き込むif (!cr.isUnderflow()) {cr.throwException();}}cb.flip();// cbを読み込み状態に変更while (cb.hasRemaining()) {// cbに読み込めるデータがある場合char c = cb.get();// cbから読み込みSystem.out.printf("[%c]%n", c);}if (bb.hasRemaining()) {// bbに読み込めるデータがまだ残っている場合bb.compact();// データを詰めて書き込める状態に変更} else {bb.clear();// 書き込める状態に変更}cb.clear();// cbを書き込み状態に変更} while (!end);}

実行例：

30→[0]31→[1]32→[2]33→[3]41→[A]42→[B]43→[C]61→[a]62→[b]63→[c]82→a0→[あ]82→a2→[い]82→a4→[う]8e→c0→[実]8c→b1→[験]

CharsetDecoder#decode()は、ByteBufferのデータを（解釈できる限り）読み込んで、解釈できた文字だけをCharBufferに書き込む。
今回は1バイトずつ渡しているので、2バイト（以上の）文字は1バイト目では解釈できない。
その場合はCharBufferには何も書かれず、ByteBufferにも解釈不能データが残る（読込位置のpositionがlimitまで行かない）。そこでcompact()を呼び出して追加書き込みできるようにしている。
bb.hasRemaining()を使って条件判断せずに 常にcompact()を呼び出しても状態は同じになるが、compact()は内部で配列コピーを呼び出すので、clear()の方が軽い（高速）。

ファイルチャネルからバッファーに読み込む例

JDK1.4以降のFileInputStream（やFileOutputStream）からはファイルチャネルを取得することが出来る。
そして、ファイルチャネルから読み出してByteBufferへ直接出力することが出来る。

public static void main(String[] args) throws IOException {String encoding = "MS932";Charset cs =Charset.forName(encoding);FileInputStream fis = new FileInputStream("ファイル名");FileChannelfch = fis.getChannel();try {decodeCh(fch, cs);} finally {fis.close(); // 取得したチャネルもクローズされる}}

public static voiddecodeCh(FileChannel ch, Charset cs) throws IOException {CharsetDecoder decoder = cs.newDecoder();boolean end = false; //ファイルの終わりまで読み込んだかどうか// バッファーを用意する。ByteBuffer bb = ByteBuffer.allocateDirect(256);// bbは書き込める状態CharBuffer cb = CharBuffer.allocate(256);// cbは書き込める状態do {int len =ch.read(bb);// bbへ書き込みif (len < 0) {end = true;}bb.flip();// bbを読み込み状態に変更CoderResult cr = decoder.decode(bb, cb, end);// bbから読み込み、cbへ書き込むif (!cr.isUnderflow()) {cr.throwException();}if (end) {cr = decoder.flush(cb);// cbへ書き込むif (!cr.isUnderflow()) {cr.throwException();}}cb.flip();// cbを読み込み状態に変更String str = cb.toString();System.out.println(str);bb.compact();// データを詰めて書き込める状態に変更cb.clear();// cbを書き込み状態に変更} while (!end);}

なお、ファイルチャネルには、ファイル内を直接バッファーとして取得するメソッドも用意されている。
（ついでにCharsetDecoder#decode()にもCharBufferを生成して返すメソッドが用意されている）

public static void decodeLump(FileChannel ch, Charset cs) throws IOException {CharsetDecoder decoder = cs.newDecoder();MappedByteBuffer bb =ch.map(MapMode.READ_ONLY, 0,ch.size());// bbは読み込める状態になっているCharBuffer cb = decoder.decode(bb);// bbから読み込んで、cbを返す// cbは読み込める状態になっているString str = cb.toString();System.out.println(str);}