Có phải là một thực hành tốt để có trình ghi nhật ký như một singleton?

Tôi có thói quen chuyển trình ghi nhật ký cho hàm tạo, như:

public class OrderService : IOrderService {
     public OrderService(ILogger logger) {
     }
}

Nhưng điều đó khá khó chịu, vì vậy tôi đã sử dụng nó một thuộc tính sau:

private ILogger logger = NullLogger.Instance;
public ILogger Logger
{
    get { return logger; }
    set { logger = value; }
}

Điều này cũng đang trở nên khó chịu - nó không khô khan, tôi cần phải lặp lại điều này trong mọi lớp học. Tôi có thể sử dụng lớp cơ sở, nhưng sau đó một lần nữa - tôi đang sử dụng lớp Biểu mẫu, vì vậy sẽ cần FormBase, v.v. Vì vậy, tôi nghĩ rằng, mặt trái của việc để singleton với ILogger bị lộ ra ngoài, vì vậy rất nhiều người sẽ biết nơi lấy trình ghi nhật ký:

    Infrastructure.Logger.Info("blabla");

CẬP NHẬT: Như Merlyn đã nhận thấy một cách chính xác, tôi nên đề cập rằng trong ví dụ thứ nhất và thứ hai, tôi đang sử dụng DI.

Điều này cũng trở nên khó chịu - nó không KHÔ

Đúng. Nhưng bạn chỉ có thể làm được rất nhiều điều cho mối quan tâm xuyên suốt trải khắp mọi loại hình bạn có. Bạn phải sử dụng trình ghi nhật ký ở khắp mọi nơi, vì vậy bạn phải có thuộc tính trên các loại đó.

Vì vậy, hãy xem chúng ta có thể làm gì với nó.

Singleton

Singleton thật khủng khiếp <flame-suit-on>.

Tôi khuyên bạn nên gắn bó với việc tiêm thuộc tính như bạn đã làm với ví dụ thứ hai của mình. Đây là cách tính toán tốt nhất mà bạn có thể làm mà không cần dùng đến phép thuật. Tốt hơn là có một phụ thuộc rõ ràng hơn là ẩn nó qua một singleton.

Nhưng nếu những chiếc đĩa đơn giúp bạn tiết kiệm đáng kể thời gian, bao gồm tất cả việc tái cấu trúc mà bạn sẽ phải làm (thời gian quả cầu pha lê!), Tôi cho rằng bạn có thể sống chung với chúng. Nếu có một lần sử dụng Singleton, thì đây có thể là nó. Hãy ghi nhớ những chi phí nếu bạn từng muốn thay đổi tâm trí của bạn sẽ vào khoảng cao như nó được.

Nếu bạn làm điều này, hãy kiểm tra câu trả lời của những người khác sử dụng các Registrymô hình (xem mô tả), và những người đăng ký một (resetable) singleton nhà máy chứ không phải là một trường hợp singleton logger.

Có những lựa chọn thay thế khác có thể hoạt động tốt mà không ảnh hưởng nhiều, vì vậy bạn nên kiểm tra chúng trước.

Đoạn mã Visual Studio

Bạn có thể sử dụng các đoạn mã Visual Studio để tăng tốc độ nhập của mã lặp lại đó. Bạn sẽ có thể gõ một cái gì đó giống như loggertab, và mã sẽ xuất hiện một cách kỳ diệu cho bạn.

Sử dụng AOP để KHÔ

Bạn có thể loại bỏ một chút mã chèn thuộc tính đó bằng cách sử dụng khuôn khổ Lập trình hướng theo khía cạnh (AOP) như PostSharp để tự động tạo một số mã.

Nó có thể trông giống như thế này khi bạn hoàn thành:

[InjectedLogger]
public ILogger Logger { get; set; }

Bạn cũng có thể sử dụng mã mẫu theo dõi phương pháp của họ để tự động theo dõi mã vào và ra của phương thức, điều này có thể loại bỏ sự cần thiết phải thêm tất cả các thuộc tính của trình ghi nhật ký lại với nhau. Bạn có thể áp dụng thuộc tính ở cấp độ lớp hoặc rộng không gian tên:

[Trace]
public class MyClass
{
    // ...
}

// or

#if DEBUG
[assembly: Trace( AttributeTargetTypes = "MyNamespace.*",
    AttributeTargetTypeAttributes = MulticastAttributes.Public,
    AttributeTargetMemberAttributes = MulticastAttributes.Public )]
#endif

Tôi đặt một thể hiện trình ghi nhật ký vào vùng chứa phụ thuộc của mình, sau đó sẽ đưa trình ghi nhật ký vào các lớp cần một.

Câu hỏi hay. Tôi tin rằng trong hầu hết các dự án, trình ghi nhật ký là một singleton.

Một số ý tưởng chỉ nảy ra trong đầu tôi:

• Sử dụng ServiceLocator (hoặc một vùng chứa Dependency Injection khác nếu bạn đã sử dụng bất kỳ) cho phép bạn chia sẻ trình ghi nhật ký qua các dịch vụ / lớp, theo cách này, bạn có thể khởi tạo trình ghi nhật ký hoặc thậm chí nhiều trình ghi nhật ký khác nhau và chia sẻ qua ServiceLocator, đây rõ ràng sẽ là một singleton , một số kiểu Kiểm soát Nghịch đảo . Cách tiếp cận này cho phép bạn linh hoạt hơn nhiều so với quá trình khởi tạo và khởi tạo trình ghi nhật ký.
• Nếu bạn cần Logger gần như ở khắp mọi nơi - thực hiện phương pháp khuyến nông cho Objectloại vì vậy mỗi lớp sẽ có thể gọi các phương thức logger của thích LogInfo(), LogDebug(),LogError()

Một singleton là một ý kiến ​​hay. Một ý tưởng tốt hơn nữa là sử dụng mẫu Registry , cho phép kiểm soát nhiều hơn một chút đối với việc khởi tạo. Theo tôi, mô hình singleton quá gần với các biến toàn cục. Với việc tạo hoặc sử dụng lại đối tượng xử lý sổ đăng ký, có chỗ cho những thay đổi trong tương lai đối với các quy tắc khởi tạo.

Bản thân Registry có thể là một lớp tĩnh để cung cấp cú pháp đơn giản để truy cập nhật ký:

Registry.Logger.Info("blabla");

Một singleton đơn thuần không phải là một ý kiến ​​hay. Rất khó để thay thế bộ ghi nhật ký. Tôi có xu hướng sử dụng các bộ lọc cho trình ghi nhật ký của mình (một số lớp "ồn ào" có thể chỉ ghi cảnh báo / lỗi).

Tôi sử dụng mẫu singleton kết hợp với mẫu proxy cho nhà máy ghi nhật ký:

public class LogFactory
{
    private static LogFactory _instance;

    public static void Assign(LogFactory instance)
    {
        _instance = instance;
    }

    public static LogFactory Instance
    {
        get { _instance ?? (_instance = new LogFactory()); }
    }

    public virtual ILogger GetLogger<T>()
    {
        return new SystemDebugLogger();
    }
}

Điều này cho phép tôi tạo một FilteringLogFactoryhoặc chỉ một SimpleFileLogFactorymà không cần thay đổi bất kỳ mã nào (và do đó tuân thủ nguyên tắc Mở / Đóng).

Phần mở rộng mẫu

public class FilteredLogFactory : LogFactory
{
    public override ILogger GetLogger<T>()
    {
        if (typeof(ITextParser).IsAssignableFrom(typeof(T)))
            return new FilteredLogger(typeof(T));

        return new FileLogger(@"C:\Logs\MyApp.log");
    }
}

Và sử dụng nhà máy mới

// and to use the new log factory (somewhere early in the application):
LogFactory.Assign(new FilteredLogFactory());

Trong lớp học của bạn sẽ ghi:

public class MyUserService : IUserService
{
    ILogger _logger = LogFactory.Instance.GetLogger<MyUserService>();

    public void SomeMethod()
    {
        _logger.Debug("Welcome world!");
    }
}

Có một cuốn sách Dependency Injection trong .NET. Dựa trên những gì bạn cần, bạn nên sử dụng đánh chặn.

Trong cuốn sách này có một sơ đồ giúp quyết định xem có nên sử dụng Hàm chèn khối dẫn, tiêm thuộc tính, tiêm phương pháp, Bối cảnh xung quanh, Đánh chặn hay không.

Đó là cách một lý do sử dụng sơ đồ này:

1. Bạn có phụ thuộc hoặc cần nó? - Cần nó
2. Đó có phải là mối quan tâm xuyên suốt không? - Đúng
3. Bạn cần câu trả lời từ nó? - Không

Sử dụng Đánh chặn

Một giải pháp khác mà cá nhân tôi thấy dễ dàng nhất là sử dụng lớp Logger tĩnh. Bạn có thể gọi nó từ bất kỳ phương thức lớp nào mà không cần phải thay đổi lớp, ví dụ như thêm thuộc tính vào, v.v. Nó khá đơn giản và dễ sử dụng.

Logger::initialize ("filename.log", Logger::LEVEL_ERROR); // only need to be called once in your application

Logger::log ("my error message", Logger::LEVEL_ERROR); // to be used in every method where needed

Nếu bạn muốn xem xét một giải pháp tốt để đăng nhập Tôi đề nghị bạn nhìn vào động cơ ứng dụng google với python nơi khai thác gỗ cũng đơn giản như import loggingvà sau đó bạn có thể chỉ logging.debug("my message")hay logging.info("my message")mà thực sự giữ nó đơn giản như nó phải.

Java không có một giải pháp tốt để ghi nhật ký, tức là nên tránh log4j vì nó thực tế buộc bạn phải sử dụng các singleton mà như đã trả lời ở đây là "khủng khiếp" và tôi đã có kinh nghiệm khủng khiếp khi cố gắng tạo ra kết quả ghi nhật ký cùng một câu lệnh ghi nhật ký chỉ một lần khi tôi nghi ngờ rằng lý do ghi nhật ký kép là do tôi có một Singleton của đối tượng ghi nhật ký trong hai bộ nạp lớp trong cùng một máy ảo (!)

Tôi cầu xin sự tha thứ của bạn vì không quá cụ thể cho C # nhưng từ những gì tôi đã thấy các giải pháp với C # trông giống với Java nơi chúng ta đã có log4j và chúng ta cũng nên biến nó thành một singleton.

Đó là lý do tại sao tôi thực sự thích giải pháp với GAE / python , nó đơn giản nhất có thể và bạn không phải lo lắng về bộ tải lớp, nhận câu lệnh ghi nhật ký kép hoặc bất kỳ mẫu thiết kế nào cho vấn đề đó.

Tôi hy vọng một số thông tin này có thể liên quan đến bạn và tôi hy vọng rằng bạn muốn xem xét giải pháp ghi nhật ký của tôi mà tôi đề xuất thay vì tôi bắt nạt về mức độ vấn đề mà Singleton bị nghi ngờ do không thể có một singleton thực sự khi nó phải được cài đặt trong một số bộ nạp lớp.