FileSystemWatcher

[C#] FileSystemWatcherでファイル変更をリアルタイムに監視する方法

FileSystemWatcherは、C#でファイルシステムの変更をリアルタイムに監視するためのクラスです。

特定のディレクトリを監視し、ファイルの作成、削除、変更、リネームなどのイベントを検出します。

使用するには、FileSystemWatcherオブジェクトを作成し、監視するディレクトリとフィルタを設定します。

次に、変更を検知するためのイベントハンドラ(例：Changed、Created、Deleted、Renamed)を登録します。

EnableRaisingEventsプロパティをtrueに設定すると、監視が開始されます。

これにより、指定したディレクトリ内のファイル変更をリアルタイムでキャッチし、適切な処理を行うことができます。

目次から探す

FileSystemWatcherとは

FileSystemWatcherは、C#のSystem.IO名前空間に含まれるクラスで、ファイルシステムの変更をリアルタイムで監視するための機能を提供します。

このクラスを使用することで、特定のディレクトリ内でのファイルの作成、変更、削除、名前変更などのイベントを捕捉し、アプリケーションに通知することができます。

これにより、ファイルの変更に応じた処理を自動的に実行することが可能となり、ファイル管理やバックアップ、ログ監視などの用途に非常に便利です。

FileSystemWatcherは、Windowsフォームアプリケーションやコンソールアプリケーションなど、さまざまなC#アプリケーションで利用できます。

FileSystemWatcherの基本設定

FileSystemWatcherのインスタンス作成

FileSystemWatcherを使用するには、まずそのインスタンスを作成する必要があります。

以下のコードは、FileSystemWatcherのインスタンスを作成する方法を示しています。

partial class MyForm : Form
{
    private FileSystemWatcher fileSystemWatcher;
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        fileSystemWatcher = new FileSystemWatcher(); // インスタンスの作成
    }
}

監視するディレクトリの設定

次に、監視したいディレクトリを設定します。

FileSystemWatcherのPathプロパティに監視対象のディレクトリのパスを指定します。

以下のコードでは、C:\MyDirectoryを監視対象として設定しています。

fileSystemWatcher.Path = @"C:\MyDirectory"; // 監視するディレクトリの設定

フィルタの設定方法

FileSystemWatcherでは、特定のファイルタイプのみを監視するためにフィルタを設定することができます。

Filterプロパティを使用して、監視するファイルの拡張子を指定します。

以下の例では、.txtファイルのみを監視するように設定しています。

fileSystemWatcher.Filter = "*.txt"; // .txtファイルのみを監視

これにより、指定したディレクトリ内の.txtファイルに対する変更イベントのみが捕捉されます。

イベントハンドラの設定

FileSystemWatcherを使用する際には、ファイルシステムの変更を捕捉するためのイベントハンドラを設定する必要があります。

以下では、主要なイベントであるChanged、Created、Deleted、Renamedの設定方法を説明します。

Changedイベントの設定

Changedイベントは、監視対象のファイルが変更されたときに発生します。

このイベントを設定するには、以下のようにイベントハンドラを追加します。

fileSystemWatcher.Changed += new FileSystemEventHandler(OnChanged); // Changedイベントの設定
private void OnChanged(object sender, FileSystemEventArgs e)
{
    // 変更があったファイルの情報を表示
    MessageBox.Show($"ファイルが変更されました: {e.FullPath}");
}

Createdイベントの設定

Createdイベントは、新しいファイルが作成されたときに発生します。

以下のコードで、Createdイベントのハンドラを設定できます。

fileSystemWatcher.Created += new FileSystemEventHandler(OnCreated); // Createdイベントの設定
private void OnCreated(object sender, FileSystemEventArgs e)
{
    // 新しく作成されたファイルの情報を表示
    MessageBox.Show($"新しいファイルが作成されました: {e.FullPath}");
}

Deletedイベントの設定

Deletedイベントは、ファイルが削除されたときに発生します。

以下のように設定することで、削除されたファイルの情報を取得できます。

fileSystemWatcher.Deleted += new FileSystemEventHandler(OnDeleted); // Deletedイベントの設定
private void OnDeleted(object sender, FileSystemEventArgs e)
{
    // 削除されたファイルの情報を表示
    MessageBox.Show($"ファイルが削除されました: {e.FullPath}");
}

Renamedイベントの設定

Renamedイベントは、ファイルの名前が変更されたときに発生します。

このイベントを設定するには、以下のようにします。

fileSystemWatcher.Renamed += new RenamedEventHandler(OnRenamed); // Renamedイベントの設定
private void OnRenamed(object sender, RenamedEventArgs e)
{
    // 名前が変更されたファイルの情報を表示
    MessageBox.Show($"ファイルが名前変更されました: {e.OldFullPath} から {e.FullPath} へ");
}

これらのイベントハンドラを設定することで、ファイルシステムの変更に対してリアルタイムで反応するアプリケーションを構築することができます。

FileSystemWatcherのプロパティ

FileSystemWatcherには、監視の動作を制御するためのいくつかの重要なプロパティがあります。

以下では、EnableRaisingEvents、NotifyFilter、IncludeSubdirectoriesの各プロパティについて説明します。

EnableRaisingEventsプロパティ

EnableRaisingEventsプロパティは、FileSystemWatcherがイベントを発生させるかどうかを制御します。

このプロパティをtrueに設定すると、監視が開始され、指定したディレクトリ内での変更イベントが発生します。

デフォルトではfalseに設定されています。

以下のコードは、監視を開始する方法を示しています。

fileSystemWatcher.EnableRaisingEvents = true; // イベントの発生を有効にする

NotifyFilterプロパティ

NotifyFilterプロパティは、監視する際にどのような変更を通知するかを指定します。

このプロパティには、ファイルの名前、サイズ、最終アクセス日時、最終変更日時など、さまざまなフィルタを設定できます。

以下の例では、ファイルの名前と最終変更日時の変更を監視するように設定しています。

fileSystemWatcher.NotifyFilter = NotifyFilters.FileName | NotifyFilters.LastWrite; // 監視する変更の種類を設定

IncludeSubdirectoriesプロパティ

IncludeSubdirectoriesプロパティは、指定したディレクトリ内のサブディレクトリも監視対象に含めるかどうかを制御します。

このプロパティをtrueに設定すると、サブディレクトリ内のファイルの変更も監視されます。

以下のコードは、サブディレクトリを含める設定を示しています。

fileSystemWatcher.IncludeSubdirectories = true; // サブディレクトリも監視対象に含める

これらのプロパティを適切に設定することで、FileSystemWatcherの動作をカスタマイズし、必要な情報を効率的に取得することができます。

FileSystemWatcherの実装例

FileSystemWatcherを使用した実装例をいくつか紹介します。

基本的な使い方から、複数のイベントの監視、エラーハンドリングまで、具体的なコードを通じて理解を深めましょう。

基本的な実装例

以下のコードは、指定したディレクトリ内のファイル変更を監視する基本的な実装例です。

ファイルが変更されたときにメッセージボックスで通知します。

partial class MyForm : Form
{
    private FileSystemWatcher fileSystemWatcher;
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        fileSystemWatcher = new FileSystemWatcher
        {
            Path = @"C:\MyDirectory", // 監視するディレクトリ
            Filter = "*.txt", // .txtファイルのみを監視
            EnableRaisingEvents = true, // イベントの発生を有効にする
            NotifyFilter = NotifyFilters.FileName | NotifyFilters.LastWrite // 監視する変更の種類
        };
        fileSystemWatcher.Changed += new FileSystemEventHandler(OnChanged); // Changedイベントの設定
    }
    private void OnChanged(object sender, FileSystemEventArgs e)
    {
        MessageBox.Show($"ファイルが変更されました: {e.FullPath}");
    }
}

複数のイベントを同時に監視する方法

複数のイベントを同時に監視する場合、Changed、Created、Deleted、Renamedの各イベントに対してハンドラを設定します。

以下のコードは、これらのイベントをすべて監視する例です。

partial class MyForm : Form
{
    private FileSystemWatcher fileSystemWatcher;
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        fileSystemWatcher = new FileSystemWatcher
        {
            Path = @"C:\MyDirectory",
            Filter = "*.txt",
            EnableRaisingEvents = true,
            NotifyFilter = NotifyFilters.FileName | NotifyFilters.LastWrite
        };
        fileSystemWatcher.Changed += new FileSystemEventHandler(OnChanged); // Changedイベント
        fileSystemWatcher.Created += new FileSystemEventHandler(OnCreated); // Createdイベント
        fileSystemWatcher.Deleted += new FileSystemEventHandler(OnDeleted); // Deletedイベント
        fileSystemWatcher.Renamed += new RenamedEventHandler(OnRenamed); // Renamedイベント
    }
    private void OnChanged(object sender, FileSystemEventArgs e) { /* ... */ }
    private void OnCreated(object sender, FileSystemEventArgs e) { /* ... */ }
    private void OnDeleted(object sender, FileSystemEventArgs e) { /* ... */ }
    private void OnRenamed(object sender, RenamedEventArgs e) { /* ... */ }
}

エラーハンドリングの実装

FileSystemWatcherを使用する際には、エラーハンドリングも重要です。

特に、監視対象のディレクトリが存在しない場合や、アクセス権限がない場合にエラーが発生することがあります。

以下のコードは、エラーハンドリングを実装した例です。

private void InitializeFileSystemWatcher()
{
    try
    {
        fileSystemWatcher.Path = @"C:\MyDirectory"; // 監視するディレクトリ
        fileSystemWatcher.EnableRaisingEvents = true; // イベントの発生を有効にする
    }
    catch (Exception ex)
    {
        MessageBox.Show($"エラーが発生しました: {ex.Message}"); // エラーメッセージを表示
    }
}

このように、FileSystemWatcherを使用する際には、基本的な実装から複数のイベントの監視、エラーハンドリングまでを考慮することで、より堅牢なアプリケーションを構築することができます。

応用例

FileSystemWatcherを使用する際の応用例をいくつか紹介します。

特定のファイルタイプの監視、ネットワークドライブの監視、大量のファイル変更に対するパフォーマンスの最適化について具体的な実装方法を見ていきましょう。

特定のファイルタイプのみを監視する

特定のファイルタイプのみを監視する場合、FileSystemWatcherのFilterプロパティを使用します。

以下のコードは、.jpgファイルのみを監視する例です。

fileSystemWatcher.Filter = "*.jpg"; // .jpgファイルのみを監視

この設定により、指定したディレクトリ内での.jpgファイルに対する変更イベントのみが捕捉されます。

これにより、不要なイベントを減らし、効率的な監視が可能になります。

ネットワークドライブの監視

FileSystemWatcherは、ローカルディレクトリだけでなく、ネットワークドライブも監視することができます。

以下のコードは、ネットワークドライブのパスを指定して監視する例です。

fileSystemWatcher.Path = @"\\NetworkDrive\SharedFolder"; // ネットワークドライブの監視

ネットワークドライブを監視する際は、アクセス権限に注意が必要です。

適切な権限がない場合、イベントが発生しないことがあります。

大量のファイル変更に対するパフォーマンスの最適化

大量のファイル変更が発生する場合、FileSystemWatcherのパフォーマンスを最適化するために、以下のポイントに注意します。

NotifyFilterの設定: 監視する変更の種類を必要最低限に絞ることで、不要なイベントを減らします。
IncludeSubdirectoriesの使用: サブディレクトリを監視する場合は、必要な場合のみ有効にします。
バッチ処理: 変更イベントが発生した際に、すぐに処理を行うのではなく、一定時間内に発生したイベントをまとめて処理することで、パフォーマンスを向上させます。

以下のコードは、バッチ処理の一例です。

private List<string> changedFiles = new List<string>();
private Timer timer = new Timer { Interval = 1000 }; // 1秒ごとに処理
public MyForm()
{
    InitializeComponent();
    timer.Tick += Timer_Tick; // タイマーのTickイベントを設定
}
private void OnChanged(object sender, FileSystemEventArgs e)
{
    changedFiles.Add(e.FullPath); // 変更されたファイルをリストに追加
    timer.Start(); // タイマーをスタート
}
private void Timer_Tick(object sender, EventArgs e)
{
    timer.Stop(); // タイマーを停止
    // 変更されたファイルのリストを処理
    foreach (var file in changedFiles)
    {
        MessageBox.Show($"ファイルが変更されました: {file}");
    }
    changedFiles.Clear(); // リストをクリア
}

これらの応用例を参考にすることで、FileSystemWatcherをより効果的に活用し、特定のニーズに応じた監視機能を実装することができます。