您的位置:首頁 > 教程 > ASP.NET > .NetCore日志記錄之自定義日志組件

.NetCore日志記錄之自定義日志組件

2022-06-15 18:49:18 來源:易采站長站 作者:

.NetCore日志記錄之自定義日志組件

一、前言

回顧:日志記錄之日志核心要素揭秘

在上一篇中,我們通過學習了解在.net>ILoggerFactory)中實現將日志記錄提供器(ILoggerProvider)對象都可以集成到Logger對象組合中,這樣的話,我們就可以通過基于ILoggerProvider自定義日志記錄程序集成到Logger中,再創建寫日志定義Ilogger,自定義日志記錄器實現日志的輸出方式,這樣實現自定義日志記錄工具。

在這個過程中,日志記錄器ILogger中的Log()方法會記錄執行日志,通過在ILoggerFactory產生的是ILogger類型(也就是我們最終使用的Logger),其Log()方法是依次調用Logger中包含的LoggerInformation[]數組中的ILogger。而ILoggerProvider產生的為各類不同的XxxLogger(也就是上面說的Logger中的LoggerInformation數組包含的如ConsoleLogger、DebugLogger),其Log()方法是把日志寫到具體的目標上去,所以我們自定義的日志程序也可以在日志記錄器工廠中實現添加日志程序,達到將日志寫到具體目標的作用。

所以下文我們通過自定義的方式實現ILogger、ILoggerProvider兩個接口來實現我們自己想要的日志記錄程序,實現自定義輸出目標方式。(下文只是簡單的根據接口自定義實現輸出日志記錄到控制臺的demo)

二、開始

2.1>

創建一個自定義Logger,目的是將指定的等級日志輸出到控制臺。所以我們創建一個ExtensionLogger的類,指定輸出的日志等級。所以在這之前,我們需要配置一下輸入日志的等級,因此我們需要增加一個等級的配置類ExtensionsConfiguration。

ExtensionsConfiguration中,

public class ExtensionsConfiguration
{
    /// <summary>
    /// 日志等級
    /// </summary>
    public LogLevel LogLevel { get; set; } = LogLevel.Warning;
}

再自定義日志記錄類ExtensionLogger,實現接口ILogger,

public class ExtensionsLogger : ILogger
{
    private readonly ExtensionsConfiguration _config;
    public ExtensionsLogger(ExtensionsConfiguration extensionsConfiguration)
    {
        _config = extensionsConfiguration;
    }

    public IDisposable BeginScope<TState>(TState state)
    {
        return null;
    }

    public bool IsEnabled(LogLevel logLevel)
    {
        return logLevel == _config.LogLevel;
    }

    public void Log<TState>(LogLevel logLevel, EventId eventId, TState state,
        Exception exception, Func<TState, Exception, string> formatter)
    {
        if (!IsEnabled(logLevel))
        {
            return;
        }
        Console.WriteLine($" {logLevel} - {eventId.Id} : " + formatter(state, exception));
        
    }
}

根據ILogger接口實現,其中實現Log()接口方法,將日志輸出到指定目標,這里是輸出到控制臺,在設置了日志等級的情況條件下,當滿足條件后,才能輸出對應的日志。

2.2>

在創建了日志輸出記錄后,我們同時需要提供一個日志程序來增加和創建上面的Logger記錄,所以我們通過自定義日志提供器類ExtensionsLoggerProvider,實現ILoggerProvider類。

public class ExtensionsLoggerProvider : ILoggerProvider
{
    private readonly ExtensionsConfiguration _config;

    public ExtensionsLoggerProvider(ExtensionsConfiguration extensionsConfiguration)
    {
        _config = extensionsConfiguration;
    }

    public ILogger CreateLogger(string categoryName)
    {
        return new ExtensionsLogger(_config);
    }

    public void Dispose()
    {
    }
}

基于ILoggerProvider接口實現自定義類,實現方法CreateLogger,來創建上面的日志記錄。

2.3>

在Startup.cs中,通過Configure方法調用配置日志記錄。

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env , ILoggerFactory loggerFactory)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }
        // 注入ILogggerFactory,然后配置參數
        //添加日志等級
        loggerFactory.AddProvider(new ExtensionsLoggerProvider(new ExtensionsConfiguration { LogLevel= LogLevel.Warning }));
        app.UseRouting();

        app.UseAuthorization();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllers();
        });
    }

在此之前,我們可以清空默認的配置,然后根據日志等級,在控制臺中輸出對應的日志記錄。

2.4>

在等級為Information情況下,輸出效果如下:

這個就是我們通過自定義的方式實現的按日志等級輸出的記錄。

三、拓展

3.1>

第一步:為LoggerFactory擴張一個方法,提供增加日志寫文件方式的入口。相關的配置來自appsettings.json

第二步:實現我們的logger提供程序,實現ILoggerProvider接口,關鍵方法CreateLogger,創建真正寫日志的logger。對當前的logger可以做適當的緩存,配置logger

第三步:實現我們的logger,實現ILogger接口。真正將log寫入file。

這里可以參考網友的資料 :.Net Core Logger 實現log寫入本地文件系統

四、總結

    上文中,我們通過自定義的方式實現了根據日志等級將日志記錄輸出到指定目標的方式,在這種基礎上,我們可以根據具體的需求做完善修改,實現自己的日志記錄輸出方式。

    除了我們通過自定義的方式之外,我們也可以借用第三方日志框架組件程序進行使用,根據拓展方法進行調用,在后續中我們會使用第三方日志記錄程序來實現日志記錄的輸出。

    如果有不對的或不理解的地方,希望大家可以多多指正,提出問題,一起討論,不斷學習,共同進步。

    官方源碼 和 參考資料

    本文項目源碼下載

    到此這篇關于.Net>

    如有侵權,請聯系QQ:279390809 電話:15144810328

相關文章

  • [Asp.Net Core] 淺談Blazor Server Side

    [Asp.Net Core] 淺談Blazor Server Side

    在2016年, 本人就開始了一個內部項目, 其特點就是用C#構建DOM樹, 然后把DOM同步到瀏覽器中顯示. 并且在一些小工程中使用. 3年下來, 效果很不錯, 但因為是使用C#來構建控件樹, 在沒有特定
    2020-07-01
  • asp.net生成Excel并導出下載五種實現方法

    asp.net生成Excel并導出下載五種實現方法

    方法一 通過GridView(簡評:方法比較簡單,但是只適合生成格式簡單的Excel,且無法保留VBA代碼),頁面無刷新 aspx.cs部分 代碼如下: using System; using System.Collections; using System.Configuration; usi
    2019-05-16
  • Asp.Net Core用NLog記錄日志操作方法

    Asp.Net Core用NLog記錄日志操作方法

    需求 1.日志自動寫入到數據庫、寫入到文件 2.appsettings.json數據庫連接更改后,不需要去改NLog中的連接地址,啟動網站或項目時自動檢測變動然后去更改,以appsettings.json為準,保持同步
    2019-11-19
  • 使用vs2019加.net core 對WeiApi的創建過程詳解

    使用vs2019加.net core 對WeiApi的創建過程詳解

    vs2019創建webapi 1.創建新的項目 2.選擇.NET CORE的ASP .NET CORE WEB應用程序 3.定義項目名稱和存放地點 4.選擇API創建項目 5.刪除原本的無用的類 6.添加新的方法類 7.設置路由 using Microsoft.AspNe
    2020-07-03
  • 教你Asp.net下使用mysql數據庫的步驟

    教你Asp.net下使用mysql數據庫的步驟

    1. 首先需要安裝mysql, 易采站長站下載地址: //www.jb51.net/softs/2193.html 或者去mysql.com官網都可以,一路next,安裝好后,有個簡單配置,提示有個設置登錄密碼和服務名稱, 默認localhost,用
    2019-05-16
  • [Asp.Net Core]用Blazor Server Side實現圖片驗證碼

    [Asp.Net Core]用Blazor Server Side實現圖片驗證碼

    關于Blazor 由于在國內, Blazor一點都不普及, 在閱讀此文前, 建議讀者先翻看我之前寫的隨筆, 了解Blazor Server Side的特點. 在一段時間內, 我會寫一些解說分析型的 "為什么選擇 Blazor Server
    2020-07-01
  • 詳解ASP.NET Razor 語法

    詳解ASP.NET Razor 語法

    Razor 同時支持 C# (C sharp) 和 VB (Visual Basic)。 主要的 Razor C# 語法規則 Razor 代碼塊包含在 @{ ... } 中 內聯表達式(變量和函數)以 @ 開頭 代碼語句用分號結束 變量使用 var 關鍵字聲明 字符
    2020-07-07
  • .Net Core中使用ExceptionFilter過濾器的方法

    .Net Core中使用ExceptionFilter過濾器的方法

    .Net Core中有各種Filter,分別是AuthorizationFilter、ResourceFilter、ExceptionFilter、ActionFilter、ResultFilter??梢园阉麄兛醋魇?Net Core自帶的AOP的擴展封裝。 今天來看其中的一種:ExceptionFilter(用于
    2020-03-03
色七七影院_香港三级台湾三级在线播放_男人放进女人阳道猛进猛出