C# 中使用NLog记录日志

如果你要使用NLog来记录日志，以下是一些前提条件，这些条件将帮助你顺利地在你的应用程序中集成NLog：

1. 安装NLog库：
   • 确保你的项目中已经安装了NLog库。你可以通过NuGet包管理器来安装，只需在Visual Studio的NuGet包管理器控制台中输入“Install-Package NLog和Install-Package Microsoft.Extensions.Logging”即可。
2. 配置NLog：
   • NLog的配置通常是通过一个XML配置文件（nlog.config）来完成的。这个文件定义了日志记录的行为，如日志级别、输出目标等。 
   • 你需要创建一个NLog配置文件，并在其中定义你的日志目标和规则。例如，你可以定义将日志输出到文件、控制台、数据库或其他目标。
   • NLog配置文件支持自动重新加载，这允许你在不重启应用程序的情况下更改配置。
3. 定义日志目标：
   • 在NLog配置文件中，你需要定义日志目标。这些目标定义了日志应该被发送到哪里。例如，你可以定义一个将日志写入文件的目标，或者一个将日志输出到控制台的目标。
   • 你可以定义多个目标，并根据需要在日志规则中引用它们。
4. 定义日志规则：
   • 日志规则定义了哪些日志应该被记录以及它们应该被发送到哪些目标。你可以为每个规则指定一个日志级别和一个或多个目标。
   • 例如，你可以创建一个规则，将所有Trace级别的日志记录到文件，而将Info级别及以上的日志同时记录到文件和控制台。
5. 在代码中记录日志：
   • 在你的应用程序代码中，你需要使用NLog的API来记录日志。这通常涉及到获取一个ILogger实例，并使用它的方法来记录不同级别的日志消息。
   • 例如，你可以使用logger.Info("This is an info message")来记录一个信息级别的日志消息。
6. （可选）使用依赖注入：
   • 如果你希望将依赖项注入到NLog的目标中，你需要确保你的项目中已经配置了依赖注入，并创建了一个实现了NLog目标接口的类。然后，你可以在配置文件中指定使用这个类作为NLog的目标。
7. 处理日志文件的存储和管理：
   • 如果你将日志记录到文件，你需要考虑如何管理这些日志文件。例如，你可能需要设置文件的最大大小（）、保留策略（如保留最近7天的日志）等。
   • NLog支持这些功能，你可以通过配置文件中的相关设置来配置它们。
8. （可选）配置日志的自动删除和归档：
   • 如果你的日志文件可能会占用大量磁盘空间，你可以配置NLog来自动删除旧的日志文件或将它们归档到其他位置。这可以通过在配置文件中设置相关参数来实现。

NLog的日志等级

• Trace：最常见的记录信息，一般用于普通输出，是最啰嗦的等级。
• Debug：同样是记录信息，不过出现的频率要比Trace少一些，一般用来调试程序，协助开发人员定位问题。
• Info：信息类型的消息，是最重要的一个等级，要设计的足够巧妙，能准确反映整个应用程序的运行轨迹。
• Warn：警告信息，一般用于比较重要的场合。
• Error：错误信息。
• Fatal：致命异常信息，通常意味着应用程序即将崩溃关闭。

Logging 的日志等级

• DEBUG：程序调试bug时使用。
• INFO：程序正常运行时使用。
• WARNING：程序未按预期运行时使用，但并不是错误，如用户登录密码错误。
• ERROR：程序出错误时使用，如IO操作失败。
• CRITICAL：特别严重的问题，导致程序不能再继续运行时使用，如磁盘空间为空。

对应关系

• NLog的Trace 对应 ILogging的DEBUG：两者都用于输出详细的调试信息。
• NLog的Debug 对应 ILogging的DEBUG：虽然两者都用于调试，但在某些情况下，NLog的Debug可能包含比Trace更少的输出。
• NLog的Info 对应 ILogging的INFO：两者都用于记录应用程序的正常运行信息。
• NLog的Warn 对应 ILogging的WARNING：两者都用于记录重要的警告信息。
• NLog的Error 对应 ILogging的ERROR：两者都用于记录错误信息。
• NLog的Fatal 对应 ILogging的CRITICAL：两者都用于记录导致程序严重问题或崩溃的严重错误信息。

 

总结：使用NLog记录日志需要安装NLog库、配置NLog、定义日志目标和规则、在代码中记录日志，并可能需要处理日志文件的存储和管理。此外，你还可以选择使用依赖注入来扩展NLog的功能，并配置日志的自动删除和归档策略。

以下是代码示例：

    static void Main(string[] args)
        {
            // 使用依赖注入注入
            ServiceCollection services = new ServiceCollection();
            services.AddScoped();
            services.AddScoped();
            services.AddLogging(p => p.AddNLog());
            using (var scope = services.BuildServiceProvider())
            {
                var testLogger = scope.GetRequiredService();
                var categoryLog = scope.GetRequiredService();
                for (int i = 0; i < 10000; i++)
                {
                    categoryLog.DoSomething();
                    testLogger.Run();
                }
            }
            Console.ReadLine();
        }

using Microsoft.Extensions.Logging;
namespace CategoryLogNS
{
    public class CategoryLog
    {
        private readonly ILogger logger;

        public CategoryLog(ILogger logger)
        {
            this.logger = logger;
        }

        public void DoSomething()
        {
            try
            {
                // ... 执行一些操作 ...  

                // 记录信息级别的日志  
                logger.LogInformation("This is an info message.");

                // 记录警告级别的日志  
                logger.LogWarning("This is a warning message.");

                // 记录错误级别的日志  
                logger.LogError("This is an error message.");

                // 记录异常  
                try
                {
                    // ... 可能会抛出异常的代码 ...  
                    throw new Exception("This is an exception.");
                }
                catch (Exception ex)
                {
                    logger.LogError("An error occurred.", ex);
                }
            }
            catch (Exception ex)
            {
                // 捕获未处理的异常并记录  
                logger.LogCritical("An Critical occurred", ex);
            }
        }
    }
}

以下是生成的日志文件