.Net快速上手Nlog日誌組件

時間 2020-01-02

標籤快速上手 nlog 日誌組件简体版

原文原文鏈接

目錄git

1、NLog 簡介

NLog是適用於各類.NET平臺的靈活，免費的日誌記錄平臺。NLog使寫入多個目標變得容易。（數據庫，文件，控制檯）並即時更改日誌記錄配置。（本文主要介紹寫日誌到文件中）
Nlog官網：https://nlog-project.org/
Nlog配置說明：https://nlog-project.org/config/
Nlog Github Wiki：https://github.com/NLog/NLog/wikigithub

注：如下操做爲 asp.net core web項目，編輯器爲VS2019web

2、NLog 安裝

2.1 使用程序包管理控制檯（Package Manager）

PM> Install-Package NLog

2.2 .Net CLI

dotnet add package NLog

在項目的根目錄下，在cmd窗口中輸入上面的命令便可安裝。

shell

三. NLog 配置

3.1 Nlog配置方式

經過配置文件；
經過程序代碼；

3.2 經過配置文件配置Nlog

在項目的根目錄建立Nlog.config文件，並設置文件屬性：
具體配置

下面的配置，就是一個簡單的配置Nlog.config的demo，將下面的配置複製到Nlog.config中，便可將日誌寫入到PsTest.log文件中。數據庫

<?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="${basedir}\PsTest.log"
        layout="${longdate} | ${level:uppercase=true}: ${message} | ${stacktrace}" 
        maxArchiveFiles="3"
        archiveAboveSize="10240" 
        encoding="utf-8"/>
  </targets>

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

下面簡單介紹下各配置項的意思：
targets 節點中定義了一系列日誌輸出目標，每個輸出目標是一個 target 元素。
target標籤：bash

fileName 屬性：指日誌寫入的文件的路徑及文件名。${basedir}指應用的當前路徑。
layout 屬性：設置每條日誌的輸出內容及格式。${longdate} 指寫入日誌的時間，${level}指日誌等級， ${stacktrace}指堆棧信息。
archiveAboveSize 屬性：設置日誌文件的大小的最大值，單位爲byte，若是下條日誌寫入的話要超出這個值，就會新建個日誌文件，繼續寫入。
maxArchiveFiles 屬性：指該target的日誌文件最多容許產生的個數，一般與archiveAboveSize 屬性配合使用。

rules 節點是日誌路由規則的集合，由一個或多個 logger 元素組成。每一個 logger 元素記錄了 logger 的名字、目標輸出以及要處理的日誌等級。
logger標籤：asp.net

name 屬性：設置命名空間和類，若是爲*，表明針對全部程序集。
minlevel 屬性：指只有當日志等級大於"Debug"時，纔會寫入。
writeTo 屬性：指輸出目標，與target的name對應。

4、程序代碼中寫日誌

public static void Main(string[] args)
{
    var i = 100;
    while (i > 1)
    { 
        NlogTest();
        i--;
    }
}
public static void NlogTest()
{
    //經過NLog.LogManager.GetCurrentClassLogger方法能夠建立一個與所在類同名(包括 namespace)的 NLog.Logger 的實例。
    var logger = LogManager.GetCurrentClassLogger();
    logger.Error("something Error!");
    logger.Info("something Info!");
    logger.Debug("something Debug!");
    try
    {
        List<int> ls = null;
        var c = ls.Count;
    }
    catch (Exception ex)
    {
        logger.Error(ex.Message);
    }
}

來到應用的生成目錄下面便可看到PsTest.log日誌文件。

能夠看到生成了多個log文件，由於配置文件設置的log文件最大爲10k。
打開PsTest.0.log文件：

日誌已經按照配置的格式寫入到文件中！編輯器

但這樣寫有個問題，就是每次寫日誌都要先建立一個NLog.Logger 的實例，這樣的話，若是程序集較多，就形成了代碼冗餘，因此，仍是封裝一個Nlog的幫助類比較好，每次都調用這個類去寫日誌spa

封裝的nlog幫助類：

public class PsLog
    {
        public static void Error(Exception ex)
        {
            Exception iex = GetInnerException(ex);
            Error(iex.ToString());
        }

        public static void Error(string msg)
        {
            WriteLog(msg, LogLevel.Error);
        }

        private static void WriteLog(string msg, LogLevel level)
        {
            try
            {
                if (LogLevel.Debug == level)
                {
                    LogManager.GetCurrentClassLogger().Debug(msg);
                }
                else if (LogLevel.Error == level)
                {
                    LogManager.GetCurrentClassLogger().Error(msg);
                }
                else if (LogLevel.Fatal == level)
                {
                    LogManager.GetCurrentClassLogger().Fatal(msg);
                }
                else if (LogLevel.Info == level)
                {
                    LogManager.GetCurrentClassLogger().Info(msg);
                }
                else if (LogLevel.Trace == level)
                {
                    LogManager.GetCurrentClassLogger().Trace(msg);
                }
                else if (LogLevel.Warn == level)
                {
                    LogManager.GetCurrentClassLogger().Warn(msg);
                }
                else
                {
                    LogManager.GetCurrentClassLogger().Info(msg);
                }
            }
            catch (System.Exception e)
            {
                try
                {
                    string strPath = Directory.GetCurrentDirectory();
                    using (FileStream fs = File.Open(strPath + @"\fatal.txt", FileMode.OpenOrCreate))
                    using (StreamWriter sw = new StreamWriter(fs))
                        sw.WriteLine(DateTime.Now.ToString() + ": Can not write the nlog, " + e.Message);
                }
                catch(Exception ex)
                {
                    Console.WriteLine(ex.ToString());
                }
            }
        }

        public static void Info(string msg)
        {
            WriteLog(msg, LogLevel.Info);
        }

        private static Exception GetInnerException(Exception ex)
        {
            if (ex.InnerException == null)
            {
                return ex;
            }
            return GetInnerException(ex.InnerException);
        }
    }

調用幫助類：

public static void NlogTest()
   {
       PsLog.Error("something Error!");
       PsLog.Info("something Info!");
       PsLog.Debug("something Debug!");
       try
       {
           List<int> ls = null;
           var c = ls.Count;
       }
       catch (Exception ex)
       {
           PsLog.Error(ex);
       }
   }