Java : InputStreamReader - API使用例

InputStreamReader (Java SE 21 & JDK 21) の使い方まとめです。
だいたいのメソッドを網羅済みです。
API仕様書のおともにどうぞ。

概要

InputStreamReaderはバイト・ストリームから文字ストリームへの橋渡しの役目を持ちます。バイトを読み込み、指定されたcharsetを使用して文字にデコードします。使用する文字セットは、名前で指定することも、明示的に指定することも、default charsetを使用することもできます。

クラス構成

InputStreamReader クラスは、InputStream から Reader へと橋渡しするためのクラスです。

InputStreamReader は使い終わったら close が必要です。
try-with-resources文を使い、リソースリークが起きないようにしましょう。

final byte[] bytes = "abc".getBytes();

try (final var reader = new InputStreamReader(new ByteArrayInputStream(bytes))) {
    final var ret1 = reader.read();
    System.out.printf("%d : %c%n", ret1, ret1); // 97 : a

    final var ret2 = reader.read();
    System.out.printf("%d : %c%n", ret2, ret2); // 98 : b

    final var ret3 = reader.read();
    System.out.printf("%d : %c%n", ret3, ret3); // 99 : c

    final var ret4 = reader.read();
    System.out.println(ret4); // -1
}

final byte[] bytes = """
        abcd
        XYZ
        12345
        """.getBytes();

try (final var reader = new BufferedReader(new InputStreamReader(
        new ByteArrayInputStream(bytes)))) {
    System.out.println(reader.readLine()); // abcd
    System.out.println(reader.readLine()); // XYZ
    System.out.println(reader.readLine()); // 12345
    System.out.println(reader.readLine()); // null
}

Readerで宣言されたフィールド

lock

「Java API 使用例 : Reader」をご参照ください。

コンストラクタ

InputStreamReader (InputStream in)

default charsetを使用するInputStreamReaderを作成します。

final byte[] bytes = "abc".getBytes();

try (final var reader = new InputStreamReader(new ByteArrayInputStream(bytes))) {
    final var ret1 = reader.read();
    System.out.printf("%d : %c%n", ret1, ret1); // 97 : a

    final var ret2 = reader.read();
    System.out.printf("%d : %c%n", ret2, ret2); // 98 : b

    final var ret3 = reader.read();
    System.out.printf("%d : %c%n", ret3, ret3); // 99 : c

    final var ret4 = reader.read();
    System.out.println(ret4); // -1
}

InputStreamReader (InputStream in, String charsetName)

指定された文字セットを使うInputStreamReaderを作成します。

final var sjis = "Shift_JIS";
final byte[] bytes = "○△×".getBytes(sjis);

try (final var reader = new InputStreamReader(
        new ByteArrayInputStream(bytes), sjis)) {
    final var ret1 = reader.read();
    System.out.printf("%d : %c%n", ret1, ret1); // 9675 : ○

    final var ret2 = reader.read();
    System.out.printf("%d : %c%n", ret2, ret2); // 9651 : △

    final var ret3 = reader.read();
    System.out.printf("%d : %c%n", ret3, ret3); // 215 : ×

    final var ret4 = reader.read();
    System.out.println(ret4); // -1
}

InputStreamReader (InputStream in, Charset cs)

与えられた文字セットを使うInputStreamReaderを作成します。

final var sjis = Charset.forName("Shift_JIS");
final byte[] bytes = "○△×".getBytes(sjis);

try (final var reader = new InputStreamReader(
        new ByteArrayInputStream(bytes), sjis)) {
    final var ret1 = reader.read();
    System.out.printf("%d : %c%n", ret1, ret1); // 9675 : ○

    final var ret2 = reader.read();
    System.out.printf("%d : %c%n", ret2, ret2); // 9651 : △

    final var ret3 = reader.read();
    System.out.printf("%d : %c%n", ret3, ret3); // 215 : ×

    final var ret4 = reader.read();
    System.out.println(ret4); // -1
}

InputStreamReader (InputStream in, CharsetDecoder dec)

与えられた文字セット・デコーダを使うInputStreamReaderを作成します。

final var sjis = Charset.forName("Shift_JIS");
final byte[] bytes = "○△×".getBytes(sjis);

try (final var reader = new InputStreamReader(
        new ByteArrayInputStream(bytes), sjis.newDecoder())) {
    final var ret1 = reader.read();
    System.out.printf("%d : %c%n", ret1, ret1); // 9675 : ○

    final var ret2 = reader.read();
    System.out.printf("%d : %c%n", ret2, ret2); // 9651 : △

    final var ret3 = reader.read();
    System.out.printf("%d : %c%n", ret3, ret3); // 215 : ×

    final var ret4 = reader.read();
    System.out.println(ret4); // -1
}

メソッド

void close ()

ストリームを閉じて、それに関連するすべてのシステム・リソースを解放します。

final byte[] bytes = "abcd".getBytes();
try (final var reader = new InputStreamReader(new ByteArrayInputStream(bytes))) {
    final var cbuf = new char[4];

    System.out.println(reader.read(cbuf)); // 4
    System.out.println(Arrays.toString(cbuf)); // [a, b, c, d]
}

// try-with-resources文を使わない例です。
final byte[] bytes = "abcd".getBytes();
final var reader = new InputStreamReader(new ByteArrayInputStream(bytes));
try {
    final var cbuf = new char[4];

    System.out.println(reader.read(cbuf)); // 4
    System.out.println(Arrays.toString(cbuf)); // [a, b, c, d]
} finally {
    reader.close();
}

String getEncoding ()

このストリームで使用される文字エンコーディングの名前を返します。

final byte[] bytes = "abcd".getBytes();

try (final var reader = new InputStreamReader(
        new ByteArrayInputStream(bytes))) {
    final var ret = reader.getEncoding();
    System.out.println(ret); // UTF8
}

final var sjis = Charset.forName("Shift_JIS");
final byte[] bytes = "abcd".getBytes(sjis);

try (final var reader = new InputStreamReader(
        new ByteArrayInputStream(bytes), sjis)) {
    final var ret = reader.getEncoding();
    System.out.println(ret); // SJIS
}

int read ()

単一の文字を読み込みます。

final byte[] bytes = "abc".getBytes();

try (final var reader = new InputStreamReader(new ByteArrayInputStream(bytes))) {
    final var ret1 = reader.read();
    System.out.printf("%d : %c%n", ret1, ret1); // 97 : a

    final var ret2 = reader.read();
    System.out.printf("%d : %c%n", ret2, ret2); // 98 : b

    final var ret3 = reader.read();
    System.out.printf("%d : %c%n", ret3, ret3); // 99 : c

    final var ret4 = reader.read();
    System.out.println(ret4); // -1
}

int read (char[] cbuf, int off, int len)

配列の一部に文字を読み込みます。

final byte[] bytes = "abcdefg".getBytes();

try (final var reader = new InputStreamReader(new ByteArrayInputStream(bytes))) {
    final var cbuf = new char[5];

    System.out.println(reader.read(cbuf, 0, 1)); // 1
    System.out.println(Arrays.toString(cbuf)); // [a,  ,  ,  ,  ]

    System.out.println(reader.read(cbuf, 0, 2)); // 2
    System.out.println(Arrays.toString(cbuf)); // [b, c,  ,  ,  ]

    System.out.println(reader.read(cbuf, 0, 3)); // 3
    System.out.println(Arrays.toString(cbuf)); // [d, e, f,  ,  ]

    System.out.println(reader.read(cbuf, 0, 4)); // 1
    System.out.println(Arrays.toString(cbuf)); // [g, e, f,  ,  ]

    System.out.println(reader.read(cbuf, 0, 5)); // -1
    System.out.println(Arrays.toString(cbuf)); // [g, e, f,  ,  ]
}

final byte[] bytes = "abcde".getBytes();

try (final var reader = new InputStreamReader(new ByteArrayInputStream(bytes))) {
    final var cbuf = new char[5];

    System.out.println(reader.read(cbuf, 4, 1)); // 1
    System.out.println(Arrays.toString(cbuf)); // [ ,  ,  ,  , a]

    System.out.println(reader.read(cbuf, 3, 1)); // 1
    System.out.println(Arrays.toString(cbuf)); // [ ,  ,  , b, a]

    System.out.println(reader.read(cbuf, 2, 1)); // 1
    System.out.println(Arrays.toString(cbuf)); // [ ,  , c, b, a]

    System.out.println(reader.read(cbuf, 1, 1)); // 1
    System.out.println(Arrays.toString(cbuf)); // [ , d, c, b, a]

    System.out.println(reader.read(cbuf, 0, 1)); // 1
    System.out.println(Arrays.toString(cbuf)); // [e, d, c, b, a]
}

final byte[] bytes = "abcdefg".getBytes();

try (final var reader = new InputStreamReader(new ByteArrayInputStream(bytes))) {
    final var cbuf = new char[3];

    System.out.println(reader.read(cbuf, 0, 3)); // 3
    System.out.println(Arrays.toString(cbuf)); // [a, b, c]

    //reader.read(cbuf, 0, 4); // IndexOutOfBoundsException
    //reader.read(cbuf, 3, 1); // IndexOutOfBoundsException
}

boolean ready ()

このストリームが読込み可能かどうかを判定します。

final byte[] bytes = "abc".getBytes();

try (final var reader = new InputStreamReader(new ByteArrayInputStream(bytes))) {
    System.out.println(reader.ready()); // true
    System.out.printf("%c%n", reader.read()); // a

    System.out.println(reader.ready()); // true
    System.out.printf("%c%n", reader.read()); // b

    System.out.println(reader.ready()); // true
    System.out.printf("%c%n", reader.read()); // c

    System.out.println(reader.ready()); // false
    System.out.println(reader.read()); // -1
}

Readerで宣言されたメソッド

mark, markSupported, nullReader, read, read, reset, skip, transferTo