C# 日誌記錄（開發者如何理解其工作原理）

撰寫日誌訊息

若要在 C# 中開始記錄日誌，開發人員需要在應用程式中撰寫日誌訊息。 這是透過使用日誌框架或 API 來完成的。 在 C# 中，一個受歡迎的選擇是 Microsoft 的 ILogger 介面，可在 Microsoft.Extensions.Logging 命名空間中取得。 此介面提供一種簡單的方式，可記錄不同重要性層級的資料，這些層級稱為日誌層級。 這些層級包括資訊、除錯和錯誤，有助於根據記錄訊息的嚴重程度來分類和過濾日誌輸出。

using Microsoft.Extensions.Logging;

public class Program
{
    static void Main(string[] args)
    {
        // Create a logger instance with console output
        ILogger logger = LoggerFactory.Create(builder => 
        {
            builder.AddConsole(); // Add console as a logging target
        }).CreateLogger<Program>();

        // Log messages with different levels of severity
        logger.LogInformation("This is an information log message");
        logger.LogError("This is an error log message");
    }
}

using Microsoft.Extensions.Logging;

public class Program
{
    static void Main(string[] args)
    {
        // Create a logger instance with console output
        ILogger logger = LoggerFactory.Create(builder => 
        {
            builder.AddConsole(); // Add console as a logging target
        }).CreateLogger<Program>();

        // Log messages with different levels of severity
        logger.LogInformation("This is an information log message");
        logger.LogError("This is an error log message");
    }
}

在上面的範例中，名為 logger 的 ILogger 物件被設定為輸出日誌訊息到控制台。 這個設定很簡單，但卻是幫助您瞭解日誌訊息如何產生與顯示的基礎。

!a href="/static-assets/pdf/blog/csharp-logging/csharp-logging-1.webp">C# Logging (How It Works For Developers)：圖 1 - 包含日誌訊息的控制台輸出範例

記錄檔與提供者

在實際應用中，您經常需要將日誌訊息儲存在檔案或其他儲存系統中，以便日後檢視。 這就是記錄提供者發揮作用的地方。 提供者是日誌框架的元件，用來處理日誌資料輸出到各種目的地，例如檔案、資料庫或外部服務。

例如，若要設定記錄器將訊息寫入檔案，您可能會使用類似 FileLoggerProvider的檔案型提供者。 這需要修改應用程式的組態檔案 (在 .NET 應用程式中通常為 appsettings.json)，以指定日誌檔案路徑和最低日誌層級等細節。

{
  "Logging": {
    "LogLevel": {
      "Default": "Information", // Log levels for the application
      "Microsoft": "Warning"   // Log levels for Microsoft libraries
    },
    "File": {
      "Path": "logs/myapp.log" // File path for the log file
    }
  }
}

配置指定所有預設日誌應為"資訊"層級，但 Microsoft 的函式庫只應記錄警告及以上的日誌。 它還會將日誌輸出導向 logs 目錄中名為 myapp.log 的日誌檔案。

進階記錄技術

除了基本的日誌訊息之外，C# 還支援結構化日誌，可在日誌中包含結構化資料，而不只是純文字。 結構化日誌讓搜尋和分析日誌資料變得更容易，因為每項上下文資訊都會儲存為獨立的欄位。

// Log message with structured data
logger.LogDebug("Processing order {OrderId} at {Timestamp}", orderId, DateTime.UtcNow);

// Log message with structured data
logger.LogDebug("Processing order {OrderId} at {Timestamp}", orderId, DateTime.UtcNow);

在這個結構化日誌範例中，OrderId 和 Timestamp是訊息範本中的占位符，將分別填入 orderId 和 DateTime.UtcNow 的值。 這比傳統的日誌功能更強大，因為它允許根據每個日誌項目內的特定欄位，更輕鬆地查詢和處理日誌資料。

與外部系統整合

C# 日誌可擴充至與 SQL Server 或 Windows Event Log 等外部系統整合，強化日誌資料的管理與分析方式。 透過使用專門的日誌提供者，日誌訊息可以直接傳送到這些系統，提供更強大的錯誤監控與回應能力。

// Direct log output to the Windows Event Log under a specific source name
builder.AddEventLog(new EventLogSettings
{
    SourceName = "MyApplication"
});

// Direct log output to the Windows Event Log under a specific source name
builder.AddEventLog(new EventLogSettings
{
    SourceName = "MyApplication"
});

此設定片段會將日誌輸出導向 Windows Event Log，來源名稱為 "MyApplication"。 這對於在 Windows 伺服器上執行的應用程式特別有用，在 Windows 伺服器上，事件日誌是監控軟體和系統訊息的集中工具。

程式碼範例

要在使用 IronPDF 的同時使用 C# 日誌，您需要在 PDF 作業中加入日誌呼叫。 以下是如何在 .NET 應用程式中整合這兩種技術的範例。 本範例假設您使用 Microsoft.Extensions.Logging 中的 ILogger 介面。

using IronPdf;
using Microsoft.Extensions.Logging;
using System;

public class PdfGenerator
{
    private readonly ILogger _logger;

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

    public void CreatePdfFromHtml(string htmlContent, string outputPath)
    {
        try
        {
            // Initialize PDF renderer
            var renderer = new ChromePdfRenderer();

            // Convert HTML content to PDF
            var pdf = renderer.RenderHtmlAsPdf(htmlContent);

            // Save the generated PDF to a file
            pdf.SaveAs(outputPath);

            // Log the success of PDF creation
            _logger.LogInformation("PDF created successfully at {OutputPath}", outputPath);
        }
        catch (Exception ex)
        {
            // Log any errors encountered during PDF creation
            _logger.LogError(ex, "Error creating PDF from HTML");
        }
    }
}

// Usage example
public class Program
{
    static void Main(string[] args)
    {
        // Set the license key for IronPDF, if applicable
        License.LicenseKey = "License-Key";

        // Create a logger factory to manage logging configurations
        ILoggerFactory loggerFactory = LoggerFactory.Create(builder =>
        {
            builder.AddConsole(); // Enable logging to the console
        });

        // Create a logger for the PdfGenerator class
        ILogger<PdfGenerator> logger = loggerFactory.CreateLogger<PdfGenerator>();

        // Instantiate the PDF generator
        PdfGenerator pdfGenerator = new PdfGenerator(logger);

        // Example HTML content and output path
        string htmlContent = "<h1>Hello, PDF!</h1><p>This is a simple PDF generated from HTML.</p>";
        string outputPath = "output.pdf";

        // Create a PDF from the provided HTML content
        pdfGenerator.CreatePdfFromHtml(htmlContent, outputPath);
    }
}

using IronPdf;
using Microsoft.Extensions.Logging;
using System;

public class PdfGenerator
{
    private readonly ILogger _logger;

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

    public void CreatePdfFromHtml(string htmlContent, string outputPath)
    {
        try
        {
            // Initialize PDF renderer
            var renderer = new ChromePdfRenderer();

            // Convert HTML content to PDF
            var pdf = renderer.RenderHtmlAsPdf(htmlContent);

            // Save the generated PDF to a file
            pdf.SaveAs(outputPath);

            // Log the success of PDF creation
            _logger.LogInformation("PDF created successfully at {OutputPath}", outputPath);
        }
        catch (Exception ex)
        {
            // Log any errors encountered during PDF creation
            _logger.LogError(ex, "Error creating PDF from HTML");
        }
    }
}

// Usage example
public class Program
{
    static void Main(string[] args)
    {
        // Set the license key for IronPDF, if applicable
        License.LicenseKey = "License-Key";

        // Create a logger factory to manage logging configurations
        ILoggerFactory loggerFactory = LoggerFactory.Create(builder =>
        {
            builder.AddConsole(); // Enable logging to the console
        });

        // Create a logger for the PdfGenerator class
        ILogger<PdfGenerator> logger = loggerFactory.CreateLogger<PdfGenerator>();

        // Instantiate the PDF generator
        PdfGenerator pdfGenerator = new PdfGenerator(logger);

        // Example HTML content and output path
        string htmlContent = "<h1>Hello, PDF!</h1><p>This is a simple PDF generated from HTML.</p>";
        string outputPath = "output.pdf";

        // Create a PDF from the provided HTML content
        pdfGenerator.CreatePdfFromHtml(htmlContent, outputPath);
    }
}

。

此設定不僅有助於從 HTML 生成 PDF，還可確保透過日誌對操作進行詳細記錄，有助於維護和故障排除。 將日誌與 IronPDF 整合，可大幅提升應用程式 PDF 處理功能的可靠性與可追蹤性。