.NET Core 里的优秀日志框架Serilog、NLog、Log4Net、Microsoft.Extensions.Logging

在.NET Core中，Serilog、NLog、Log4Net、Microsoft.Extensions.Logging都是流行的日志记录框架，它们各自具有不同的特点和用法。以下是对这些日志框架使用方法的概述：

目录

1. Serilog

2. NLog

3. Log4Net

4. Microsoft.Extensions.Logging

---

1. Serilog

特点：

• 可配置性强，支持链式调用。
• 可以自定义日志格式和输出方式。

使用方法：

1. 安装NuGet包：
   • 使用NuGet包管理器安装Serilog和Serilog.Sinks.Console（或其他所需的Sinks，如文件、数据库等）。
2. 配置Serilog：
   • 在程序入口（如Program.cs中的Main方法或.NET Core项目的Startup.cs中）配置Serilog。
   • 使用LoggerConfiguration类配置日志级别、输出格式和Sinks。
3. 记录日志：
   • 使用Log.Information()、Log.Warning()、Log.Error()等方法记录日志。

示例代码（基于.NET Core 6.0及以上版本）：

using Serilog;  
  
class Program  
{  
    public static void Main(string[] args)  
    {  
        Log.Logger = new LoggerConfiguration()  
            .MinimumLevel.Debug()  
            .WriteTo.Console()  
            .CreateLogger();  
  
        Log.Information("Hello, Serilog!");  
  
        // 确保在应用程序退出前刷新并停止内部定时器和线程  
        Log.CloseAndFlush();  
    }  
}

2. NLog

特点：

• 配置简单，易于使用。
• 支持多种输出方式，包括控制台、文件、数据库等。

使用方法：

1. 安装NuGet包：
   • 使用NuGet包管理器安装NLog和NLog.Web.AspNetCore（对于ASP.NET Core项目）。
2. 添加NLog配置文件（如nlog.config）：
   • 在项目根目录下创建nlog.config文件，并配置日志目标（targets）和规则（rules）。
3. 配置NLog：
   • 在Program.cs中配置NLog，通常是通过NLogBuilder.ConfigureNLog("nlog.config")方法。
4. 记录日志：
   • 使用ILogger接口或NLog的Logger类记录日志。

示例代码（基于ASP.NET Core）：

using NLog.Web;  
  
public class Program  
{  
    public static void Main(string[] args)  
    {  
        var logger = NLogBuilder.ConfigureNLog("nlog.config").GetCurrentClassLogger();  
  
        // ... 其他代码  
  
        logger.Info("Hello, NLog!");  
  
        // 确保在应用程序退出时正确关闭NLog  
        NLog.LogManager.Shutdown();  
    }  
}

3. Log4Net

特点：

• 稳定性高，配置灵活。
• 支持多种输出方式，包括控制台、文件、数据库等。

使用方法：

1. 安装NuGet包：
   • 使用NuGet包管理器安装log4net。
2. 添加配置文件（如log4net.config）：
   • 在项目根目录下创建log4net.config文件，并配置appender、logger等。
3. 配置Log4Net：
   • 在程序入口或全局位置使用XmlConfigurator.Configure方法加载配置文件。
4. 记录日志：
   • 使用ILog接口记录日志。

示例代码（基于.NET Core）：

using log4net;  
using log4net.Config;  
  
public class Program  
{  
    private static readonly ILog logger = LogManager.GetLogger(typeof(Program));  
  
    public static void Main(string[] args)  
    {  
        XmlConfigurator.Configure(new FileInfo("log4net.config"));  
  
        // ... 其他代码  
  
        logger.Info("Hello, Log4Net!");  
    }  
}

4. Microsoft.Extensions.Logging

特点：

• Microsoft.Extensions.Logging 是 .NET Core 自带的日志框架，它提供了一个通用的日志记录接口，允许开发者通过不同的日志提供者（如控制台、文件、第三方库等）来实现日志记录。
• 它易于集成，并支持 .NET Core 的依赖注入框架。

使用方法：

1. 安装 NuGet 包：
   • 对于 Microsoft.Extensions.Logging 本身，通常不需要单独安装 NuGet 包，因为它已经包含在 .NET Core 的基础库中。
   • 如果需要使用特定的日志提供者（如控制台、文件等），则需要安装相应的 NuGet 包，如 Microsoft.Extensions.Logging.Console、Microsoft.Extensions.Logging.File（注意：Microsoft.Extensions.Logging.File 并不是官方直接提供的包，通常需要使用第三方库如 Serilog.Sinks.File 或 NLog 的文件目标来实现文件日志记录）。
2. 配置日志提供者：
   • 在应用程序的启动过程中，通常是在 Program.cs 文件的 Main 方法或 CreateHostBuilder 方法中配置日志提供者。
   • 使用 LoggerFactory 类创建日志工厂，并通过其 Add 方法添加所需的日志提供者。例如，要添加控制台日志提供者，可以使用 builder.AddConsole()。
3. 记录日志：
   • 使用 ILogger<TCategoryName> 接口的实例来记录日志。通常，这个实例是通过依赖注入获取的，或者是在需要的地方通过 LoggerFactory 创建的。
   • 使用 LogInformation、LogWarning、LogError 等方法记录不同级别的日志。

示例代码（基于 .NET Core 6.0 及以上版本，使用控制台日志提供者）：

using Microsoft.Extensions.Logging;  
  
var loggerFactory = LoggerFactory.Create(builder =>  
{  
    builder  
        .AddFilter((category, level) =>  
            category == "MyCategory" && level >= LogLevel.Information) // 可选：添加过滤器  
        .AddConsole(); // 添加控制台日志提供者  
});  
  
var logger = loggerFactory.CreateLogger<Program>();  
  
logger.LogInformation("Hello, this is an informational message!");  
logger.LogWarning("This is a warning message.");  
logger.LogError("Oops! Something went wrong.");

注意：

• 在实际应用中，你可能会使用 .NET Core 的依赖注入框架来自动管理 ILogger<TCategoryName> 的实例，而不是手动创建它们。
• Microsoft.Extensions.Logging 允许你通过配置文件（如 appsettings.json）来配置日志提供者，但这通常是通过集成第三方日志库（如 Serilog、NLog）来实现的，因为 Microsoft.Extensions.Logging 本身并不直接支持从配置文件中读取配置。
• 如果你需要更复杂的日志记录功能（如日志轮转、日志压缩、异步日志记录等），你可能需要选择 Serilog、NLog 或 Log4Net 等更高级的日志框架。