動手造輪子：寫一個日志框架

Intro

日志框架有很多，比如 log4net / nlog / serilog / microsoft.extensions.logging 等，如何在切換日志框架的時候做到不用修改代碼，只需要切換不同的 loggingProvider 就可以了，最低成本的降低切換日志框架的成本，處于這個考慮自己寫了一個日志框架，為不同的日志框架寫一個適配，需要用到什么日志框架，配置一下就可以了，業務代碼無需變動，

V0

最初的日志強依賴于 log4net，log4net 是我使用的第一個日志框架，所以很長一段時間都在使用它來做日志記錄，但是由于是強依賴，在想換日志框架時就會很難受，大量代碼要改動，不符合開放封閉的基本原則，于是就有了第一個版本的日志，

V1

第一版的日志參考了微軟的日志框架的實作，大概結構如下：

public interface ILogHelperLogFactory
{
    ILogger CreateLogger(string categoryName);
    
    bool AddProvider(ILogHelperProvider provider);
}
public interface ILogHelperLogger
{
    bool IsEnabled(LogHelperLogLevel logLevel);
    void Log(LogHelperLogLevel logLevel, Exception exception, string message);
}
public enum LogHelperLogLevel
{
    /// <summary>
    /// All logging levels
    /// </summary>
    All = 0,

    /// <summary>
    /// A trace logging level
    /// </summary>
    Trace = 1,

    /// <summary>
    /// A debug logging level
    /// </summary>
    Debug = 2,

    /// <summary>
    /// A info logging level
    /// </summary>
    Info = 4,

    /// <summary>
    /// A warn logging level
    /// </summary>
    Warn = 8,

    /// <summary>
    /// An error logging level
    /// </summary>
    Error = 16,

    /// <summary>
    /// A fatal logging level
    /// </summary>
    Fatal = 32,

    /// <summary>
    /// None
    /// </summary>
    None = 64
}
public interface ILogHelperProvider
{
    ILogHelperLogger CreateLogger(string categoryName);
}

為了方便 Logger 的使用，定義了一些擴展方法，使得可以直接使用 logger.Info/logger.Error 等方法，擴展定義如下：

public static void Log(this ILogHelperLogger logger, LogHelperLevel loggerLevel, string msg) => logger.Log(loggerLevel, null, msg);

#region Info

    public static void Info(this ILogHelperLogger logger, string msg, params object[] parameters)
{
    if (parameters == null || parameters.Length == 0)
    {
        logger.Log(LogHelperLevel.Info, msg);
    }
    else
    {
        logger.Log(LogHelperLevel.Info, null, msg.FormatWith(parameters));
    }
}

public static void Info(this ILogHelperLogger logger, Exception ex, string msg) => logger.Log(LogHelperLevel.Info, ex, msg);

public static void Info(this ILogHelperLogger logger, Exception ex) => logger.Log(LogHelperLevel.Info, ex, ex?.Message);

#endregion Info
// ...其他的類似，這里就不詳細展開了

如果要自定義的日志記錄的話，就實作一個 ILogHelperProvider 即可，實作一個 ILogHelperProvider 就要實作一個 ILogHelperLogger ，原本強依賴的 log4net 可以實作一個 Log4NetLogHelperProvider，這樣換別的日志框架的時候只需要實作對應的 ILogHelperProvider 即可，但是從功能性上來說還是很弱的

如果想要某些日志不記錄，比如說，Debug 級別的日志不記錄，比如說某一個 Logger 下只記錄 Error 級別的日志，現在是有些吃力，只能通過 log4net 的配置來限制了，于是就有了第二個版本，增加了 LoggingFilter 可以針對 Provider/Logger/LogLevel/Exception 來設定 filter，過濾不需要記錄的日志，這也是參考了微軟的日志框架的 Filter，但是實作不太一樣，有興趣的小伙伴可以自己深入研究一下，

V2

V2 版，在 ILogFactory 的介面上增加了 AddFilter 的方法，定義如下：

/// <summary>	
/// Add logs filter	
/// </summary>	
/// <param name="filterFunc">filterFunc, logProviderType/categoryName/Exception, whether to write log</param>	
bool AddFilter(Func<Type, string, LogHelperLogLevel, Exception, bool> filterFunc);

然后定義了一些擴展方法來方便使用：

public static ILogHelperFactory WithMinimumLevel(this ILogHelperFactory logHelperFactory, LogHelperLevel logLevel)
{
    return logHelperFactory.WithFilter(level => level >= logLevel);
}

public static ILogHelperFactory WithFilter(this ILogHelperFactory logHelperFactory, Func<LogHelperLevel, bool> filterFunc)
{
    logHelperFactory.AddFilter((type, categoryName, logLevel, exception) => filterFunc.Invoke(logLevel));
    return logHelperFactory;
}

public static ILogHelperFactory WithFilter(this ILogHelperFactory logHelperFactory, Func<string, LogHelperLevel, bool> filterFunc)
{
    logHelperFactory.AddFilter((type, categoryName, logLevel, exception) => filterFunc.Invoke(categoryName, logLevel));
    return logHelperFactory;
}

public static ILogHelperFactory WithFilter(this ILogHelperFactory logHelperFactory, Func<Type, string, LogHelperLevel, bool> filterFunc)
{
    logHelperFactory.AddFilter((type, categoryName, logLevel, exception) => filterFunc.Invoke(type, categoryName, logLevel));
    return logHelperFactory;
}

public static ILogHelperFactory WithFilter(this ILogHelperFactory logHelperFactory, Func<Type, string, LogHelperLevel, Exception, bool> filterFunc)
{
    logHelperFactory.AddFilter(filterFunc);
    return logHelperFactory;
}

這樣就方便了我們只想定義針對 Logger 的 Filter 以及 Provider 的 Filter，不必所有引數都用到，logging filter 現在已經實作了，此時已經使用了 Serilog 做日志記錄有一段時間，感覺 Serilog 里的一些設計很優秀，很優雅，于是想把 Serilog 里的一些設計用在自己的日志框架里，比如說：

Serilog 的擴展叫做 Sink，日志輸出的地方，Serilog 自定義一個 Sink，很簡單只需要實作一個介面，不需要再實作一個 Logger，從這點來說，我覺得 Serilog 比微軟的日志框架更加優秀，而且 LogEvent 使得日志更方便的進行批量操作，有需要的可以了解一下 Serilog 的 PeriodBatching https://github.com/serilog/serilog-sinks-periodicbatching
```
/// <summary>
/// A destination for log events.
/// </summary>
public interface ILogEventSink
{
    /// <summary>
    /// Emit the provided log event to the sink.
    /// </summary>
    /// <param name="logEvent">The log event to write.</param>
    void Emit(LogEvent logEvent);
}
```
Serilog 可以自定義一些 Enricher，以此來豐富記錄的日志內容，比如日志的請求背景關系，日志的環境等，也可以是一些固定的屬性資訊
MessageTemplate，其實微軟的日志框架中也有類似的概念，只不過很不明顯，用 Serilog 之前我也很少用，微軟的日志框架可以這樣用 logger.LogInfo("hello {name}", "world") 這樣的寫法其實就可以把第一個引數當作是 MessageTemplate 或者它內部的叫法 Format

鑒于這么多好處，于是打算將這些功能引入到我的日志框架中

V3

引入 LoggingEvent

說干就干，首先要引入一個 LogHelperLoggingEvent，對應的 Serilog 的 LogEvent，定義如下：

public class LogHelperLoggingEvent : ICloneable
{
    public string CategoryName { get; set; }

    public DateTimeOffset DateTime { get; set; }

    public string MessageTemplate { get; set; }

    public string Message { get; set; }

    public Exception Exception { get; set; }

    public LogHelperLogLevel LogLevel { get; set; }

    public Dictionary<string, object> Properties { get; set; }

    public LogHelperLoggingEvent Copy => (LogHelperLoggingEvent)Clone();

    public object Clone()
    {
        var newEvent = (LogHelperLoggingEvent)MemberwiseClone();
        if (Properties != null)
        {
            newEvent.Properties = new Dictionary<string, object>();
            foreach (var property in Properties)
            {
                newEvent.Properties[property.Key] = property.Value;
            }
        }
        return newEvent;
    }
}

Event 里定義了一個 Properties 的字典用來豐富日志的內容，另外實作了 ICloneable 介面，方便對物件的拷貝，為了強型別，增加了一個 Copy 的方法，回傳一個強型別的物件

改造 LogProvider

為了減少擴展一個 ILogProvider 的復雜性，我們要對 ILogProvider 做一個簡化，只需要像擴展 Serilog 的 Sink 一樣記錄日志即可，不需要關心是否要創建 Logger

改造后的定義如下：

public interface ILogHelperProvider
{
    Task Log(LogHelperLoggingEvent loggingEvent);
}

(這里回傳了一個 Task，可能回傳型別是 void 就足夠了，看自己的需要)

這樣在實作 LogProvider 的時候只需要實作這個介面就可以了，不需要再實作一個 Logger 了

增加 Enricher

Enricher 定義：

public interface ILogHelperLoggingEnricher
{
    void Enrich(LogHelperLoggingEvent loggingEvent);
}

內置了一個 PropertyEnricher，方便添加一些簡單的屬性


internal class PropertyLoggingEnricher : ILogHelperLoggingEnricher
{
    private readonly string _propertyName;
    private readonly Func<LogHelperLoggingEvent, object> _propertyValueFactory;
    private readonly bool _overwrite;
    private readonly Func<LogHelperLoggingEvent, bool> _logPropertyPredict = null;

    public PropertyLoggingEnricher(string propertyName, object propertyValue, bool overwrite = false) : this(propertyName, (loggingEvent) => propertyValue, overwrite)
    {
    }

    public PropertyLoggingEnricher(string propertyName, Func<LogHelperLoggingEvent, object> propertyValueFactory,
                                   bool overwrite = false) : this(propertyName, propertyValueFactory, null, overwrite)
    {
    }

    public PropertyLoggingEnricher(string propertyName, Func<LogHelperLoggingEvent, object> propertyValueFactory, Func<LogHelperLoggingEvent, bool> logPropertyPredict,
                                   bool overwrite = false)
    {
        _propertyName = propertyName;
        _propertyValueFactory = propertyValueFactory;
        _logPropertyPredict = logPropertyPredict;
        _overwrite = overwrite;
    }

    public void Enrich(LogHelperLoggingEvent loggingEvent)
    {
        if (_logPropertyPredict?.Invoke(loggingEvent) != false)
        {
            loggingEvent.AddProperty(_propertyName, _propertyValueFactory, _overwrite);
        }
    }
}

為 ILogFactory 增加一個 AddEnricher 的方法


/// <summary>
/// add log enricher
/// </summary>
/// <param name="enricher">log enricher</param>
/// <returns></returns>
bool AddEnricher(ILogHelperLoggingEnricher enricher);

這樣我們在記錄日志的時候就可以通過這些 Enricher 豐富 LoggingEvent 中的 Properties 了

為了方便 Property 的操作，我們增加了一些擴展方法：

public static ILogHelperFactory WithEnricher<TEnricher>(this ILogHelperFactory logHelperFactory,
                                                        TEnricher enricher) where TEnricher : ILogHelperLoggingEnricher
{
    logHelperFactory.AddEnricher(enricher);
    return logHelperFactory;
}

public static ILogHelperFactory WithEnricher<TEnricher>(this ILogHelperFactory logHelperFactory) where TEnricher : ILogHelperLoggingEnricher, new()
{
    logHelperFactory.AddEnricher(new TEnricher());
    return logHelperFactory;
}

public static ILogHelperFactory EnrichWithProperty(this ILogHelperFactory logHelperFactory, string propertyName, object value, bool overwrite = false)
{
    logHelperFactory.AddEnricher(new PropertyLoggingEnricher(propertyName, value, overwrite));
    return logHelperFactory;
}

public static ILogHelperFactory EnrichWithProperty(this ILogHelperFactory logHelperFactory, string propertyName, Func<LogHelperLoggingEvent> valueFactory, bool overwrite = false)
{
    logHelperFactory.AddEnricher(new PropertyLoggingEnricher(propertyName, valueFactory, overwrite));
    return logHelperFactory;
}

public static ILogHelperFactory EnrichWithProperty(this ILogHelperFactory logHelperFactory, string propertyName, object value, Func<LogHelperLoggingEvent, bool> predict, bool overwrite = false)
{
    logHelperFactory.AddEnricher(new PropertyLoggingEnricher(propertyName, e => value, predict, overwrite));
    return logHelperFactory;
}

public static ILogHelperFactory EnrichWithProperty(this ILogHelperFactory logHelperFactory, string propertyName, Func<LogHelperLoggingEvent, object> valueFactory, Func<LogHelperLoggingEvent, bool> predict, bool overwrite = false)
{
    logHelperFactory.AddEnricher(new PropertyLoggingEnricher(propertyName, valueFactory, predict, overwrite));
    return logHelperFactory;
}

MessageTemplate

從上面的 LoggingEvent 中已經增加了 MessageTemplate，于是我們引入了微軟日志框架中日志的格式化，將 messageTemplate 和 parameters 轉換成 Message 和 Properties，具體參考 https://github.com/WeihanLi/WeihanLi.Common/blob/276cc49cfda511f9b7b3bb8344ee52441c4a3b23/src/WeihanLi.Common/Logging/LoggingFormatter.cs

internal struct FormattedLogValue
{
    public string Msg { get; set; }

    public Dictionary<string, object> Values { get; set; }

    public FormattedLogValue(string msg, Dictionary<string, object> values)
    {
        Msg = msg;
        Values = values;
    }
}

internal static class LoggingFormatter
{
    public static FormattedLogValue Format(string msgTemplate, object[] values)
    {
        if (values == null || values.Length == 0)
            return new FormattedLogValue(msgTemplate, null);

        var formatter = new LogValuesFormatter(msgTemplate);
        var msg = formatter.Format(values);
        var dic = formatter.GetValues(values)
            .ToDictionary(x => x.Key, x => x.Value);

        return new FormattedLogValue(msg, dic);
    }
}

這樣我們就可以支持 messageTemplate 了，然后來改造一下我們的 Logger

public interface ILogHelperLogger
{
    void Log(LogHelperLogLevel logLevel, Exception exception, string messageTemplate, params object[] parameters);

    bool IsEnabled(LogHelperLogLevel logLevel);
}

與上面不同的是，我們增加了 parameters

再來更新一下我們的擴展方法，上面的擴展方法是直接使用 string.Format 的方式的格式化的，我們這里要更新一下

public static void Info(this ILogHelperLogger logger, string msg, params object[] parameters)
{
    logger.Log(LogHelperLogLevel.Info, null, msg, parameters);
}

public static void Info(this ILogHelperLogger logger, Exception ex, string msg) => logger.Log(LogHelperLogLevel.Info, ex, msg);

public static void Info(this ILogHelperLogger logger, Exception ex) => logger.Log(LogHelperLogLevel.Info, ex, ex?.Message);

至此，功能基本完成，但是從 API 的角度來說，感覺現在的 ILogFactory 太重了，這些 AddProvider/AddEnricher/AddFilter 都應該屬性 ILogFactory 的內部屬性，通過配置來完成，不應該成為它的介面方法，于是就有了下一版

V4

這一版主要是引入了 LoggingBuilder，通過 LoggingBuilder 來配置內部的 LogFactory 所需要的 Provider/Enricher/Filter，原來他們的配置方法和擴展方法均變成ILogHelperLoggingBuilder

public interface ILogHelperLoggingBuilder
{
    /// <summary>
    /// Adds an ILogHelperProvider to the logging system.
    /// </summary>
    /// <param name="provider">The ILogHelperProvider.</param>
    bool AddProvider(ILogHelperProvider provider);

    /// <summary>
    /// add log enricher
    /// </summary>
    /// <param name="enricher">log enricher</param>
    /// <returns></returns>
    bool AddEnricher(ILogHelperLoggingEnricher enricher);

    /// <summary>
    /// Add logs filter
    /// </summary>
    /// <param name="filterFunc">filterFunc, logProviderType/categoryName/Exception, whether to write log</param>
    bool AddFilter(Func<Type, string, LogHelperLogLevel, Exception, bool> filterFunc);

    ///// <summary>
    ///// config period batching
    ///// </summary>
    ///// <param name="period">period</param>
    ///// <param name="batchSize">batchSize</param>
    //void PeriodBatchingConfig(TimeSpan period, int batchSize);

    /// <summary>
    /// Build for LogFactory
    /// </summary>
    /// <returns></returns>
    ILogHelperFactory Build();
}

增加 logging 的配置：

public static class LogHelper
{
    private static ILogHelperFactory LogFactory { get; private set; } = NullLogHelperFactory.Instance;

    public static void ConfigureLogging(Action<ILogHelperLoggingBuilder> configureAction)
    {
        var loggingBuilder = new LogHelperLoggingBuilder();
        configureAction?.Invoke(loggingBuilder);
        LogFactory = loggingBuilder.Build();
    }

    public static ILogHelperLogger GetLogger<T>() => LogFactory.GetLogger(typeof(T));

    public static ILogHelperLogger GetLogger(Type type) => LogFactory.GetLogger(type);

    public static ILogHelperLogger GetLogger(string categoryName)
    {
        return LogFactory.CreateLogger(categoryName);
    }
}

最后的使用方式：

internal class LoggingTest
{
    private static readonly ILogHelperLogger Logger = LogHelper.GetLogger<LoggingTest>();

    public static void MainTest()
    {
        var abc = "1233";
        LogHelper.ConfigureLogging(builder =>
                                   {
                                       builder
                                           .AddLog4Net()
                                           //.AddSerilog(loggerConfig => loggerConfig.WriteTo.Console())
                                           .WithMinimumLevel(LogHelperLogLevel.Info)
                                           .WithFilter((category, level) => level > LogHelperLogLevel.Error && category.StartsWith("System"))
                                           .EnrichWithProperty("Entry0", ApplicationHelper.ApplicationName)
                                           .EnrichWithProperty("Entry1", ApplicationHelper.ApplicationName, e => e.LogLevel >= LogHelperLogLevel.Error)// 當 LogLevel 是 Error 及以上級別時才增加 Property
                                           ;
                                   });

        Logger.Debug("12333 {abc}", abc);
        Logger.Trace("122334334");
        Logger.Info($"122334334 {abc}");

        Logger.Warn("12333, err:{err}", "hahaha");
        Logger.Error("122334334");
        Logger.Fatal("12333");
    }
}

增加 LoggingEvent 還想做一個批量提交日志，如上面定義的 PeriodBatchingConfig 一樣，批量同步到 Provider 但是實際使用下來，有些 provider 不支持設定日志的時間，時間是內部記錄的，這樣一來日志記錄的時間就不準了，而且大多都不支持批量寫日志，所以后面放棄了，但是如果只是用自己的擴展，不用 log4net 之類的外部的日志框架的話，我覺得還是可以做的，可以提高效率，目前主要用 Serilog 和 log4net，暫時不更新了，就先這樣吧

下一版本要解決的事情

ILogProvider 記錄日志回傳一個 Task 感覺有些雞肋，沒太大意義，后面再改一下吧
Serilog 的 Filter 是基于 LogEvent 的，后面看是否需要改一下，基于 LogEvent 的話更簡潔，而且可以根據 LogEvent 內的 Properties 做過濾，所以 AddFilter 的API 可以更新一下 AddFilter(Func<LogHelperLoggingEvent, bool> filter)

Reference

https://github.com/serilog/serilog
https://github.com/serilog/serilog-sinks-periodicbatching
https://github.com/aspnet/Logging
https://github.com/aspnet/Extensions/tree/master/src/Logging
https://github.com/WeihanLi/WeihanLi.Common/tree/dev/src/WeihanLi.Common/Logging

轉載請註明出處，本文鏈接：https://www.uj5u.com/qita/51454.html

標籤：其他

上一篇：微信支付-小程式H5 公眾號 Payment SDK

下一篇：到底什么是.NET?

動手造輪子：寫一個日志框架

動手造輪子：寫一個日志框架

Intro

V0

V1

V2

V3

引入 LoggingEvent

改造 LogProvider

增加 Enricher

MessageTemplate

V4

More

Reference