在 ASP.NET Core 中，日志（Logging） 是一个内置且高度可扩展的机制，用于记录应用程序的运行时信息、错误、警告或其他调试数据。它帮助开发者监控和诊断应用行为，尤其在开发、测试和生产环境中至关重要。

本文将全面介绍 ASP.NET Core 的日志系统，包括核心组件、配置方式、使用方法、第三方集成以及最佳实践。

一、日志框架概述

ASP.NET Core 使用 Microsoft.Extensions.Logging 命名空间来实现其日志功能，主要包括以下核心组件：

o ILogger 接口：定义了日志记录的方法，如 LogInformation, LogError 等。
o ILoggerFactory：负责创建 ILogger 实例，管理日志提供程序。
o ILoggerProvider：日志提供程序接口，决定日志输出的目标（控制台、文件、数据库等）。
o LogLevel 枚举：表示日志的严重性级别，按优先级从低到高如下：

o Trace（0）
o Debug（1）
o Information（2）
o Warning（3）
o Error（4）
o Critical（5）
o None（6）

这些组件协同工作，使得日志系统既灵活又易于扩展。

二、内置日志提供程序

ASP.NET Core 提供了多种内置的日志提供程序，适用于不同场景：

提供程序描述Console输出日志到控制台，适合开发与调试Debug输出到 Visual Studio 的“输出”窗口EventSource跨平台事件跟踪工具EventLog（仅限 Windows）写入 Windows 事件日志Application Insights微软云端监控服务，适用于生产环境

此外，你还可以通过 NuGet 包引入第三方日志库，如 Serilog, NLog, log4net 等，以增强日志功能。

三、配置日志

3.1 通过appsettings.json配置

这是最推荐的方式，支持按命名空间设置日志级别和提供程序：

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "MyApp.Controllers": "Debug"
    },
    "Console": {
      "IncludeScopes": true,
      "LogLevel": {
        "Default": "Debug"
      }
    }
  }
}

o Default: 默认日志级别。
o Microsoft: 控制 Microsoft 框架内部日志。
o Console: 设置特定提供程序的日志级别。

3.2 在代码中配置

你也可以在 Program.cs 或 Startup.cs 中手动配置日志：

builder.Services.AddLogging(logging =>
{
    logging.ClearProviders(); // 清除默认提供程序
    logging.AddConsole();     // 添加控制台日志
    logging.AddDebug();       // 添加调试日志
    logging.SetMinimumLevel(LogLevel.Information); // 设置全局最低日志级别
});

四、使用日志

ASP.NET Core 支持通过依赖注入获取 ILogger<T>，其中 T 是调用类的类型，用于标识日志来源。

4.1 在控制器中使用日志

public class HomeController : Controller
{
    private readonly ILogger<HomeController> _logger;

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

    public IActionResult Index()
    {
        _logger.LogInformation("Index page accessed at {Time}", DateTime.Now);
        return View();
    }
}

4.2 日志方法示例

_logger.LogTrace("Trace message");
_logger.LogDebug("Debug message");
_logger.LogInformation("Info message");
_logger.LogWarning("Warning message");
_logger.LogError("Error message");
_logger.LogCritical("Critical error occurred");

4.3 结构化日志（Structured Logging）

使用参数化日志，便于后期查询和分析：

_logger.LogInformation("User {UserId} logged in at {Time}", userId, DateTime.Now);

4.4 记录异常信息

try
{
    // 可能抛出异常的代码
}
catch (Exception ex)
{
    _logger.LogError(ex, "An error occurred while processing the request");
}

达永编程网

程序员技术分享与交流平台

ASP.NET Core 日志(Logging)详解:从基础到实战