.NET Core 使用NLog日志記錄

 

前言

每個項目都會需要使用到日志功能，這對於項目上線后 出現的bug異常，能及時定位和便於后期錯誤分析。那我們今天來看看在.NET Core中如何使用NLog日志。

NLog

什么是NLog呢？

NLog是一個基於.NET平台編寫的類庫，我們可以使用NLog在應用程序中添加極為完善的跟蹤調試代碼。
NLog是一個簡單靈活的.NET日志記錄類庫。通過使用NLog，我們可以在任何一種.NET語言中輸出帶有上下文的（contextual information）調試診斷信息，根據喜好配置其表現樣式之后發送到一個或多個輸出目標（target）中。
NLog的API非常類似於log4net，且配置方式非常簡單。NLog使用路由表（routing table）進行配置，這樣就讓NLog的配置文件非常容易閱讀，並便於今后維護。
NLog遵從BSD license，即允許商業應用且完全開放源代碼。任何人都可以免費使用並對其進行測試，然后通過郵件列表反饋問題以及建議。
NLog支持.NET、C/C++以及COM interop API，因此我們的程序、組件、包括用C++/COM 編寫的遺留模塊都可以通過同一個路由引擎將信息發送至NLog中。
簡單來說Nlog就是用來記錄項目日志的組件

使用步驟

已入Nlog包

①在NuGet中安裝：Nlog 和  Nlog.Web.AspNetCore

②配置Configure如下

 public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
{
     loggerFactory.AddNLog();//添加NLog
            //引入Nlog配置文件
    env.ConfigureNLog("nlog.config");

}

③添加nlog配置文件 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"
     autoReload="true"
       internalLogLevel="Warn"
       internalLogFile="internal-nlog.txt">
     <!--define various log targets-->
     <targets>
        <!--write logs to file-->
         <target xsi:type="File" name="allfile" fileName="nlog-all-${shortdate}.log"
                  layout="${longdate}|${logger}|${uppercase:${level}}|${message} ${exception}" />
    
         <target xsi:type="File" name="ownFile-web" fileName="nlog-my-${shortdate}.log"
                  layout="${longdate}|${logger}|${uppercase:${level}}|${message} ${exception}" />
        <target xsi:type="Null" name="blackhole" />
  </targets>
     <rules>
         <!--All logs, including from Microsoft-->
         <logger name="*" minlevel="Trace" writeTo="allfile" />
    
       <!--Skip Microsoft logs and so log only own logs-->
         <logger name="Microsoft.*" minlevel="Trace" writeTo="blackhole" final="true" />
         <logger name="*" minlevel="Trace" writeTo="ownFile-web" />
  </rules>
</nlog>

 

⑤在HomeController中添加DI注入

 private readonly ILogger<HomeController> _logger;
 public HomeController(ILogger<HomeController> logger)
    {
            _logger = logger;
    }

⑥測試效果

_logger.LogError("我是錯誤顯示");
_logger.LogDebug("我是調試信息");
 _logger.LogInformation("我是提示信息");

執行后，查看bin/debug/netcoreapp2.0下面的nlog-my-2018-08-12.log文件即可看到輸出日志：

 

日志文件生成在指定目錄下

 

大家會發現文件是生成在項目目錄下的，日志多的時候，會導致文件目錄太亂

此時，只需更改nlog.config中的內容如下即可生成在logs目錄里

<targets>
        <!--write logs to file-->
         <target xsi:type="File" name="allfile" fileName="logs/all/nlog-all-${shortdate}.log"
                  layout="${longdate}|${logger}|${uppercase:${level}}|${message} ${exception}" />
    
         <target xsi:type="File" name="ownFile-web" fileName="logs/my/nlog-my-${shortdate}.log"
                  layout="${longdate}|${logger}|${uppercase:${level}}|${message} ${exception}" />
        <target xsi:type="Null" name="blackhole" />
  </targets>

 

關於Nlog日志的就先介紹到這兒，這只是一個基礎入門講解，更多內容可以參考：Nlog官網

 

異常處理

對於全局異常處理，通常有幾種方式，我們這里介紹一個常見的做法：

①我們在web下新建一個文件夾ErrorHand

②在此文件夾中新建一個ErrorHandlingMiddleware類如下

public class ErrorHandlingMiddleware
    {
        private readonly RequestDelegate _next;
        private readonly ILogger<ErrorHandlingMiddleware> _logger;

        public ErrorHandlingMiddleware(RequestDelegate next,ILogger<ErrorHandlingMiddleware> logger)
        {
            this._next = next;
            _logger = logger;
        }

        public async Task Invoke(HttpContext context)
        {
            try
            {
                await _next(context);
            }
            catch (Exception e)
            {
                var statusCode = context.Response.StatusCode;
                if (e is ArgumentException)
                {
                    statusCode = 200;
                }

               await  HandleExceptionAsync(context, statusCode, e.Message);
            }
            finally
            {
                var statusCode = context.Response.StatusCode;
                var msg = "";
                if (statusCode != 200)
                {
                    _logger.LogError(context.Request.GetAbsoluteUri()+"\r\n"+statusCode.ToString());
                }

                if (!string.IsNullOrEmpty(msg))
                {
                   await  HandleExceptionAsync(context, statusCode, msg);
                }
            }
        }

        private static Task HandleExceptionAsync(HttpContext context, int statusCode, string msg)
        {
            var data = new {code = statusCode.ToString(), is_success = false, msg = msg};
            var result = JsonConvert.SerializeObject(new {data = data});
            context.Response.ContentType = "application/json;charset=utf-8";
            return context.Response.WriteAsync(result);
        }
    }

這里類內容比較簡單，就不多贅述了，此時，我們全局異常類已經編寫好了，但是，還無法正常使用，我們需要在Startup中配置一下

③我們需要在Configure方法中加入：

//全局錯誤
app.UseMiddleware(typeof(ErrorHandlingMiddleware));

這個地方就是綁定了我們自定義的錯誤類。

 

注：.netCore中 提供了兩個我們可以跳轉到錯誤頁面，一個是404的，一個是500的，同樣在Configure方法中加入：

app.UseExceptionHandler("/Home/NothingFound");
app.UseStatusCodePagesWithReExecute("/Home/NothingFound");

這樣當有對應異常出現的時候，就可以跳轉到自己的錯誤頁。然后配合NLog可以查看到相應輸出日志。