JavaのStringWriterクラスとは？重要性と基本の使い方を徹底解説

StringWriterクラスは、Writerクラスのサブクラスであり、文字列を出力ストリームへ書き込むための文字ストリームです。文字列を書き込む際には、データを内部の文字列バッファ（StringBuffer）に一旦蓄積し、そこから文字列として取り出す仕組みになっています。バッファは書き込まれたデータ量に応じて自動的に拡張されるため、あらかじめ容量を意識する必要はありません。

StringWriterは、ファイルやネットワーク接続ではなく、メモリ上に出力結果を文字列として保持したい場合に特に便利です。例えば、テンプレートエンジンでのHTML組み立てや、動的なログ・レポートの生成など、Writer系APIを活かしながら最終的にStringとして扱いたい場面で広く活用されています。

主なメソッド

• write()：文字・文字配列・文字列をストリームに書き込みます。
• append()：CharSequenceをバッファの末尾に追加します。
• getBuffer()：内部のStringBufferへの参照を返します。
• flush()：ストリームをフラッシュします。
• close()：ストリームを閉じます。なお、StringWriterの場合、close()を呼び出しても実質的な処理は行われず、close後も各メソッドをIOExceptionなしで呼び出せます。

構文

public class StringWriter extends Writer

コード例

import java.io.*;

public class StringWriterTest {
    public static void main(String args[]) {
        String str = "Welcome to Tutorials Point";
        try {
            StringWriter sw = new StringWriter();
            sw.write(str);
            StringBuffer sb = sw.getBuffer();
            System.out.println("StringBuffer: " + sb);
            System.out.println("String written by StringWriter: " + sw);
            sw.close();
        } catch (IOException ioe) {
            System.out.println(ioe);
        }
    }
}

実行結果

StringBuffer: Welcome to Tutorials Point
String written by StringWriter: Welcome to Tutorials Point

コードのポイント

この例では、まずStringWriterのインスタンスを生成し、write()メソッドで文字列を書き込んでいます。続いてgetBuffer()で内部のStringBufferを取得して内容を表示しており、println時に暗黙的に呼び出されるtoString()によっても、バッファの内容をそのまま文字列として取得できることが確認できます。

補足：try-with-resourcesの活用

Java 7以降では、try-with-resources構文を使うことでclose()の呼び出しを自動化でき、より安全で簡潔なコードを書けます。

try (StringWriter sw = new StringWriter()) {
    sw.write(str);
    System.out.println(sw.toString());
} catch (IOException e) {
    e.printStackTrace();
}