当前位置：首页 > news >正文

＜C#＞在 C# .NET 中,使用 LoggerExtensions方法创建日志

news 来源：原创 2025/6/7 21:21:26

在 C# .NET 中，LoggerExtensions 是 Microsoft.Extensions.Logging 命名空间下的一组扩展方法，它们为 ILogger 接口提供了便捷的日志记录方式。借助这些扩展方法，你能轻松记录不同级别的日志，如调试信息、信息、警告、错误等。下面为你详细介绍其用法：

1. 引入必要的命名空间

在使用 LoggerExtensions 之前，需要引入 Microsoft.Extensions.Logging 命名空间。

using Microsoft.Extensions.Logging;

2. 创建 `ILogger` 实例

在 .NET 应用程序里，通常通过依赖注入的方式获取 ILogger 实例。以下是一个简单的控制器示例：

using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;

namespace YourNamespace.Controllers
{
    [ApiController]
    [Route("[controller]")]
    public class HomeController : ControllerBase
    {
        private readonly ILogger<HomeController> _logger;

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

        // 后续使用 _logger 进行日志记录
    }
}

3. 使用 `LoggerExtensions` 记录不同级别的日志

3.1 调试日志

LogDebug 方法用于记录调试信息，这类信息通常在开发和调试阶段使用。

[HttpGet("debug")]
public IActionResult LogDebugMessage()
{
    _logger.LogDebug("这是一条调试日志信息");
    return Ok();
}

3.2 信息日志

LogInformation 方法用于记录一般的信息，例如系统启动、用户登录等操作。

[HttpGet("info")]
public IActionResult LogInformationMessage()
{
    _logger.LogInformation("这是一条信息日志信息");
    return Ok();
}

3.3 警告日志

LogWarning 方法用于记录可能会导致问题的情况，但不会影响系统的正常运行。

[HttpGet("warning")]
public IActionResult LogWarningMessage()
{
    _logger.LogWarning("这是一条警告日志信息");
    return Ok();
}

3.4 错误日志

LogError 方法用于记录系统中出现的错误信息，如异常等。

[HttpGet("error")]
public IActionResult LogErrorMessage()
{
    try
    {
        throw new Exception("模拟一个异常");
    }
    catch (Exception ex)
    {
        _logger.LogError(ex, "这是一条错误日志信息，发生异常: {Message}", ex.Message);
        return StatusCode(500, "发生错误");
    }
}

3.5 严重错误日志

LogCritical 方法用于记录系统中发生的严重错误，可能会导致系统无法正常运行。

[HttpGet("critical")]
public IActionResult LogCriticalMessage()
{
    _logger.LogCritical("这是一条严重错误日志信息");
    return Ok();
}

4. 日志模板和参数化日志

LoggerExtensions 支持使用日志模板和参数化日志，这样能更清晰地记录日志信息。

[HttpGet("parametrized")]
public IActionResult LogParametrizedMessage()
{
    string username = "JohnDoe";
    int userId = 123;
    _logger.LogInformation("用户 {Username} (ID: {UserId}) 登录系统", username, userId);
    return Ok();
}