違反コード (read())

以下の違反コード例では、UTF-8にエンコードされた1024バイトのデータをInputStreamから読み取り、Stringとして返そうとしている。String を作成する際に明示的に文字エンコーディングを指定しており、「IDS13-J. ファイル入出力やネットワーク入出力の両端で互換性のある文字エンコーディングを使う」に適合している。

public static String readBytes(InputStream in) throws IOException {
  byte[] data = new byte[1024];
  if (in.read(data) == -1) {
    throw new EOFException();
  }
  return new String(data, "UTF-8");
}

プログラマはread()メソッドの一般契約を正しく理解しておらず、意図したデータを完全に読み取れない可能性がある。読み取るデータは1024バイトより少なく、続きのデータがまだ 入力ストリームに残っているかもしれない。

適合コード (複数の read() 呼出し)

以下の解決法では、読み取られた総バイト数に応じて残りバイト数のオフセットを調整し、求められるすべてのバイトをバッファに読み込んでいる。また、データが完全に読み取られてから文字列を作成することで、マルチバイト文字を分割してしまうことを避けている。(詳しくは「IDS10-J. 一文字を構成するデータを分割しない」を参照。)

public static String readBytes(InputStream in) throws IOException {
  int offset = 0;
  int bytesRead = 0;
  byte[] data = new byte[1024];
  while ((bytesRead = in.read(data, offset, data.length - offset)) 
    != -1) {
    offset += bytesRead;
    if (offset >= data.length) {
      break;
    }
  }
  String str = new String(data, "UTF-8");
  return str;
}

適合コード (readFully())

引数がないあるいは引数が1つのDataInputStreamクラスのreadFully()メソッドは、要求されたすべてのデータを読み取るか、そうでなければ例外を投げる。これらのメソッドは、必要なバイト数を読み取る前に入力の終端に達した場合、EOFException を投げる。また、なんらかの I/O エラーが生じた場合は IOException を投げる。

public static String readBytes(FileInputStream fis) 
                               throws IOException {
  byte[] data = new byte[1024];
  DataInputStream dis = new DataInputStream(fis);
  dis.readFully(data);
  String str = new String(data, "UTF-8");
  return str;
}

リスク評価

read()メソッドの使用を誤ると、読み取るバイト数が期待したものと異なったり、文字データの並びが誤って解釈されることにつながる。

関連ガイドライン

参考文献

翻訳元

これは以下のページを翻訳したものです。

FIO10-J. Ensure the array is filled when using read() to fill an array (revision 85)

Top へ