天天看點

.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就是用來記錄項目日志的元件

使用步驟

①在NuGet中安裝:NLog.Config和 NLog.Extensions.Logging

②配置Configure如下

public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
{
     loggerFactory.AddNLog();//添加NLog
}      

③打開項目bin/debug目錄,找到

.NET Core 使用NLog日志記錄

④将裡面内容替換成:

<?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檔案即可看到輸出日志:

.NET Core 使用NLog日志記錄

關于Nlog日志的就先介紹到這兒,這隻是一個基礎入門講解,更多内容可以參考:

Nlog官網

異常處理

對于全局異常處理,通常有幾種方式,我們這裡介紹一個常見的做法:

①我們在web下建立一個檔案夾ErrorHand

②在此檔案夾中建立一個ErrorHandlingMiddleware類如下

.NET Core 使用NLog日志記錄
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可以檢視到相應輸出日志。

  • 感謝你的閱讀。如果你覺得這篇文章對你有幫助或者有啟發,就請推薦一下吧~你的精神支援是部落客強大的寫作動力。歡迎轉載!
  • 部落客的文章沒有高度、深度和廣度,隻是湊字數。由于部落客的水準不高(其實是個菜B),不足和錯誤之處在所難免,希望大家能夠批評指出。
  • 歡迎加入.NET 從入門到精通技術讨論群→523490820 期待你的加入
  • 不舍得打亂,就永遠學不會複原。被人嘲笑的夢想,才更有實作的價值。
  • 我的部落格: http://www.cnblogs.com/zhangxiaoyong/