Net 5 中与 FileSystemWatcher 的异步使用

Question

我正在尝试在 Net 5 中创建一个应用程序来监视文件夹，并且任何时候将文件放入文件夹中时，它都应该运行一组特定的任务（从文件中获取一些信息，将它们复制到新位置等） ）。 我以为我可以实现 Net 的 FileSystemWatcher 和并发集合（来自此处的 Collections.Concurrent 命名空间，但我遇到了无法异步运行它的问题。

我像这样初始化观察器（遵循 MS 的文档）：

public BlockingCollection<string> fileNames = new BlockingCollection<string>();
public void InitiateWatcher()
{
    using FileSystemWatcher watcher = new FileSystemWatcher(@"C:\temp"); //test dir

    watcher.NotifyFilter = NotifyFilters.Attributes
             | NotifyFilters.CreationTime
             | NotifyFilters.DirectoryName
             | NotifyFilters.FileName

    watcher.Created += OnCreated;

    watcher.Filter = "*.*";
    watcher.IncludeSubdirectories = true;
    watcher.EnableRaisingEvents = true;

    Console.WriteLine("Press e to exit.");
    Console.ReadLine();
}

private void OnCreated(object sender, FileSystemEventArgs e)
{
    string value = $"Created: {e.FullPath}";
    // this of course creates problems, since it is a async task running in sync mode.
    await PipelineStages.ReadFilenamesAsync(_sourcePath, fileNames);
    // do other work with the result from ReadFilenameAsync
    Console.WriteLine(value);
}

我的 PipelineStages 类，它对文件进行大部分实际工作，如下所示：

public static class PipelineStages
{
    public static Task ReadFilenamesAsync(string path, BlockingCollection<string> output)
    {
        return Task.Factory.StartNew(() =>
        {
            foreach (string fileName in Directory.EnumerateFiles(path, "*.*", SearchOption.AllDirectories))
            {
                output.Add(fileName);
            }
            output.CompleteAdding();
        }, TaskCreationOptions.LongRunning);
    }
}

如果我将 OnCreated 方法设为异步，它会抛出返回类型的错误这对我来说有点道理，尽管我不知道前进的方向，但

我看到两个错误： 一个错误是，当代码到达 output.add(fileName) 行时，它会抛出 System.InvalidOperationException：“集合已被标记为关于添加的完成。”

另一个是，我注意到在 onCreated 方法中，文件名被写入控制台，这些文件位于非常不同的文件夹中，看起来是随机的。

所以，基本上，我有两个问题：

• 这是正确的方法吗？ （如果没有，还有什么其他选择）
• 如果这是正确的方法，我该如何解决这些问题？

Answer 1

首先，您似乎过早地调用了 output.CompleteAdding()，因此每次执行 PipelineStages.ReadFilenamesAsync 都会收到上述 System.InvalidOperationException 错误。
其次，虽然 async void 通常确实不鼓励，但在以下情况下是允许的：

• 事件处理程序
• Main 方法

，但只要这样的 async void code> 事件处理程序基本上是一个即发即忘函数，您应该使其对于任何捕获的变量（其状态可以在外部作用域中无效）（已处置，CompleteAdding 等） .
我编写了以下异步设计的简短独立示例来演示我想要表达的观点：

using System.Collections.Concurrent;
using System.Diagnostics;

object lockObj = new();
using var watcher = new FileSystemWatcher(@".");
using BlockingCollection<string?> queue = new();

async void FileCreatedHandlerAsync(object _, FileSystemEventArgs e) => await Task.Run(() => {
  var lockTaken = false;
  try
  {
    Monitor.Enter(lockObj, ref lockTaken);
    if (!queue.IsCompleted)
      queue.Add(e.Name);
  }
  catch (ObjectDisposedException) { }
  finally {
    if (lockTaken)
      Monitor.Exit(lockObj);
  }
});
watcher.Created += FileCreatedHandlerAsync;
watcher.EnableRaisingEvents = true;

var consumer = Task.Run(async () => {
  foreach (string? name in queue.GetConsumingEnumerable())
    await Task.Run(() => Console.WriteLine($"File has been created: \"{name}\"."));
  
  Debug.Assert(queue.IsCompleted);
});

Console.WriteLine("Press any key to exit.");
Console.ReadLine();

watcher.Created -= FileCreatedHandlerAsync;
lock (lockObj) {
  queue.CompleteAdding();
}
bool completed = consumer.Wait(100);
Debug.Assert(completed && TaskStatus.RanToCompletion == consumer.Status);