StreamWriterとは？C#でのファイル書き込みを徹底解説

StreamWriterは、C#やVB.NETなどの.NET言語でテキストファイルに文字列を書き込むためのクラスです。ファイル操作はプログラミングの基本であり、ログ出力やデータ保存など、さまざまな場面で必要になります。この記事では、StreamWriterの基本的な使い方から応用テクニック、注意点までをわかりやすく解説します。これを読めば、あなたもStreamWriterを使いこなせるようになるでしょう。

StreamWriterの基本：ファイルへの書き込み手順

StreamWriterを使うには、まずSystem.IO名前空間をインポートし、書き込み先のファイルパスを指定してインスタンスを生成します。そして、WriteメソッドやWriteLineメソッドで文字列を書き込み、最後にCloseメソッドで閉じます。以下に、C#での基本的なコード例を示します。

using System;
using System.IO;

class Program
{
    static void Main()
    {
        string path = "example.txt";
        using (StreamWriter sw = new StreamWriter(path))
        {
            sw.WriteLine("こんにちは、世界！");
        }
    }
}

この例では、example.txtというファイルに「こんにちは、世界！」という文字列を書き込んでいます。usingステートメントを使うことで、StreamWriterが自動的に閉じられ、リソースリークを防げます。これは、C#入門書などでも推奨されている書き方です。

StreamWriterの使い方：基本メソッドとその応用

StreamWriterには、ファイルに文字列を書き込むためのメソッドがいくつか用意されています。代表的なものは以下の通りです。

Write：文字列や文字を書き込みます。
WriteLine：文字列を書き込み、末尾に改行を追加します。
WriteAsync / WriteLineAsync：非同期で書き込みます。

これらのメソッドを使い分けることで、効率的にファイルへデータを出力できます。例えば、Visual Studioを使った開発では、ログ出力にWriteLineがよく使われます。

ファイルの追記：既存ファイルにデータを追加する方法

既存のファイルにデータを追記したい場合は、StreamWriterのコンストラクタの第2引数にtrueを指定します。これにより、ファイルの既存内容が保持され、末尾に新しいデータが追加されます。

using (StreamWriter sw = new StreamWriter("example.txt", true))
{
    sw.WriteLine("追記された行");
}

この方法は、ログ管理ツールなどで日々のログを蓄積する際に役立ちます。なお、追記モードではファイルが存在しない場合、自動的に新規作成されます。

文字エンコーディングの指定：日本語を正しく書き込む

日本語を含むテキストを書き込む場合、文字エンコーディングの指定が重要です。StreamWriterのコンストラクタでEncodingを指定できます。例えば、Shift_JISで書き込みたい場合は以下のようにします。

using (StreamWriter sw = new StreamWriter("example.txt", false, Encoding.GetEncoding("shift_jis")))
{
    sw.WriteLine("日本語のテキスト");
}

UTF-8で書き込む場合は、Encoding.UTF8を指定します。ただし、Encoding.UTF8を指定するとBOM（Byte Order Mark）が付与されます。BOMなしUTF-8にしたい場合は、コンストラクタでEncodingを省略するか、UTF8Encoding(false)を使用します。このあたりの違いは、.NETプログラミング解説書でも詳しく解説されています。

StreamWriterの応用：ログファイル、設定ファイル、CSV作成

StreamWriterは、単なるテキスト書き込みだけでなく、さまざまな用途に応用できます。ここでは、具体的な例をいくつか紹介します。

ログファイルの作成

アプリケーションの動作を記録するログファイルは、StreamWriterの典型的な利用例です。日時とメッセージを書き込むことで、デバッグや障害解析に役立ちます。

using (StreamWriter sw = new StreamWriter("app.log", true))
{
    sw.WriteLine($"{DateTime.Now}: 処理開始");
}

設定ファイルの書き込み

アプリケーションの設定をINI形式や独自形式で保存する場合にもStreamWriterを使います。例えば、キーと値のペアを書き込むことで、次回起動時に読み込むことができます。

CSVファイルの作成

データをカンマ区切りで書き出すCSVファイルも、StreamWriterで簡単に作成できます。Excelなどで開ける形式です。

using (StreamWriter sw = new StreamWriter("data.csv", false, Encoding.UTF8))
{
    sw.WriteLine("名前,年齢,都市");
    sw.WriteLine("田中,25,東京");
}

これらの応用例は、C#逆引き大全やVB.NET実践入門などの書籍でも詳しく紹介されています。

エラーハンドリングと例外処理：安全なファイル書き込み

ファイル書き込み中には、ディスク容量不足やアクセス権限の問題など、さまざまな例外が発生する可能性があります。StreamWriterを使用する際は、適切な例外処理を行うことが重要です。一般的な例外としては、UnauthorizedAccessException（アクセス権限がない）、IOException（I/Oエラー）、DirectoryNotFoundException（ディレクトリが存在しない）などがあります。

try
{
    using (StreamWriter sw = new StreamWriter("example.txt"))
    {
        sw.WriteLine("データ");
    }
}
catch (UnauthorizedAccessException ex)
{
    Console.WriteLine("アクセス権限がありません: " + ex.Message);
}
catch (IOException ex)
{
    Console.WriteLine("I/Oエラー: " + ex.Message);
}

また、エラーログをファイルに記録する場合もStreamWriterが使えます。例外発生時にログを残すことで、問題の原因を追跡しやすくなります。

パフォーマンス向上：バッファと非同期書き込み

大量のデータを書き込む場合、パフォーマンスを考慮する必要があります。StreamWriterにはバッファサイズを指定できるコンストラクタがあり、デフォルトでは1024バイトです。バッファサイズを大きくすることで、書き込み回数を減らし、パフォーマンスを向上させることができます。

using (StreamWriter sw = new StreamWriter("large.txt", false, Encoding.UTF8, 4096))
{
    // 大量の書き込み
}

さらに、非同期書き込み（WriteAsync）を使用すると、UIのブロックを防ぎ、アプリケーションの応答性を保てます。特に、Windows Formsアプリ開発などで役立ちます。

StreamWriterの注意点：CloseとDisposeの重要性

StreamWriterを使用した後は、必ずCloseまたはDisposeメソッドを呼び出してリソースを解放する必要があります。これを行わないと、ファイルがロックされたままになり、他のプロセスからアクセスできなくなることがあります。usingステートメントを使えば、自動的にDisposeが呼び出されるため、安全です。

また、Writeメソッドを呼び出した直後にデータがファイルに書き込まれるとは限りません。バッファリングされている場合があるため、Flushメソッドを呼び出すか、Closeメソッドで確実に書き込むようにしましょう。

まとめ：StreamWriterをマスターしてファイル操作を効率化しよう

StreamWriterは、.NETでファイル書き込みを行うための強力なツールです。基本を押さえれば、ログ出力、設定保存、データエクスポートなど、さまざまな場面で活用できます。この記事で紹介したテクニックを参考に、ぜひ実際の開発に取り入れてみてください。さらに詳しく学びたい方は、独習C#やC#ポケットリファレンスなどの書籍が役立ちます。また、VB.NETの教科書もおすすめです。ファイル操作をマスターして、プログラミングスキルを一段階アップさせましょう。