NLog C#（开发者如何使用）

要创建 NLog 配置文件（通常命名为 nlog.config），您可以按照以下步骤进行。 此配置文件将指定 NLog 在应用程序中的行为方式，包括日志目标、布局渲染器和规则。

在您的项目中，右键单击项目或要创建配置文件的目标文件夹。

1. 选择"添加">"新建项目..."。
2. 在"添加新项目"对话框中，搜索"XML 文件"或"XML"并选择。

3. 将文件命名为 nlog.config 并单击"添加"按钮。

   

4. 使用文本编辑器或 XML 编辑器打开新创建的 nlog.config 文件。
5. 在 NLog.XML 文件中添加以下配置。下方是记录消息到控制台目标的 NLog 配置的基本示例。 您可以自定义此配置文件以满足您的需要：

配置文件

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

  <targets>

    <target name="console" xsi:type="Console" layout="${longdate}|${message}"/>
  </targets>

  <rules>

    <logger name="*" minlevel="Debug" writeTo="console" />
  </rules>

</nlog>

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

  <targets>

    <target name="console" xsi:type="Console" layout="${longdate}|${message}"/>
  </targets>

  <rules>

    <logger name="*" minlevel="Debug" writeTo="console" />
  </rules>

</nlog>

在您的 C# 代码中，确保从 nlog.config 文件加载 NLog 配置。您通常在应用程序的启动代码中执行此操作，例如在 ASP.NET Core Startup.cs（适用于与 .NET 5 相同或更旧的 .NET 版本）中，program.cs 文件（适用于 .NET 6 或更高版本），或控制台应用程序的 Main 方法：

using NLog;

internal class Program
{
    // Create an instance of the Logger
    private static Logger logger = LogManager.GetCurrentClassLogger();

    static void Main(string[] args)
    {
        // Log a debug message
        logger.Debug("This is a Debug Message");

        // Pause the console for viewing output
        Console.Read();
    }
}

using NLog;

internal class Program
{
    // Create an instance of the Logger
    private static Logger logger = LogManager.GetCurrentClassLogger();

    static void Main(string[] args)
    {
        // Log a debug message
        logger.Debug("This is a Debug Message");

        // Pause the console for viewing output
        Console.Read();
    }
}

上述程序的输出如下所示：

在此示例中，我们创建了一个 Logger 类的实例，并使用它记录 Debug Level 的消息。 让我们探索 NLog 支持的跟踪级别。

日志级别

NLog 支持多个日志级别，每个级别都有其自身的重要性：

1. Trace：最详细的级别，通常用于诊断。
2. Debug：用于调试信息，有助于开发。
3. Info：有关应用程序操作的一般信息。
4. Warn：指示不会影响应用程序的潜在问题。
5. Error：指示应调查的失败，但不一定会导致应用程序崩溃。
6. Fatal：表示应立即处理的严重失败。

通过将日志消息分类为这些级别，您可以根据严重性轻松过滤和优先排序它们。

在您的nLog.Config文件中的rules标签中设置 minlevel="Trace" 如下所示。

<rules>

  <logger name="*" minlevel="Trace" writeTo="console" />
</rules>

<rules>

  <logger name="*" minlevel="Trace" writeTo="console" />
</rules>

让我们编写代码来记录所有跟踪级别的消息。

using NLog;

internal class Program
{
    // Create an instance of the Logger
    private static Logger logger = LogManager.GetCurrentClassLogger();

    static void Main(string[] args)
    {
        // Log messages of different tracking levels
        logger.Trace("This is a Trace Message");
        logger.Debug("This is a Debug Message");
        logger.Info("This is an Info Message");
        logger.Warn("This is a Warning Message");
        logger.Error("This is an Error Message");
        logger.Fatal("This is a Fatal Message");

        // Pause the console for viewing output
        Console.Read();
    }
}

using NLog;

internal class Program
{
    // Create an instance of the Logger
    private static Logger logger = LogManager.GetCurrentClassLogger();

    static void Main(string[] args)
    {
        // Log messages of different tracking levels
        logger.Trace("This is a Trace Message");
        logger.Debug("This is a Debug Message");
        logger.Info("This is an Info Message");
        logger.Warn("This is a Warning Message");
        logger.Error("This is an Error Message");
        logger.Fatal("This is a Fatal Message");

        // Pause the console for viewing output
        Console.Read();
    }
}

我们的程序已在控制台中记录了消息，如下所示。

现在，我们已经演示了在控制台中记录消息的示例。 现在我们将配置一个 NLog 目标，将消息记录到文件中。

文件中日志消息

我们需要为文件日志记录在配置文件中设置文件目标，而不是控制台目标。

<targets>

  <target xsi:type="File" name="fileTarget" fileName="D:\Logs\mylog.txt" layout="${longdate} ${level:uppercase=true} ${message}" />
</targets>

<rules>

  <logger name="*" minlevel="Trace" writeTo="fileTarget" />
</rules>

<targets>

  <target xsi:type="File" name="fileTarget" fileName="D:\Logs\mylog.txt" layout="${longdate} ${level:uppercase=true} ${message}" />
</targets>

<rules>

  <logger name="*" minlevel="Trace" writeTo="fileTarget" />
</rules>

现在，运行程序以将消息记录到文件中。

日志目标

NLog 支持多种日志输出目标，让您选择日志消息应存储的位置。 一些常见的目标包括：

1. 文件：将消息记录到一个或多个文件。
2. 控制台：在控制台中记录消息。
3. 数据库：将消息记录到数据库（SQL Server, MySQL, Oracle, PostgreSQL 等）中。
4. 电子邮件：将日志消息以电子邮件形式发送。
5. 事件日志：将消息记录到 Windows 事件日志。
6. 自定义目标：您可以创建自定义日志目标以满足特定需求。

您可以配置 NLog 同时使用一个或多个目标。

带日志的 PDF 生成

Install-Package IronPdf

using NLog;
using IronPdf;

internal class Program
{
    // Create an instance of the Logger
    private static Logger logger = LogManager.GetCurrentClassLogger();

    static void Main(string[] args)
    {
        logger.Info("Initializing Chrome PDF Renderer");
        ChromePdfRenderer renderer = new ChromePdfRenderer();

        logger.Info("Creating PDF From HTML String");
        var pdf = renderer.RenderHtmlAsPdf("<h1>This is my Sample PDF<h1>");

        logger.Info("Saving PDF File");
        pdf.SaveAs(@"D:\myPDF.pdf");
    }
}

using NLog;
using IronPdf;

internal class Program
{
    // Create an instance of the Logger
    private static Logger logger = LogManager.GetCurrentClassLogger();

    static void Main(string[] args)
    {
        logger.Info("Initializing Chrome PDF Renderer");
        ChromePdfRenderer renderer = new ChromePdfRenderer();

        logger.Info("Creating PDF From HTML String");
        var pdf = renderer.RenderHtmlAsPdf("<h1>This is my Sample PDF<h1>");

        logger.Info("Saving PDF File");
        pdf.SaveAs(@"D:\myPDF.pdf");
    }
}