C# NLog日志类

摘要

NLog是一个功能强大的.NET平台上的日志记录类库，可以帮助开发人员更加方便地进行日志记录、过滤、投递等操作。它支持多种日志记录器，包括日志记录器和文件记录器，可以灵活地满足不同的日志记录需求。此外，NLog还支持配置多个日志记录器，使得日志记录更加灵活。

使用NLog进行日志记录非常简单。开发人员只需要在代码中添加相应的代码，就可以实现日志记录的功能。NLog还提供了多种格式化日志的方式，可以灵活地配置日志的输出格式，使得日志输出更加清晰明了。

NLog是一个功能强大、灵活、易用的日志记录类库，可以帮助开发人员更加方便地进行日志记录和调试，提高应用程序的可维护性和可靠性。如果你正在使用.NET平台开发应用程序，NLog是一个非常值得推荐的日志记录类库。

正文

第一步，在项目中安装nlog，通过nuget搜索nlog，安装即可。

添加NLog.config 文件，选择文件总是copy

整个nlog文件结构如下

XML
<?xml version="1.0" ?>
<nlog>
    <targets>
        <target></target>
        <target></target>
    </targets>
    <rules>
        <logger></logger>
        <logger></logger>
    </rules>
</nlog>

XML
<?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="asyncFile" xsi:type="AsyncWrapper">
      <!--项目日志保存文件路径说明fileName="${basedir}/保存目录，以年月日的格式创建/${shortdate}/${记录器名称}-${单级记录}-${shortdate}.txt"-->
      <target name="log_file" xsi:type="File"
          fileName="${basedir}/Logs/${shortdate}/${level}.txt"
          layout="${longdate} | ${message} ${onexception:${exception:format=message} ${newline} ${stacktrace} ${newline}"
          archiveFileName="${basedir}/archives/${logger}-${level}-${shortdate}-{#####}.txt"
          archiveAboveSize="102400"
          archiveNumbering="Sequence"
          concurrentWrites="true"
          keepFileOpen="false" />
    </target>
    <!-- 写入数据库 -->
    <target name="db" xsi:type="Database" dbProvider="System.Data.SqlClient.SqlConnection, System.Data">
      <!-- 连接字符串 -->
      <connectionString>Data Source=idio-002;Initial Catalog=bzscada;User ID=sa;Password=123</connectionString>
      <!-- Insert语句 -->
      <commandText>
        insert into dbo.Log (MachineName,Logged,Level,Message,Exception) values (@MachineName,@Logged,@Level,@Message,@Exception);
      </commandText>
      <!-- 格式化参数 -->
      <parameter name="@MachineName" layout="${machinename}" />
      <parameter name="@Logged" layout="${date}" />
      <parameter name="@Level" layout="${level}" />
      <parameter name="@Message" layout="${message}" />
      <parameter name="@Exception" layout="${exception:tostring}" />
    </target>
    <!--使用可自定义的着色将日志消息写入控制台-->
    <target name="colorConsole" xsi:type="ColoredConsole" layout="[${date:format=HH\:mm\:ss}]:${message} ${exception:format=message}" />
  </targets>

  <!--规则配置,final - 最终规则匹配后不处理任何规则-->
  <rules>
    <logger name="Microsoft.*" minlevel="Info" writeTo="" final="true" />
    <logger name="*" minlevel="Info" writeTo="asyncFile" />
    <logger name="*" minlevel="Warn" writeTo="colorConsole" />
    <logger name="*" minlevel="Info" writeTo="db" />
  </rules>
</nlog>

如果需要写数据库，需要增加数据库引用

System.Data.SqlClient

NLog.Database

在nuget中可以添加

写Db需要在rules下配制

还要添加一组target

这里dbProivder非常重要，这个其实用的就是反射完成的。

LogHelper

C#
public class LogHelper
{
    /// <summary>
    /// 实例化nLog，即为获取配置文件相关信息(获取以当前正在初始化的类命名的记录器)
    /// </summary>
    private static readonly NLog.Logger _logger = LogManager.GetCurrentClassLogger();

    #region Debug，调试
    public static void Debug(string msg)
    {
        _logger.Debug(msg);
    }

    public static void Debug(string msg, Exception err)
    {
        _logger.Debug(err, msg);
    }
    #endregion

    #region Info，信息
    public static void Info(string msg)
    {
        _logger.Info(msg);
    }

    public static void Info(string msg, Exception err)
    {
        _logger.Info(err, msg);
    }
    #endregion

    #region Warn，警告
    public static void Warn(string msg)
    {
        _logger.Warn(msg);
    }

    public static void Warn(string msg, Exception err)
    {
        _logger.Warn(err, msg);
    }
    #endregion

    #region Trace，追踪
    public static void Trace(string msg)
    {
        _logger.Trace(msg);
    }

    public static void Trace(string msg, Exception err)
    {
        _logger.Trace(err, msg);
    }
    #endregion

    #region Error，错误
    public static void Error(string msg)
    {
        _logger.Error(msg);
    }

    public static void Error(string msg, Exception err)
    {
        _logger.Error(err, msg);
    }
    #endregion

    #region Fatal,致命错误
    public static void Fatal(string msg)
    {
        _logger.Fatal(msg);
    }

    public static void Fatal(string msg, Exception err)
    {
        _logger.Fatal(err, msg);
    }
    #endregion
}

调用例子

C#
private void btnTest_Click(object sender, EventArgs e)
{
    LogHelper.Info("你好");
    try
    {
        int x = 10;
        int y = 0;
        int z = x / y;
    }
    catch(Exception ex)
    {
        LogHelper.Error("出错了", ex);
    }
}

数据库脚本

SQL
CREATE TABLE [dbo].[Log](
  [Id] [int] IDENTITY(1,1) NOT NULL,
  [MachineName] [nvarchar](50) NOT NULL,
  [Logged] [datetime] NOT NULL,
  [Level] [nvarchar](50) NOT NULL,
  [Message] [nvarchar](max) NOT NULL,
  [Exception] [nvarchar](max) NULL,
 CONSTRAINT [PK_dbo.Log] PRIMARY KEY CLUSTERED 
(
  [Id] ASC
)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON, OPTIMIZE_FOR_SEQUENTIAL_KEY = OFF) ON [PRIMARY]
) ON [PRIMARY] TEXTIMAGE_ON [PRIMARY]
GO

写数据库