NET WPF使用NLog

一、NLog简介

NLog是一个基于.NET平台编写的日志记录类库，我们可以使用NLog在应用程序中添加极为完善的跟踪调试代码。可以在任何一种.NET语言中输出带有上下文的（contextual information）调试诊断信息，根据喜好配置其表现样式之后发送到一个或多个输出目标（target）中。

• NLog-官网地址

• 文档地址

二、NLog使用

2.1 NuGet引用NLog组件

NuGet引用NLog组件

2.2 添加NLog配置文件NLog.config

在项目根目录下创建NLog.config配置文件

<?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="file" xsi:type="File" fileName="log.txt" />
  </targets>
  <rules>
    <logger name="*" minlevel="Info" writeTo="file" />
  </rules>
</nlog>

2.3 NLog.config文件的属性设置为【始终复制】

在Visual Studio中，右键点击NLog.config文件，选择【属性】，然后将【复制到输出目录】属性设置为【如果较新复制】或【始终复制】。

属性 修改属性

2.4 打印日志

在App.cs中打印日志

using System.Configuration;
using System.Data;
using System.Windows;
using NLog;
namespace pump
{
    /// <summary>
    /// Interaction logic for App.xaml
    /// </summary>
    public partial class App : Application
    {

        private static Logger logger = LogManager.GetCurrentClassLogger();

        protected override void OnStartup(StartupEventArgs e)
        {
            base.OnStartup(e);

            logger.Info("Application started.");
            logger.Info("这是一条信息日志");
            logger.Warn("这是一条警告日志");
            logger.Error("这是一条错误日志");
        }
    }
}

项目文件

2.5 查看生成的日志文件

启动服务，在项目运行目录下可查看到生成的日志文件

日志文件 日志内容

三、日志切割 & 控制大小

如果日志文件不控制大小，软件长时间运行会导致日志文件大小无限增大，直到服务器硬盘被撑爆，这样非常危险。因此我们需要对日志文件进行归档(一般按日期切割)和大小控制，配置如下：

<?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"
      autoReload="true">

    <targets>
        <!-- ${basedir}代表应用程序的基础目录，即应用程序的根目录 -->
        <target xsi:type="File" 
                name="logfile" 
                fileName="${basedir}/nlog/logFile.log" 
                layout="${longdate} ${uppercase:${level}} ${message}"
                archiveEvery="Day"
                archiveFileName="${basedir}/nlog/logFile_{#}.log" 
                archiveNumbering="DateAndSequence"
                maxArchiveFiles="3" 
                archiveAboveSize="10000"/>
    </targets>

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

在上面的配置中：

• archiveEvery="Day" 表示每天归档一次日志文件。

• archiveFileName="${basedir}/nlog/logFile_{#}.log" 定义了归档文件的命名规则，{#} 会被替换为对应的归档序号。

• archiveNumbering="DateAndSequence" 指定了归档文件的命名模式。

• maxArchiveFiles="3" 表示保留最多七个归档文件。

• archiveAboveSize="10000" 表示当日志文件大小超过10KB时进行归档。

运行效果如下：

运行效果