ConsoleAppFramework 中如何优雅地集成 ZLogger 日志系统

前言

在现代 .NET 应用开发中，日志记录是不可或缺的基础设施。ConsoleAppFramework 作为一个轻量级的控制台应用框架，提供了灵活的日志记录机制。本文将深入探讨如何在 ConsoleAppFramework 中集成 ZLogger 这一高性能日志库，并分享最佳实践。

ConsoleAppFramework 的日志机制

ConsoleAppFramework 内置了一个简单的日志系统，通过 ConsoleApp.Log 和 ConsoleApp.LogError 两个静态委托属性提供基础日志功能。这种设计使得开发者可以灵活地替换日志实现。

// 框架内置的日志委托
public static Action<string> Log { get; set; } = Console.WriteLine;
public static Action<string> LogError { get; set; } = Console.Error.WriteLine;

为什么要替换默认日志实现

虽然框架提供了默认的控制台输出，但在生产环境中我们通常需要：

1. 更结构化的日志格式
2. 日志级别控制
3. 日志持久化能力
4. 更好的性能表现

这正是 ZLogger 这类专业日志库的优势所在。

ZLogger 集成方案

基础集成方式

通过 ConsoleAppFilter 可以轻松替换默认日志实现：

internal sealed class ReplaceLogFilter(ConsoleAppFilter next, ILogger<Program> logger)
    : ConsoleAppFilter(next)
{
    public override Task InvokeAsync(ConsoleAppContext context, CancellationToken cancellationToken)
    {
        ConsoleApp.Log = msg => logger.ZLogInformation($"{msg}");
        ConsoleApp.LogError = msg => logger.ZLogError($"{msg}");
        return Next.InvokeAsync(context, cancellationToken);
    }
}

为什么使用 ZLogger 的字符串插值

ZLogger 的核心优势在于其高性能的字符串插值日志记录：

1. 避免不必要的字符串分配
2. 支持结构化日志
3. 提供丰富的日志模板功能

// 使用 ZLogger 的字符串插值特性
logger.ZLogInformation($"用户 {userId} 执行了 {action} 操作");

更优雅的日志实践

虽然可以通过 Filter 替换默认日志实现，但更推荐的做法是：

1. 直接注入 ILogger<T> 使用
2. 充分利用 ZLogger 的高级特性
3. 仅在必要时处理框架自身的日志输出

public class MyCommand : ConsoleAppBase
{
    private readonly ILogger<MyCommand> _logger;
    
    public MyCommand(ILogger<MyCommand> logger)
    {
        _logger = logger;
    }
    
    public void Run()
    {
        _logger.ZLogInformation("业务逻辑开始执行");
        // ...
    }
}

性能优化建议

1. 避免在日志委托中进行复杂处理
2. 使用 ZLogger 的延迟评估特性
3. 合理配置日志级别以减少不必要的日志记录

总结

ConsoleAppFramework 与 ZLogger 的组合为 .NET 控制台应用提供了强大而高效的日志解决方案。通过理解框架的日志机制和 ZLogger 的优势，开发者可以构建出既灵活又高性能的日志系统。在实际项目中，建议优先使用直接注入 ILogger 的方式，仅在需要处理框架内部日志时才考虑替换默认实现。