Java–ファイルへの書き込み - 開発者ドキュメント

1. 概要

このチュートリアルでは、Javaを使用してファイルに書き込むさまざまな方法を検討します。BufferedWriter 、 PrintWriter 、を使用します] FileOutputStream 、 DataOutputStream 、 RandomAccessFile 、 FileChannel、およびJava 7 Filesユーティリティクラス。

また、書き込み中にファイルをロックする方法についても説明し、ファイルへの書き込みに関する最終的なポイントについて説明します。

このチュートリアルは、ここBaeldungのJava「BacktoBasics」シリーズの一部です。

**2. BufferedWriterで書き込む**

単純なから始めて、BufferedWriterを使用して新しいファイルに文字列を書き込みましょう。

public void whenWriteStringUsingBufferedWritter_thenCorrect() 
  throws IOException {
    String str = "Hello";
    BufferedWriter writer = new BufferedWriter(new FileWriter(fileName));
    writer.write(str);
    
    writer.close();
}

ファイルの出力は次のようになります。

Hello

次に、既存のファイルに文字列を追加できます。

@Test
public void whenAppendStringUsingBufferedWritter_thenOldContentShouldExistToo() 
  throws IOException {
    String str = "World";
    BufferedWriter writer = new BufferedWriter(new FileWriter(fileName, true));
    writer.append(' ');
    writer.append(str);
    
    writer.close();
}

その場合、ファイルは次のようになります。

Hello World

**3. PrintWriterで書き込む**

次に、PrintWriterを使用してフォーマットされたテキストをファイルに書き込む方法を見てみましょう。

@Test
public void givenWritingStringToFile_whenUsingPrintWriter_thenCorrect() 
  throws IOException {
    FileWriter fileWriter = new FileWriter(fileName);
    PrintWriter printWriter = new PrintWriter(fileWriter);
    printWriter.print("Some String");
    printWriter.printf("Product name is %s and its price is %d $", "iPhone", 1000);
    printWriter.close();
}

結果のファイルには次のものが含まれます。

Some String
Product name is iPhone and its price is 1000$

生のStringをファイルに書き込むだけでなく、printfメソッドを使用してフォーマットされたテキストも書き込むことに注意してください。

FileWriter 、 BufferedWriter 、またはSystem.outを使用してライターを作成できます。

**4. FileOutputStreamで書き込む**

FileOutputStreamを使用してバイナリデータをファイルに書き込む方法を見てみましょう。

次のコードは、 String をバイトに変換し、FileOutputStreamを使用してバイトをファイルに書き込みます。

@Test
public void givenWritingStringToFile_whenUsingFileOutputStream_thenCorrect() 
  throws IOException {
    String str = "Hello";
    FileOutputStream outputStream = new FileOutputStream(fileName);
    byte[] strToBytes = str.getBytes();
    outputStream.write(strToBytes);

    outputStream.close();
}

もちろん、ファイルの出力は次のようになります。

Hello

**5. DataOutputStreamで書き込む**

次に、DataOutputStreamを使用してStringをファイルに書き込む方法を見てみましょう。

@Test
public void givenWritingToFile_whenUsingDataOutputStream_thenCorrect() 
  throws IOException {
    String value = "Hello";
    FileOutputStream fos = new FileOutputStream(fileName);
    DataOutputStream outStream = new DataOutputStream(new BufferedOutputStream(fos));
    outStream.writeUTF(value);
    outStream.close();

    // verify the results
    String result;
    FileInputStream fis = new FileInputStream(fileName);
    DataInputStream reader = new DataInputStream(fis);
    result = reader.readUTF();
    reader.close();

    assertEquals(value, result);
}

**6. RandomAccessFileで書き込む**

ここで、完全に新しいファイルに書き込んだり、既存のファイルに追加したりするのではなく、既存のファイル内で書き込みおよび編集する方法を説明しましょう。簡単に言えば、ランダムアクセスが必要です。

RandomAccessFile を使用すると、ファイルの先頭からのオフセットをバイト単位で指定して、ファイル内の特定の位置に書き込むことができます。

このコードは、ファイルの先頭から指定されたオフセットで整数値を書き込みます。

private void writeToPosition(String filename, int data, long position) 
  throws IOException {
    RandomAccessFile writer = new RandomAccessFile(filename, "rw");
    writer.seek(position);
    writer.writeInt(data);
    writer.close();
}

特定の場所に格納されているintを読み取りたい場合は、次の方法を使用できます。

private int readFromPosition(String filename, long position) 
  throws IOException {
    int result = 0;
    RandomAccessFile reader = new RandomAccessFile(filename, "r");
    reader.seek(position);
    result = reader.readInt();
    reader.close();
    return result;
}

関数をテストするために、整数を記述して編集し、最後に読み直してみましょう。

@Test
public void whenWritingToSpecificPositionInFile_thenCorrect() 
  throws IOException {
    int data1 = 2014;
    int data2 = 1500;
    
    writeToPosition(fileName, data1, 4);
    assertEquals(data1, readFromPosition(fileName, 4));
    
    writeToPosition(fileName2, data2, 4);
    assertEquals(data2, readFromPosition(fileName, 4));
}

**7. FileChannelで書き込む**

大きなファイルを処理する場合、FileChannelは標準IOよりも高速になる可能性があります。次のコードは、FileChannelを使用してStringをファイルに書き込みます。

@Test
public void givenWritingToFile_whenUsingFileChannel_thenCorrect() 
  throws IOException {
    RandomAccessFile stream = new RandomAccessFile(fileName, "rw");
    FileChannel channel = stream.getChannel();
    String value = "Hello";
    byte[] strBytes = value.getBytes();
    ByteBuffer buffer = ByteBuffer.allocate(strBytes.length);
    buffer.put(strBytes);
    buffer.flip();
    channel.write(buffer);
    stream.close();
    channel.close();

    // verify
    RandomAccessFile reader = new RandomAccessFile(fileName, "r");
    assertEquals(value, reader.readLine());
    reader.close();
}

**8. ファイルクラスで書き込む**

Java 7では、ファイルシステムを操作する新しい方法と、新しいユーティリティクラスFilesが導入されています。

Files クラスを使用して、ファイルとディレクトリを作成、移動、コピー、および削除できます。また、ファイルの読み取りと書き込みにも使用できます。

@Test
public void givenUsingJava7_whenWritingToFile_thenCorrect() 
  throws IOException {
    String str = "Hello";

    Path path = Paths.get(fileName);
    byte[] strToBytes = str.getBytes();

    Files.write(path, strToBytes);

    String read = Files.readAllLines(path).get(0);
    assertEquals(str, read);
}

9. 一時ファイルに書き込む

それでは、一時ファイルへの書き込みを試してみましょう。次のコードは一時ファイルを作成し、それにStringを書き込みます。

@Test
public void whenWriteToTmpFile_thenCorrect() throws IOException {
    String toWrite = "Hello";
    File tmpFile = File.createTempFile("test", ".tmp");
    FileWriter writer = new FileWriter(tmpFile);
    writer.write(toWrite);
    writer.close();

    BufferedReader reader = new BufferedReader(new FileReader(tmpFile));
    assertEquals(toWrite, reader.readLine());
    reader.close();
}

ご覧のとおり、興味深いのは一時ファイルの作成だけです。その後、ファイルへの書き込みは同じです。

10. 書き込む前にファイルをロックする

最後に、ファイルに書き込むときは、他の人が同時にそのファイルに書き込んでいないことを確認する必要がある場合があります。基本的に、書き込み中にそのファイルをロックできる必要があります。

FileChannel を使用して、ファイルに書き込む前にファイルをロックしてみましょう。

@Test
public void whenTryToLockFile_thenItShouldBeLocked() 
  throws IOException {
    RandomAccessFile stream = new RandomAccessFile(fileName, "rw");
    FileChannel channel = stream.getChannel();

    FileLock lock = null;
    try {
        lock = channel.tryLock();
    } catch (final OverlappingFileLockException e) {
        stream.close();
        channel.close();
    }
    stream.writeChars("test lock");
    lock.release();

    stream.close();
    channel.close();
}

ロックを取得しようとしたときにファイルがすでにロックされている場合は、OverlappingFileLockExceptionがスローされることに注意してください。

11. ノート

ファイルへの書き込みの非常に多くの方法を調べた後、いくつかの重要な注意事項について説明しましょう。

存在しないファイルから読み込もうとすると、FileNotFoundExceptionがスローされます。
存在しないファイルに書き込もうとすると、ファイルが最初に作成され、例外はスローされません。
ストリームは暗黙的に閉じられないため、使用後にストリームを閉じて、関連するリソースを解放することが非常に重要です。
出力ストリームでは、 close（）メソッドはリソースを解放する前に flush（）を呼び出します。これにより、バッファリングされたバイトがストリームに強制的に書き込まれます。

一般的な使用方法を見ると、たとえば、PrintWriterはフォーマットされたテキストの書き込み、FileOutputStreamはバイナリデータの書き込み、DataOutputStreamはプリミティブデータ型の書き込み、RandomAccessFileは特定の位置への書き込み、FileChannelはより大きなファイルでより速く書き込む。これらのクラスのAPIのいくつかはより多くを許可しますが、これは始めるのに良い場所です。