給微軟的日誌框架寫一個基於委托的日誌提供者

-Advertisement-

動手造輪子：給微軟的日誌框架寫一個基於委托的日誌提供者 Intro 微軟的日誌框架現在已經比較通用，有時候我們不想使用外部的日誌提供者，但又希望提供一個比較簡單的委托就可以實現日誌記錄，於是就有了後面的探索和實現。 Solution 基於委托的實現代碼: 自定義 Logger 微軟的日誌框架中記錄 ...

動手造輪子：給微軟的日誌框架寫一個基於委托的日誌提供者

Intro

微軟的日誌框架現在已經比較通用，有時候我們不想使用外部的日誌提供者，但又希望提供一個比較簡單的委托就可以實現日誌記錄，於是就有了後面的探索和實現。

Solution

基於委托的 LoggerProvider 實現代碼:

自定義 Logger

微軟的日誌框架中記錄日誌是通過 ILogger 來做的，擴展支持其他日誌框架的時候也需要實現相應的 ILogger 來適配

ILoggerProvider 會需要實現創建 ILogger 的介面 CreateLogger(string categoryName) ，所以我們可以先來實現對應的 ILogger，實現如下：

這裡的實現簡單化處理，預設處理所有級別的日誌，如果要設定日誌級別可以通過日誌的 Fliter 來做，這裡就不做檢查和限制了

private class DelegateLogger : ILogger
{
    private readonly string _categoryName;
    private readonly Action<string, LogLevel, Exception, string> _logAction;

    public DelegateLogger(string categoryName, Action<string, LogLevel, Exception, string> logAction)
    {
        _categoryName = categoryName;
        _logAction = logAction;
    }

    public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter)
    {
        if (null != _logAction)
        {
            var msg = formatter(state, exception);
            _logAction.Invoke(_categoryName, logLevel, exception, msg);
        }
    }

    public bool IsEnabled(LogLevel logLevel)
    {
        return true;
    }

    public IDisposable BeginScope<TState>(TState state)
    {
        return NullScope.Instance;
    }
}

自定義 `ILoggerProvider`

有了 ILogger 之後接著我們來定義我們的 ILoggerProvider，這裡我們針對 Logger 名稱（CategoryName）做了區分，如果不關註 Logger 名稱的話也可以使用同一個
Logger 這樣就不需要下麵的併發字典了，只用一個 ILogger 對象就可以了，可以根據自己的需要進行定製

實現代碼如下：

[ProviderAlias("Delegate")]
public class DelegateLoggerProvider : ILoggerProvider
{
    private readonly Action<string, LogLevel, Exception, string> _logAction;
    private readonly ConcurrentDictionary<string, DelegateLogger> _loggers = new ConcurrentDictionary<string, DelegateLogger>();

    public DelegateLoggerProvider(Action<string, LogLevel, Exception, string> logAction)
    {
        _logAction = logAction;
    }

    public void Dispose()
    {
        _loggers.Clear();
    }

    public ILogger CreateLogger(string categoryName)
    {
        return _loggers.GetOrAdd(categoryName, category => new DelegateLogger(category, _logAction));
    }
}

定義擴展方法

為了方便使用，我們需要定義兩個擴展方法來優化我們使用的方式：

定義 ILoggerFactory 的擴展方法：

/// <summary>
/// AddDelegateLoggerProvider
/// </summary>
/// <param name="loggerFactory">loggerFactory</param>
/// <param name="logAction">logAction</param>
/// <returns>loggerFactory</returns>
public static ILoggerFactory AddDelegateLogger(this ILoggerFactory loggerFactory, Action<string, LogLevel, Exception, string> logAction)
{
    loggerFactory.AddProvider(new DelegateLoggerProvider(logAction));
    return loggerFactory;
}

定義 ILoggingBuilder 的擴展方法：

public static ILoggingBuilder AddDelegateLogger(this ILoggingBuilder loggingBuilder,
    Action<string, LogLevel, Exception, string> logAction)
{
    return loggingBuilder.AddProvider(new DelegateLoggerProvider(logAction));
}

使用示例

ILoggerFactory loggerFactory = new LoggerFactory();
//loggerFactory.AddConsole();
loggerFactory.AddDelegateLogger(
    (category, logLevel, exception, msg) =>
    {
        Console.WriteLine($"{category}:[{logLevel}] {msg}\n{exception}");
    }
);

日誌輸出效果如下：

Reference

您的分享是我們最大的動力!