ReaderクラスをOverrideすると、呼び出し側と呼び出された側のreadメソッドの挙動が違う理由が知りたいです。

Question

経緯

javaを学習中です。
IOを理解するため、Readerクラスをオーバーライドして、独自のReaderを作ろうとしています。
そこで、試しに以下のようなReaderを作ってみました。
オーバーライドしていない時と挙動は一緒だと思っています。(コンストラクタのReaderを使って値を返しているので）

class MyReader extends Reader {
    Reader reader;

    MyReader(Reader reader) {
        this.reader = reader;
    }

    @Override
    public int read(char[] cbuf, int off, int len) throws IOException {
        int c = reader.read(); //Readerクラスで読んだものをそのまま返す
        System.out.println("中 = " + c);
        return c;
    }

    @Override
    public void close() throws IOException {
        reader.close();
    }
}

そしてこのクラスを使ってテキストファイルを読み込んでみると、

try (MyReader reader = new MyReader(new FileReader(SRC_FILE_PATH))) {
       int c;
       while ((c = reader.read()) != -1) {
           System.out.println("外 = " + c);
       }
   } catch (IOException e) {
}

表示結果が中(呼び出されたメソッド)と外(呼び出したメソッド)で違います。

出力結果：

中 = 65533
外 = 0
中 = 65533
外 = 0
中 = 73
外 = 0
中 = 33
外 = 0
中 = -1

といったような感じで・・・

###質問
中から返ってくるint cと外で表示されるint cは同一ではないのでしょうか？
訳をご存知の方がおりましたら、教えていただきたいです。よろしくお願いします。

Comments

[KiyoshiMotoki]

「中 = 」と「外 = 」の結果が逆ではありませんか？もう一度、ソースコードと出力結果に間違いがないか確認してみてください。

[zoemond]

すみません、その通りでした。ありがとうございます。
修正しました。

Answer 1

情報の訂正、ありがとうございます。

中から返ってくるint cと外で表示されるint cは同一ではないのでしょうか？

訳をご存知の方がおりましたら、教えていただきたいです。よろしくお願いします。

read(char[] cbuf, int off, int len)メソッドを正しくオーバーライドしていないことが原因です。

API仕様書をみると、このメソッドは以下のように定義されています。
https://docs.oracle.com/javase/jp/8/docs/api/java/io/Reader.html#read-char:A-int-int-

配列の一部に文字を読み込みます。（中略）

パラメータ:
  cbuf - 転送先バッファー
  （中略）

戻り値:
  読み込まれた文字数。ストリームの終わりに達した場合は -1

要するに、このメソッドは

• 引数cbufに読み込んだ文字を格納し、読み込んだ文字数を返却する
• もしくは -1 を返却する

というふうに実装しなければなりません。

というわけで、MyReaderクラスのread(char[] cbuf, int off, int len)を以下のように修正してみてください。

Before

@Override
public int read(char[] cbuf, int off, int len) throws IOException {
    int c = reader.read(); //Readerクラスで読んだものをそのまま返す
    System.out.println("中 = " + c);
    return c;
}

After

@Override
public int read(char[] cbuf, int off, int len) throws IOException {
    int c = reader.read();
    System.out.println("中 = " + c);

    if (c == -1) {
        return -1;
    } else {
        cbuf[0] = (char) c; // 読み込んだ文字はこの配列に格納する。
        return 1;
    }
}

これで、意図通りの結果になるはずです。

---

ところで、ご質問のコードが必ず外 = 0となる理由は、 Reader クラスの read()メソッドの実装を見てみると分かります。
http://grepcode.com/file/repository.grepcode.com/java/root/jdk/openjdk/8-b132/java/io/Reader.java#Reader.read%28%29

read(cb, 0, 1)の戻り値が -1 でなかった場合、return cb[0];とやっています。
しかし、zoemond様のコードではこの配列に読み込んだ文字を格納していないため、char型のデフォルト値（数値 0 で表される文字）が返却されている、というわけです。

Comments

[zoemond]

なるほど！
丁寧に回答していただきましてありがとうございます。
「引数cbufに読み込んだ文字を格納し、読み込んだ文字数を返却する」
というところの理解が全くできていませんでした。
API仕様のページは何回も見たのですが、眺めているだけでまったく理解していないことに気づきました。
また、仕様のページの気を付けてみるべき部分も回答から学ぶことができました。

zoemond様なんでとんでもないです。どうもありがとうございました！

[KiyoshiMotoki]

> API仕様のページは何回も見たのですが、眺めているだけでまったく理解していないことに気づきました。

技術書の言葉は難しいですよねw

　パラメータ:
　　cbuf - 転送先バッファ

だけで
「ここに読み込んだ文字を格納する必要があるのか」
と気づける人は、まず いないと思いますw

仕様書を読むことも大事ですが、
それに加えてzoemond様のように実際にコードを書いて、ご自分の理解が正しいか確認することが、プログラム言語を習得する上でもっとも有効な手段だと私は思います。