LyuLogExtension 1.2.1

LogExtension

基于 ZLogger 高性能的日志简易扩展库，内置简单配置的日志记录功能，支持工厂模式和依赖注入两种使用方式。

特性

• 🚀 双模式支持：支持工厂模式和依赖注入两种使用方式
• 📝 自动日志分级：Trace/Debug 和 Info 及以上级别分别输出到不同文件
• 🔄 滚动日志：按小时自动滚动，单文件最大 2MB
• 🧵 线程安全：支持多线程并发日志记录
• 📍 调用位置追踪：自动记录类名和行号
• ⚡ 高性能：基于 ZLogger 的高性能日志框架
• ⚙️ 灵活配置：支持 appsettings.json 或代码配置，可自定义日志级别和过滤规则

依赖项

依赖Zlogger 感谢Zlogger研发团队 ： https://github.com/Cysharp/ZLogger

使用方式

方式一：工厂模式（静态使用）

适用于不使用依赖注入的场景，如控制台应用、类库等。

基本用法

using LogExtension;

// 获取日志记录器
var logger = ZlogFactory.Get<Program>();

// 记录日志
logger.LogInformation("应用启动");
logger.LogDebug("调试信息: {Value}", 42);
logger.LogWarning("警告信息");
logger.LogError(exception, "发生错误");

自定义工厂

如果需要自定义日志配置，可以设置自己的 LoggerFactory：

using Microsoft.Extensions.Logging;
using ZLogger;

// 创建自定义工厂
var customFactory = LoggerFactory.Create(logging =>
{
    logging.SetMinimumLevel(LogLevel.Debug);
    logging.AddZLoggerConsole();
    logging.AddZLoggerFile("logs/custom.log");
});

// 设置全局工厂
ZlogFactory.SetFactory(customFactory);

// 之后所有通过 ZlogFactory.Get<T>() 获取的 logger 都会使用自定义配置
var logger = ZlogFactory.Get<MyClass>();

方式二：依赖注入（DI）

适用于 ASP.NET Core、Worker Service 等支持依赖注入的场景。

注册服务

在 Program.cs 或 Startup.cs 中注册日志服务：

using LogExtension;

var builder = WebApplication.CreateBuilder(args);

// 添加 ZLogger 日志服务（使用默认配置）
builder.Services.AddZLogger();

var app = builder.Build();

使用自定义配置

using LogExtension;
using Microsoft.Extensions.Logging;

var builder = WebApplication.CreateBuilder(args);

// 创建自定义工厂
var customFactory = LoggerFactory.Create(logging =>
{
    logging.SetMinimumLevel(LogLevel.Information);
    logging.AddZLoggerConsole();
});

// 使用自定义工厂注册
builder.Services.AddZLogger(customFactory);

var app = builder.Build();

在类中注入使用

public class MyService
{
    private readonly ILogger<MyService> _logger;

    public MyService(ILogger<MyService> logger)
    {
        _logger = logger;
    }

    public void DoWork()
    {
        _logger.LogInformation("开始执行任务");
        _logger.LogDebug("处理数据: {Count}", 100);
        _logger.LogInformation("任务完成");
    }
}

在控制器中使用

[ApiController]
[Route("api/[controller]")]
public class WeatherController : ControllerBase
{
    private readonly ILogger<WeatherController> _logger;

    public WeatherController(ILogger<WeatherController> logger)
    {
        _logger = logger;
    }

    [HttpGet]
    public IActionResult Get()
    {
        _logger.LogInformation("获取天气数据");
        return Ok(new { Temperature = 25 });
    }
}

配置方式

方式一：通过 appsettings.json 配置（推荐）

这是最简单的配置方式，支持热重载，修改配置文件后自动生效。

1. 在 Program.cs 中注册服务

builder.Services.AddZLogger();

2. 在项目根目录创建或修改 appsettings.json

{
  "ZLogger": {
    "LogLevel": {
      "Default": "Information",
      "System.Net.Http.HttpClient": "Warning",
      "Microsoft.EntityFrameworkCore.Database.Command": "Warning",
      "Microsoft.AspNetCore": "Warning"
      //或者其他
    }
  }
}

配置说明：

• Default: 默认日志级别
• System.Net.Http.HttpClient: 屏蔽 HttpClient 的 Information 级别日志
• Microsoft.EntityFrameworkCore.Database.Command: 屏蔽 EF Core SQL 命令日志
• Microsoft.AspNetCore: 屏蔽 ASP.NET Core 框架日志

方式二：通过代码配置

使用 Action 配置

builder.Services.AddZLogger(config =>
{
    // 设置默认最低日志级别
    config.MinimumLevel = LogLevel.Information;
    
    // 添加类别过滤器（屏蔽 HttpClient 日志）
    config.CategoryFilters["System.Net.Http.HttpClient"] = LogLevel.Warning;
    config.CategoryFilters["Microsoft.EntityFrameworkCore"] = LogLevel.Warning;
    
    // 如果不想从 appsettings.json 读取配置，可设置为 false
    config.UseConfigurationFile = false;
});

使用配置对象

var logConfig = new ZLoggerConfig
{
    MinimumLevel = LogLevel.Information,
    CategoryFilters = new Dictionary<string, LogLevel>
    {
        ["System.Net.Http.HttpClient"] = LogLevel.Warning,
        ["Microsoft.EntityFrameworkCore"] = LogLevel.Warning
    },
    UseConfigurationFile = false
};

builder.Services.AddZLogger(logConfig);

方式三：全局配置（工厂模式）

在应用启动时配置全局日志设置：

// 使用 Action 配置
ZlogFactory.ConfigureDefaults(config =>
{
    config.CategoryFilters["System.Net.Http.HttpClient"] = LogLevel.Warning;
    config.UseConfigurationFile = true;
});

// 然后正常使用
var logger = ZlogFactory.Get<MyClass>();
logger.LogInformation("这是一条日志");

常见日志类别名称

日志输出

默认配置

• Trace/Debug 日志：输出到 logs/trace/ 目录
• Info 及以上日志：输出到 logs/ 目录
• 滚动策略：每小时自动滚动，单文件超过 2MB 时自动创建新文件
• 文件名格式：yyyy-MM-dd-HH_001.log

日志格式

2024-11-15 14:30:25.123 [INF] [MyNamespace.MyClass:42] 这是日志消息
2024-11-15 14:30:26.456 [ERR] [MyNamespace.MyClass:45] 发生错误
异常: System.InvalidOperationException: 操作无效
堆栈: at MyNamespace.MyClass.Method() in C:\Path\To\File.cs:line 45

格式说明：

• 时间戳（本地时间）
• 日志级别（3 字符缩写：TRC/DBG/INF/WRN/ERR/CRT）
• 类名和行号
• 日志消息
• 异常信息（如果有）

使用结构化日志

// 推荐：使用占位符
logger.LogInformation("用户 {UserId} 下载了文件 {FileName}，大小: {FileSize} bytes", 
    userId, fileName, fileSize);

// 不推荐：字符串拼接
logger.LogInformation($"用户 {userId} 下载了文件 {fileName}，大小: {fileSize} bytes");

如何完全禁用某个类别的日志？

设置日志级别为 None：

{
  "ZLogger": {
    "LogLevel": {
      "System.Net.Http.HttpClient": "None"
    }
  }
}

或者通过代码：

config.CategoryFilters["System.Net.Http.HttpClient"] = LogLevel.None;

License

MIT License

相关链接

• ZLogger 官方文档
• Microsoft.Extensions.Logging 文档