HOWTO · Java

Java でファイルにバイトを書き込む

この記事では、Java でバイトをファイルに書き込む方法を示します

このページの内容

このチュートリアルでは、Java でバイト配列をファイルに書き込む方法を説明します。標準ライブラリには、ストリーム形式で書き込む FileOutputStream と、1回の呼び出しで処理できる NIO の Files.write() という実用的な選択肢が2つあります。また、Apache Commons IO をすでに依存関係として使用しているプロジェクトでは、FileUtils.writeByteArrayToFile() を便利な方法として利用できます。すべての例では StandardCharsets.UTF_8 を使ってテキストをバイト列に変換するため、保存されるファイルがマシンのデフォルト文字セットに依存しません。

FileOutputStream でバイト配列をファイルに書き込む

FileOutputStream は、java.io にある従来からのバイト指向ストリームです。ファイル名を指定して生成すると、ファイルが存在しない場合は作成され、すでに存在する場合は内容が置き換えられます。内容を置き換えずに追記したい場合は、コンストラクターの第2引数に true を渡します。ストリームは OS のハンドルを保持するため、書き込みが終わったら閉じてください。try-with-resources を使えば自動的にクローズされます。

次の例を実行してください。

このセクションのコードと表示されるラベルや出力は英語のままです。

import java.io.FileOutputStream;
import java.nio.charset.StandardCharsets;

class ByteToFile {
  public static void main(String[] args) throws Throwable {
    byte[] data = "DelftStack writes bytes".getBytes(StandardCharsets.UTF_8);
    try (FileOutputStream out = new FileOutputStream("stream-demo.bin")) {
      out.write(data);
    }
    System.out.println("Wrote " + data.length + " bytes to stream-demo.bin");
  }
}
Wrote 23 bytes to stream-demo.bin

getBytes(StandardCharsets.UTF_8) は文字列を決定的にエンコードします。引数なしで getBytes() を呼び出すとプラットフォームのデフォルト文字セットが使われ、別のマシンでは異なるバイト列になる可能性があります。write(data) は配列全体を保存します。一方、必要に応じて write(data, offset, length) で一部分だけを書き込めます。コンストラクター自体が失敗する場合——パスがディレクトリを指している、親ディレクトリが存在しない、または書き込み権限がない——Java は FileNotFoundException をスローします。そのため、ストリームを開く前に書き込み可能な保存先を選んでください。

Files.write() でバイト配列をファイルに書き込む

java.nio.file API では、処理全体を1回の呼び出しにまとめられます。Files.write() はパスを開いてすべてのバイトを書き込み、ファイルを閉じます。デフォルトでは、ファイルが存在しない場合は作成し、存在する場合は切り詰めます。追記するには StandardOpenOption.APPEND、ファイルがすでに存在する場合に失敗させるには StandardOpenOption.CREATE_NEW などのオープンオプションを渡します。

このセクションのコードと表示されるラベルや出力は英語のままです。

import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;

class ByteToFileNio {
  public static void main(String[] args) throws Throwable {
    byte[] data = "NIO write sample data".getBytes(StandardCharsets.UTF_8);
    Path target = Paths.get("nio-demo.bin");
    Files.write(target, data);
    System.out.println("Wrote " + data.length + " bytes to nio-demo.bin");
  }
}
Wrote 21 bytes to nio-demo.bin

このメソッドは IOException を宣言しており、代表的な失敗は原因が分かりやすいものです。親ディレクトリが存在しない場合は NoSuchFileException、プロセスに権限がない場合は AccessDeniedException、既存ファイルに対して CREATE_NEW を渡した場合は FileAlreadyExistsException が発生します。標準ライブラリで最も短い形式にしたく、FileOutputStream のような開いたストリームの制御が不要な場合は、Files.write() を選択してください。

Apache Commons IO でバイト配列をファイルに書き込む

Apache Commons IO にすでに依存しているプロジェクトでは、代わりに FileUtils.writeByteArrayToFile() を呼び出せます。Maven の依存座標 commons-io:commons-io は、ビルドで固定しているバージョンで宣言してください。この記事の以前の版では 2.6 が示されていましたが、これは現在推奨されるバージョンではなく、提供された例のバージョンです。そのため、実際に使用するリリース系統を確認してください。

org.apache.commons.io.FileUtils をインポートすると、FileUtils.writeByteArrayToFile(new File("doc.txt"), data) と呼び出せます。ここで data は、"text".getBytes(StandardCharsets.UTF_8) のような任意の byte[] です。このメソッドは、宛先ファイルが存在しない場合に作成し、途中で不足している親ディレクトリも作成します。これは Files.write() にはない動作です。また、既存ファイルを書き込み前に切り詰めます。ストリームも内部で管理されるため、呼び出し側が閉じるハンドルは残りません。このクラスはサードパーティの JAR に含まれるため、このスニペットは実行可能な例ではなくソースコードとして示しています。依存関係を持たない新しいコードでは、Files.write() を1行で使えば同じ処理を実現できます。