不要用第三方日誌包了Microsoft.Extensions.Logging功能就很強大

架構師老盧發表於2023-12-05
ROS

在.NET中，
Microsoft.Extensions.Logging是一個廣泛使用的日誌庫，用於記錄應用程式的日誌資訊。它提供了豐富的功能和靈活性，使開發人員能夠輕鬆地記錄各種型別的日誌，並將其輸出到不同的目標，包括日誌檔案。本文將詳細介紹Microsoft.Extensions.Logging的各種基礎功能以及如何按天生成日誌檔案。

一、Microsoft.Extensions.Logging基礎功能

1. 建立Logger

首先，我們需要建立一個Logger例項，以便在應用程式中記錄日誌。以下是建立Logger的基本方法：

using Microsoft.Extensions.Logging;

var loggerFactory = LoggerFactory.Create(builder =>
{
    builder.AddConsole(); // 輸出日誌到控制檯
});

var logger = loggerFactory.CreateLogger<Program>();

在上面的示例中，我們首先建立了一個LoggerFactory例項，然後透過它建立了一個Logger。我們還使用AddConsole方法將日誌輸出到控制檯。

2. 記錄日誌訊息

一旦有Logger例項，我們可以使用它來記錄不同級別的日誌訊息。
Microsoft.Extensions.Logging定義了以下日誌級別（按嚴重性遞增排列）：

  • Trace
  • Debug
  • Information
  • Warning
  • Error
  • Critical

下面是如何使用Logger記錄不同級別的日誌訊息的示例：

logger.LogInformation("這是一條資訊日誌");
logger.LogWarning("這是一條警告日誌");
logger.LogError("這是一條錯誤日誌");
logger.LogCritical("這是一條嚴重錯誤日誌");

3. 提供上下文資訊

通常，我們需要將一些上下文資訊記錄到日誌中，以幫助排查問題。可以使用LogInformation等方法的過載版本，傳遞額外的引數，如下：

var userId = 123;
logger.LogInformation("使用者 {UserId} 登入成功", userId);

在上述示例中，我們將userId作為引數傳遞給日誌訊息，以便將其包含在日誌中。

4. 使用日誌範圍

有時，我們希望在一段程式碼塊中記錄一組相關日誌訊息，並希望這些訊息具有相同的上下文資訊。這時可以使用LogScope，如下所示：

using (logger.BeginScope("交易處理 - 訂單 {OrderId}", orderId))
{
    logger.LogInformation("訂單處理中...");
    // 執行一些訂單處理邏輯
    logger.LogInformation("訂單處理完成");
}

在上述示例中，我們使用BeginScope方法建立了一個日誌範圍，將其包含在指定的上下文資訊中。在範圍內的所有日誌訊息都會自動包含這些上下文資訊。

5. 配置日誌級別

我們可以在應用程式中配置所需的最低日誌級別，以決定哪些日誌訊息將被記錄。通常，這是在應用程式的配置檔案中完成的。以下是一個示例：

var loggerFactory = LoggerFactory.Create(builder =>
{
    builder.AddConsole();
    builder.SetMinimumLevel(LogLevel.Information); // 設定最低日誌級別
});

在上述示例中，我們使用SetMinimumLevel方法來配置最低日誌級別。只有達到或高於指定級別的日誌訊息才會被記錄。

二、按天生成日誌檔案

現在，讓我們來看看如何按天生成日誌檔案。通常，我們會希望將日誌訊息記錄到檔案中，並按日期對日誌檔案進行歸檔。

1. 安裝相關包

首先，我們需要安裝一些必要的包，以便實現按天生成日誌檔案。使用NuGet包管理器或.NET CLI可以輕鬆完成這一步驟：

dotnet add package Karambolo.Extensions.Logging.File

2. 配置檔案日誌提供程式

接下來，我們需要配置檔案日誌提供程式，以便將日誌訊息記錄到檔案中。以下是如何配置檔案提供程式的示例：

var loggerFactory = LoggerFactory.Create(builder =>
{
    builder.AddFile("logs/myapp-{Date}.txt");
    builder.SetMinimumLevel(LogLevel.Information);
});

在上述示例中，我們使用AddFile方法配置檔案日誌提供程式，並指定日誌檔案的名稱模式。{Date}將根據日誌訊息的日期自動替換為實際日期。

3. 示例程式碼

以下是一個完整的示例程式碼，演示瞭如何使用
Microsoft.Extensions.Logging按天生成日誌檔案：

using System;
using Microsoft.Extensions.Logging;
using Karambolo.Extensions.Logging.File;

class Program
{
    static void Main()
    {
        var loggerFactory = LoggerFactory.Create(builder =>
        {
            builder.AddFile("logs/myapp-{Date}.txt");
            builder.SetMinimumLevel(LogLevel.Information);
        });

        var logger = loggerFactory.CreateLogger<Program>();

        for (int i = 0; i < 10; i++)
        {
            logger.LogInformation("這是一條資訊日誌 - {LogCount}", i);
        }
    }
}

上述示例中，我們配置了檔案日誌提供程式，日誌檔案的名稱模式包含了{Date}，並迴圈記錄了10條日誌訊息。每天，日誌檔案將被歸檔到不同的檔案中，以便跟蹤和檢查以前的日誌。


Microsoft.Extensions.Logging是.NET中強大的日誌庫，可以用於記錄各種型別的日誌訊息。透過配置檔案日誌提供程式，我們可以按天生成日誌檔案，以便更好地管理和分析日誌。

 

相關文章