如何为File ILogger Provider创建并管理可靠的后台任务？

一、后台任务的创建与管理 #

别直接用Task.Run()后就忽略任务，这种方式没法跟踪状态，也做不到优雅终止。推荐用长期运行的后台任务，结合以下方式管理：

• 在FileLoggerProvider构造函数里启动任务，用Task.Factory.StartNew()并指定TaskCreationOptions.LongRunning，调度器会更适配长期运行的任务，避免占用线程池资源。
• 把任务实例存在提供程序的私有字段里，不要丢弃引用，这样在Dispose时能等待任务完成，保证日志写入的完整性。

二、解决Dispose未被调用的问题 #

ILoggerProvider的Dispose没触发，大多是因为提供程序没正确注册到DI容器的生命周期中：

• 注册时用AddSingleton<ILoggerProvider, FileLoggerProvider>()（或对应生命周期的注册方式），确保容器关闭时会自动调用Dispose。
• 如果是手动创建的实例，要在应用退出时手动调用Dispose，比如控制台应用的Main方法末尾、ASP.NET Core的Program.cs中通过Host.Dispose()触发。

三、终止循环：优先用CancellationToken #

相比布尔变量，CancellationToken是更优选择，理由如下：

• 布尔变量需要加锁才能保证线程安全（Log操作多线程调用，Dispose由另一个线程触发），而CancellationToken本身就是线程安全的，无需额外同步逻辑。
• CancellationToken支持注册回调，能在取消时直接关闭文件流，避免资源泄漏。
• 它是.NET标准的取消模式，语义清晰，符合框架设计规范，后续维护成本更低。

核心实现示例 #

public class FileLoggerProvider : ILoggerProvider, IDisposable
{
    private readonly CancellationTokenSource _cts = new();
    private readonly Task _backgroundTask;
    private readonly StreamWriter _logWriter;
    private readonly BlockingCollection<string> _logQueue = new();

    public FileLoggerProvider(string logFilePath)
    {
        _logWriter = new StreamWriter(logFilePath, append: true);
        // 启动长期运行的后台消费任务
        _backgroundTask = Task.Factory.StartNew(
            ProcessLogQueue, 
            _cts.Token, 
            TaskCreationOptions.LongRunning, 
            TaskScheduler.Default);
    }

    private void ProcessLogQueue()
    {
        try
        {
            // 监听队列，令牌取消时自动退出循环
            foreach (var logMessage in _logQueue.GetConsumingEnumerable(_cts.Token))
            {
                _logWriter.WriteLine(logMessage);
                _logWriter.Flush();
            }
        }
        catch (OperationCanceledException)
        {
            // 预期的取消异常，无需处理
        }
        finally
        {
            _logWriter.Dispose();
        }
    }

    public ILogger CreateLogger(string categoryName)
    {
        return new FileLogger(_logQueue);
    }

    public void Dispose()
    {
        // 标记队列不再接受新日志
        _logQueue.CompleteAdding();
        // 触发取消信号
        _cts.Cancel();
        try
        {
            // 等待后台任务处理完剩余日志
            _backgroundTask.Wait();
        }
        catch (AggregateException ex)
        {
            // 过滤取消异常，其他异常按需处理
            ex.Handle(e => e is OperationCanceledException);
        }
        // 释放资源
        _cts.Dispose();
        _logQueue.Dispose();
    }
}

public class FileLogger : ILogger
{
    private readonly BlockingCollection<string> _logQueue;

    public FileLogger(BlockingCollection<string> logQueue)
    {
        _logQueue = logQueue;
    }

    public IDisposable BeginScope<TState>(TState state) => NullScope.Instance;

    public bool IsEnabled(LogLevel logLevel) => true;

    public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter)
    {
        var message = formatter(state, exception);
        _logQueue.TryAdd(message);
    }
}

关键细节说明 #

• 用BlockingCollection<string>做日志队列，自带线程安全的生产消费机制，不用手动加锁。
• 后台任务通过GetConsumingEnumerable(_cts.Token)监听队列，取消令牌触发时会抛出OperationCanceledException，自动退出循环。
• Dispose时先停止队列接收新日志，再触发取消，最后等待任务完成，确保所有已入队的日志都被写入磁盘后再关闭文件流。

内容的提问来源于stack exchange，提问作者David Thielen