【C#入門】StreamWriterを使用したファイルの書き込み

はじめに

C#は、Microsoftによって開発された多用途なプログラミング言語であり、WindowsアプリケーションやWebアプリケーションの開発に広く利用されています。ファイル操作は多くのアプリケーションで必要となる基本的な操作の一つです。本記事では、C#のStreamWriterクラスを使用してファイルにデータを書き込む方法について詳しく解説します。プログラムの実例を交えながら、初心者にも理解しやすいように説明していきます。

StreamWriterとは

StreamWriterは、.NETフレームワークの一部であり、テキストファイルに文字を書き込むためのクラスです。このクラスを使用すると、簡単にファイルにデータを書き込むことができます。

StreamWriterの基本的な使い方

StreamWriterを使用するためには、まず対象となるテキストファイルを指定してインスタンスを作成する必要があります。以下に基本的な使い方を示します。

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オブジェクトが自動的にクローズされるため、リソースリークを防ぐことができます。

ファイルの追記

既存のファイルにデータを追記する場合、StreamWriterのコンストラクタにtrueを指定します。

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

この例では、example.txtに「追記された行」という文字列を追記しています。trueを指定することで、ファイルの既存の内容が保持され、新しい内容が末尾に追加されます。

文字エンコーディングの指定

デフォルトでは、StreamWriterはUTF-8エンコーディングを使用しますが、他のエンコーディングを指定することも可能です。

using System;
using System.IO;
using System.Text;

class Program
{
    static void Main()
    {
        string path = "example.txt";
        using (StreamWriter sw = new StreamWriter(path, false, Encoding.GetEncoding("Shift_JIS")))
        {
            sw.WriteLine("これはShift-JISエンコーディングで書かれた行です。");
        }
    }
}

この例では、example.txtにShift-JISエンコーディングでデータを書き込んでいます。これにより、日本語などのマルチバイト文字が正しくエンコードされます。

ファイル書き込みの応用

StreamWriterを使用することで、さまざまな応用が可能です。以下にいくつかの実例を紹介します。

ログファイルの作成

アプリケーションの実行中に発生したイベントやエラーをログファイルに記録する方法を示します。

using System;
using System.IO;

class Logger
{
    static void Main()
    {
        string path = "application.log";
        using (StreamWriter sw = new StreamWriter(path, true))
        {
            sw.WriteLine($"{DateTime.Now}: アプリケーションが開始されました。");
            try
            {
                // ここにアプリケーションの処理を記述
                throw new Exception("テストエラー");
            }
            catch (Exception ex)
            {
                sw.WriteLine($"{DateTime.Now}: エラーが発生しました - {ex.Message}");
            }
            sw.WriteLine($"{DateTime.Now}: アプリケーションが終了しました。");
        }
    }
}

この例では、application.logファイルにアプリケーションの開始時刻、エラーメッセージ、終了時刻を記録しています。これにより、アプリケーションの動作状況を後から確認することができます。

設定ファイルの書き込み

ユーザーの設定情報をテキストファイルに書き込み、保存する方法を示します。

using System;
using System.IO;

class ConfigWriter
{
    static void Main()
    {
        string path = "config.txt";
        using (StreamWriter sw = new StreamWriter(path))
        {
            sw.WriteLine("username=admin");
            sw.WriteLine("password=12345");
            sw.WriteLine("theme=dark");
        }
    }
}

この例では、config.txtファイルにユーザー名、パスワード、およびテーマ設定を書き込んでいます。これにより、ユーザーの設定を保存し、後から読み込むことができます。

CSVファイルの作成

データをCSV形式で保存する方法を示します。CSVファイルは、カンマで区切られたデータを格納するファイル形式で、データの交換や保存に広く使用されます。

using System;
using System.IO;

class CSVWriter
{
    static void Main()
    {
        string path = "data.csv";
        using (StreamWriter sw = new StreamWriter(path))
        {
            sw.WriteLine("Name,Age,Gender");
            sw.WriteLine("John Doe,30,Male");
            sw.WriteLine("Jane Smith,25,Female");
        }
    }
}

この例では、data.csvファイルに名前、年齢、性別のデータをCSV形式で書き込んでいます。これにより、他のアプリケーションやデータベースで簡単にデータをインポートすることができます。

エラーハンドリングと例外処理

ファイルの書き込み時には、さまざまなエラーが発生する可能性があります。これらのエラーを適切に処理するために、例外処理を行うことが重要です。

一般的な例外の処理

以下に、一般的な例外を処理する方法を示します。

try
{
    using (StreamWriter sw = new StreamWriter("example.txt"))
    {
        sw.WriteLine("ファイルに書き込み中...");
    }
}
catch (UnauthorizedAccessException e)
{
    Console.WriteLine("アクセスが拒否されました: " + e.Message);
}
catch (DirectoryNotFoundException e)
{
    Console.WriteLine("ディレクトリが見つかりません: " + e.Message);
}
catch (IOException e)
{
    Console.WriteLine("I/Oエラーが発生しました: " + e.Message);
}
catch (Exception e)
{
    Console.WriteLine("予期しないエラーが発生しました: " + e.Message);
}

この例では、UnauthorizedAccessException、DirectoryNotFoundException、IOException、および一般的な例外をキャッチし、それぞれに対応するエラーメッセージを表示しています。

エラーログの作成

ファイル書き込み中に発生したエラーをログファイルに記録する方法を示します。

using System;
using System.IO;

class ErrorLogger
{
    static void Main()
    {
        try
        {
            using (StreamWriter sw = new StreamWriter("example.txt"))
            {
                sw.WriteLine("ファイルに書き込み中...");
                // 意図的にエラーを発生させる
                throw new Exception("テストエラー");
            }
        }
        catch (Exception e)
        {
            LogError(e);
        }
    }

    static void LogError(Exception e)
    {
        string logPath = "error.log";
        using (StreamWriter sw = new StreamWriter(logPath, true))
        {
            sw.WriteLine($"{DateTime.Now}: {e.Message}");
        }
    }
}

この例では、ファイルの書き込み中に発生した例外をキャッチし、LogErrorメソッドでエラーメッセージをログファイルに記録しています。

ファイル書き込みのパフォーマンス向上

大量のデータを処理する場合、ファイル書き込みのパフォーマンスが重要です。StreamWriterを効率的に使用するためのいくつかのポイントを紹介します。

バッファサイズの設定

StreamWriterのバッファサイズを指定することで、書き込みパフォーマンスを向上させることができます。

int bufferSize = 1024;
using (StreamWriter sw = new StreamWriter("example.txt", false, Encoding.UTF8, bufferSize))
{
    sw.WriteLine("大きなバッファサイズを使用した書き込み");
}

この例では、バッファサイズを1024バイトに設定しています。大きなバッファを使用することで、ディスクI/Oの回数を減らし、パフォーマンスを向上させることができます。

非同期書き込み

非同期書き込みを使用すると、ファイルの書き込み中に他の処理を並行して行うことができます。これにより、アプリケーションの応答性が向上します。

using System;
using System.IO;
using System.Threading.Tasks;

class AsyncFileWriter
{
    static async Task Main()
    {
        string path = "example.txt";
        using (StreamWriter sw = new StreamWriter(path))
        {
            await sw.WriteLineAsync("非同期書き込み中...");
        }
    }
}

この例では、WriteLineAsyncメソッドを使用して非同期にファイルに書き込んでいます。awaitキーワードを使用することで、書き込みが完了するまで待機しつつ、他の処理を行うことができます。

ファイル書き込みの応用例

最後に、StreamWriterを使用した実際の応用例をいくつか紹介します。

データのバックアップ

アプリケーションのデータを定期的にバックアップする方法を示します。

using System;
using System.IO;

class BackupCreator
{
    static void Main()
    {
        string sourcePath = "data.txt";
        string backupPath = "backup.txt";

        try
        {
            File.Copy(sourcePath, backupPath, true);
            using (StreamWriter sw = new StreamWriter("backup.log", true))
            {
                sw.WriteLine($"{DateTime.Now}: データがバックアップされました。");
            }
        }
        catch (Exception e)
        {
            Console.WriteLine("バックアップ中にエラーが発生しました: " + e.Message);
        }
    }
}

この例では、data.txtファイルをbackup.txtにコピーし、バックアップが成功したことをログファイルに記録しています。これにより、データの保護が容易になります。

テンプレートファイルの生成

テンプレートファイルを生成し、後から必要な情報を埋め込む方法を示します。

using System;
using System.IO;

class TemplateGenerator
{
    static void Main()
    {
        string templatePath = "template.txt";

        using (StreamWriter sw = new StreamWriter(templatePath))
        {
            sw.WriteLine("Dear {Name},");
            sw.WriteLine("");
            sw.WriteLine("We are pleased to inform you that your application for {Position} has been accepted.");
            sw.WriteLine("");
            sw.WriteLine("Sincerely,");
            sw.WriteLine("Company XYZ");
        }
    }
}

この例では、template.txtファイルにテンプレートの内容を書き込んでいます。このテンプレートファイルを使用することで、複数の文書を効率的に生成することができます。

まとめ

本記事では、C#のStreamWriterクラスを使用してファイルにデータを書き込む方法について詳しく解説しました。基本的な使い方から、エラーハンドリング、パフォーマンス向上のためのテクニック、そして実際の応用例までをカバーしました。これらの知識を活用して、C#でのファイル操作を効果的に行いましょう。ファイル書き込みは多くのアプリケーションで重要な役割を果たすため、ぜひ本記事を参考にして実践してみてください。