Günlükçü sarmalayıcı için en iyi uygulama

Uygulamamda bir nlogger kullanmak istiyorum, belki gelecekte kayıt sistemini değiştirmem gerekecek. Bu yüzden bir ağaç kesme cephesi kullanmak istiyorum.

Bunları nasıl yazacağınıza dair mevcut örnekler için herhangi bir öneri biliyor musunuz? Ya da bana bu alandaki en iyi uygulamalara bağlantı verin.

Ben gibi cephe günlüğü kullanmak için kullanılan Common.Logging (hatta kendi gizlemek için CuttingEdge.Logging kütüphane), ancak günümüzde kullandığım Bağımlılık Enjeksiyon kalıbı ve bu benim kendi (basit) soyutlama arkasında gizlemek loggers beni izin verdiğini hem yapıştığı Bağımlılık Ters Çevirme İlkesi ve Arayüz Ayrım İlkesi(ISP) bir üyeye sahip olduğu ve arayüz uygulamam tarafından tanımlandığı için; harici bir kitaplık değil. Uygulamanızın temel bölümlerinin harici kitaplıkların varlığıyla ilgili sahip olduğu bilgileri en aza indirgemek daha iyidir; günlük kitaplığınızı değiştirmek gibi bir niyetiniz olmasa bile. Harici kitaplığa olan sıkı bağımlılık, kodunuzu test etmeyi zorlaştırır ve uygulamanızı, asla uygulamanız için özel olarak tasarlanmamış bir API ile karmaşık hale getirir.

Uygulamalarımda soyutlama genellikle böyle görünüyor:

public interface ILogger
{
    void Log(LogEntry entry);
}

public enum LoggingEventType { Debug, Information, Warning, Error, Fatal };

// Immutable DTO that contains the log information.
public class LogEntry 
{
    public readonly LoggingEventType Severity;
    public readonly string Message;
    public readonly Exception Exception;

    public LogEntry(LoggingEventType severity, string message, Exception exception = null)
    {
        if (message == null) throw new ArgumentNullException("message");
        if (message == string.Empty) throw new ArgumentException("empty", "message");

        this.Severity = severity;
        this.Message = message;
        this.Exception = exception;
    }
}

İsteğe bağlı olarak, bu soyutlama bazı basit genişletme yöntemleriyle genişletilebilir (arayüzün dar kalmasına ve ISP'ye bağlı kalmasına izin verir). Bu, bu arayüzün tüketicileri için kodu çok daha basit hale getirir:

public static class LoggerExtensions
{
    public static void Log(this ILogger logger, string message) {
        logger.Log(new LogEntry(LoggingEventType.Information, message));
    }

    public static void Log(this ILogger logger, Exception exception) {
        logger.Log(new LogEntry(LoggingEventType.Error, exception.Message, exception));
    }

    // More methods here.
}

Arabirim yalnızca tek bir yöntem içerdiğinden , log4net'e , Serilog , Microsoft.Extensions.Logging , NLog veya diğer herhangi bir günlük kitaplığına proxy oluşturan bir ILoggeruygulamayı kolayca oluşturabilir ve DI kapsayıcınızı, içinde a bulunan sınıflara enjekte edecek şekilde yapılandırabilirsiniz. yapıcı.ILogger

Tek bir yöntemle bir arabirimin üstünde statik uzantı yöntemlerine sahip olmanın, birçok üyeli bir arabirime sahip olmaktan oldukça farklı olduğunu unutmayın. Uzantı yöntemleri, bir LogEntrymesaj oluşturan ve bunu ILoggerarayüzdeki tek yöntemden geçiren yardımcı yöntemlerdir . Uzantı yöntemleri, tüketicinin kodunun bir parçası haline gelir; soyutlamanın bir parçası değil. Bu, yalnızca uzantı yöntemlerinin soyutlamayı, uzantı yöntemlerini ve genişletme yöntemlerini değiştirmeye gerek kalmadan gelişmesine izin vermez.LogEntryyapıcı, günlükçü soyutlaması kullanıldığında, bu günlükçü stubbe edilmiş / alay edilmiş olsa bile her zaman çalıştırılır. Bu, bir test paketinde çalışırken kaydediciye yapılan çağrıların doğruluğu hakkında daha fazla kesinlik sağlar. Tek üyeli arayüz testi çok daha kolay hale getirir; Çok sayıda üyeyle bir soyutlamaya sahip olmak, uygulamalar (taklitler, bağdaştırıcılar ve dekoratörler gibi) oluşturmayı zorlaştırır.

Bunu yaptığınızda, günlüğe kaydetme cephelerinin (veya başka herhangi bir kütüphanenin) sunabileceği bazı statik soyutlamalara neredeyse hiç gerek kalmaz.

NuGet aracılığıyla da kullanılabilen https://github.com/uhaciogullari/NLog.Interface adresindeki küçük arayüz sarmalayıcı + adaptörünü kullandım :

PM> Install-Package NLog.Interface 

Şu an itibariyle, en iyi bahis Microsoft.Extensions.Logging paketini kullanmaktır ( Julian'ın belirttiği gibi ). Çoğu günlüğe kaydetme çerçevesi bununla kullanılabilir.

Steven'ın cevabında açıklandığı gibi kendi arayüzünüzü tanımlamak basit durumlar için uygundur, ancak önemli olduğunu düşündüğüm birkaç şeyi gözden kaçırır:

• Yapısal günlüğe kaydetme ve nesneleri yeniden yapılandırma (Serilog ve NLog'daki @ notasyonu)
• Gecikmeli dizi oluşturma / biçimlendirme: bir dizge aldığından, çağrıldığında her şeyi değerlendirmesi / biçimlendirmesi gerekir, sonunda etkinlik eşiğin altında olduğu için günlüğe kaydedilmeyecektir (performans maliyeti, önceki noktaya bakın)
• IsEnabled(LogLevel)Performans nedenleriyle bir kez daha isteyebileceğiniz gibi koşullu kontroller

Muhtemelen tüm bunları kendi soyutlamanızda uygulayabilirsiniz, ancak bu noktada tekerleği yeniden icat edeceksiniz.

Genellikle şöyle bir arayüz oluşturmayı tercih ederim

public interface ILogger
{
 void LogInformation(string msg);
 void LogError(string error);
}

ve çalışma zamanında bu arayüzden uygulanan somut bir sınıf enjekte ediyorum.

LibLog projesi şeklinde bu soruna harika bir çözüm ortaya çıktı .

LibLog, Serilog, NLog, Log4net ve Enterprise logger dahil olmak üzere büyük kaydediciler için yerleşik desteğe sahip bir günlük özetidir. NuGet paket yöneticisi aracılığıyla bir .dll başvurusu yerine kaynak (.cs) dosyası olarak bir hedef kitaplığa yüklenir. Bu yaklaşım, kütüphaneyi harici bir bağımlılık almaya zorlamadan loglama soyutlamasının dahil edilmesine izin verir. Ayrıca, bir kitaplık yazarının, tüketen uygulamayı kitaplığa açıkça bir günlük kaydedici sağlamaya zorlamadan günlüğe kaydetmeyi dahil etmesine olanak tanır. LibLog, hangi somut kaydedicinin kullanımda olduğunu anlamak için yansıma kullanır ve kütüphane projelerinde / projelerinde herhangi bir açık kablolama kodu olmadan ona bağlanır.

Dolayısıyla, LibLog, kütüphane projelerinde oturum açmak için harika bir çözümdür. Sadece ana uygulamanızda veya hizmetinizde somut bir kaydediciye (kazanç için Serilog) referans verin ve yapılandırın ve kütüphanelerinize LibLog ekleyin!

Kendi cephenizi yazmak yerine Castle Logging Services veya Simple Logging Facade kullanabilirsiniz .

Her ikisi de NLog ve Log4net için adaptörler içerir.

2015'ten beri .NET çekirdek uygulamaları oluşturuyorsanız, .NET Core Logging'i de kullanabilirsiniz .

NLog'un bağlanabileceği paket:

• ASP.NET Core kullanıcıları için NLog.Web.AspNetCore
• .NET Core kullanıcıları için NLog.Extensions.Logging , örneğin konsol projeleri