Java 9で追加されたInputStreamのtransferTo()メソッドとは？重要性と使い方を解説

Java 9では、InputStreamクラスにtransferTo()メソッドが新たに追加されました。このメソッドは、入力ストリームから出力ストリームへデータをコピーするために使用されます。具体的には、入力ストリームからすべてのバイトを読み込み、読み込んだ順序どおりに出力ストリームへ書き込むという動作を行います。

従来、ストリーム間のデータコピーにはwhileループを用いた手続き的なコードを記述する必要がありましたが、transferTo()メソッドを使えばこの処理をわずか1行で実現できます。ボイラープレートコードの削減と可読性の向上という点で、非常に有用なメソッドといえるでしょう。

構文

public long transferTo(OutputStream out) throws IOException

引数にはコピー先となる出力ストリーム（OutputStream）を指定します。戻り値は転送されたバイト数（long型）です。入出力中にI/Oエラーが発生した場合や、ストリームが閉じられている場合にはIOExceptionがスローされるため、適切な例外処理が必要です。

使用例

import java.util.Arrays;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;

public class TransferToMethodTest {
    public void testTransferTo() throws IOException {
        byte[] inBytes = "tutorialspoint".getBytes();
        ByteArrayInputStream bis = new ByteArrayInputStream(inBytes);
        ByteArrayOutputStream bos = new ByteArrayOutputStream();
        try {
            bis.transferTo(bos);
            byte[] outBytes = bos.toByteArray();
            System.out.println(Arrays.equals(inBytes, outBytes));
        } finally {
            try {
                bis.close();
            } catch(IOException e) {
                e.printStackTrace();
            }
            try {
                bos.close();
            } catch(IOException e) {
                e.printStackTrace();
            }
        }
    }
    public static void main(String args[]) throws Exception {
        TransferToMethodTest test = new TransferToMethodTest();
        test.testTransferTo();
    }
}

実行結果

true

この例では、文字列"tutorialspoint"をgetBytes()メソッドでバイト配列に変換し、ByteArrayInputStreamからByteArrayOutputStreamへtransferTo()メソッドを使ってコピーしています。その後、Arrays.equals()メソッドで入力側と出力側のバイト配列を比較したところ、両者が完全に一致していることを示す「true」が出力されました。

このようにtransferTo()メソッドを活用することで、ファイルのコピーやネットワーク通信など、ストリーム間のデータ転送処理をシンプルかつ効率的に記述できるようになります。