.net 温故知新：【9】.NET日志记录 ILogger使用和原理

日志作为程序记录的“黑匣子”，在任何系统中都应被广泛使用，例如常用的log4net就是一个第三方日志记录工具。.net 支持多种内置和第三方日志记录提供程序的 api，本文将重点介绍内置提供程序及其api的使用，并探讨它们的实现方式。

在日志记录过程中，我们可以对日志信息进行优先级划分，这种优先级设置在使用log4net时尤为常见。通过设定优先级，我们可以配置系统只记录特定优先级的日志，同时日志信息也会标记其优先级，这在排查问题时有助于更有效地筛选和定位。

在.NET 中，日志优先级（LogLevel）分为以下几个级别：

• 错误（Error）
• 警告（Warning）
• 信息（Information）
• 调试（Debug）
• 跟踪（Trace）

接下来，我们将通过一个.NET 6 控制台程序示例来展示如何使用内置提供程序记录日志。

首先，我们需要添加日志基础包和控制台输出日志提供程序包：

• Install-Package Microsoft.Extensions.Logging
• Install-Package Microsoft.Extensions.Logging.Console

然后，通过DI注入的方式添加控制台输出日志提供程序：

ServiceCollection services = new ServiceCollection();
services.AddLogging(loggingBuilder => {
    loggingBuilder.AddConsole();
});

通过容器提供程序，我们可以直接获取日志对象并调用写日志方法。

更常见的是在其他类中通过构造函数注入的方式使用DI中的ILogger对象（TCategoryName 类别字符串通常使用类名称，以便在日志中识别输出来源）。

public class TestLog {
    private readonly ILogger _logger;
    public TestLog(ILogger<TestLog> logger) {
        _logger = logger;
    }
    public void Test() {
        _logger.LogDebug("测试");
    }
}

需要注意的是，如果未设置默认日志级别，则默认级别为 Information，因此控制台只会输出大于或等于 Information 级别的日志。

通过代码设置日志级别：

日志设计的原理可以用以下逻辑图表示，该图梳理了日志实现的过程，代码部分截取自.NET源码。

达芬奇

达芬奇——你的AI创作大师

144

查看详情

通过上述流程我们了解到，日志对象是由LoggerFactory类创建的，因此我们也可以不使用注入的方式，直接获取日志对象并写日志。

var loggerFactory = LoggerFactory.Create(builder => {
    builder.AddConsole();
    builder.SetMinimumLevel(LogLevel.Debug);
});
ILogger logger = loggerFactory.CreateLogger<Program>();

目前，内置的日志记录提供程序包括：

• Console：将输出记录到控制台。
• Debug：使用 System.Diagnostics.Debug 类写入日志输出。
• EventSource：写入名称为 Microsoft-Extensions-Logging 的跨平台事件源。
• EventLog：将日志输出发送到 Windows 事件日志。

例如，在测试中添加一个EventLog以将日志写入Windows事件日志：

• 安装提供程序包：Install-Package Microsoft.Extensions.Logging.EventLog

内置程序未提供将日志记录到文件的功能，因此我们可以使用一些第三方包，或者自己开发。

查看地址：三方包

在上一篇关于.NET配置的文章中，我们也见到了提供程序的概念，或者说是这种设计结构，实际上.NET中许多地方都采用了提供程序的思维方式，从而实现灵活扩展。

以上就是.net 温故知新：【9】.NET日志记录 ILogger使用和原理的详细内容，更多请关注php中文网其它相关文章！