C#怎么使用Microsoft.Extensions.Logging .NET通用日志框架用法

.NET中推荐使用Microsoft.Extensions.Logging实现轻量可扩展的日志功能,支持Console、Debug等提供程序,通过依赖注入ILogger并配置级别与过滤规则实现结构化日志。

在.NET中使用 Microsoft.Extensions.Logging 是标准且推荐的日志方式,它轻量、可扩展、支持多种日志提供程序(如 Console、Debug、EventLog、第三方如 Serilog),且与 ASP.NET Core 深度集成。核心在于配置 ILogger 实例并注入使用,不依赖具体实现。

1. 安装必要 NuGet 包

确保项目引用以下基础包(.NET 5+ 通常已内置,但显式安装更稳妥):

  • Microsoft.Extensions.Logging(核心接口和抽象)
  • Microsoft.Extensions.Logging.Console(控制台输出,开发常用)
  • Microsoft.Extensions.Logging.Debug(输出到 Visual Studio 输出窗口)

可通过包管理器命令安装:

Install-Package Microsoft.Extensions.Logging.Console

2. 创建和配置 ILogger 实例

最常见的是在 Program.cs(.NET 6+)中配置日志服务:

var builder = WebApplication.CreateBuilder(args);

// 日志配置已默认添加,可进一步自定义 builder.Logging.ClearProviders(); // 可选:清空默认提供程序 builder.Logging.AddConsole(); // 添加控制台日志 builder.Logging.AddDebug(); // 添加调试日志

var app = builder.Build();

非 Web 场景(如控制台应用)可手动构建 IServiceCollection

var services = new ServiceCollection();
services.AddLogging(builder =>
{
    builder.AddConsole();
    builder.SetMinimumLevel(LogLevel.Information);
});

var provider = services.BuildServiceProvider(); var logger = provider.GetRequiredService>(); logger.LogInformation("Hello from console app!");

3. 在类中注入并使用 ILogger

推荐按类型注入,避免静态或全局 logger:

public class UserService
{
    private readonly ILogger _logger;
public UserService(ILogger logger)
{
    _logger = logger;
}

public void AddUser(string name)
{
    _logger.LogInformation("Adding user: {Name}", name);
    _logger.LogWarning("User {Name} already exists", name);
    _logger.LogError(new Exception("DB timeout"), "Failed to save user {Name}", name);
}

}

注意:
- 使用占位符 {Name} 而非字符串拼接,支持结构化日志(便于后续分析)
- 日志级别有 Trace/Debug/Information/Warning/Error/Critical,按需选择
- 异常应传入 LogError(Exception, ...) 重载,确保堆栈被记录

4. 配置日志级别和过滤规则

可在 appsettings.json 中精细化控制:

"Logging": {
  "LogLevel": {
    "Default": "Information",
    "Microsoft.AspNetCore": "Warning",
    "MyApp.Services.UserService": "Debug"
  }
}

也可代码中配置:

builder.Logging.AddFilter("MyApp.Services", LogLevel.Debug);
builder.Logging.AddFilter(level => level >= LogLevel.Warning);

过滤器支持按类别名、提供程序类型或委托判断,灵活应对不同环境需求。

基本上就这些。用好 ILogger 的关键不是功能多,而是统一入口、结构化输出、按需分级、配置驱动——不复杂但容易忽略细节。