C# Singleton Logging Class

Question

Tôi đang cố gắng tìm ra chiến lược tốt nhất để đăng nhập vào máy chủ web async-IO mà tôi đang làm việc. Tôi nghĩ cách đơn giản nhất là có một lớp singleton giúp Filestream mở cho các tệp nhật ký phù hợp để tôi có thể làm một cái gì đó như:

Util.Logger.GetInstance().LogAccess(str); 

Hoặc tương tự.

Lớp học của tôi trông như thế này:

public sealed class Logger { 
    private static StreamWriter sw; 
    private static readonly Logger instance = new Logger(); 
    private Logger() { 
     sw = new StreamWriter(logfile); 
    } 
    public static Logger GetInstance() { 
     return instance; 
    } 
    public void LogAccess(string str) { 
     sw.WriteLine(str); 
    } 
} 

Đây là tất cả chỉ là trong đầu tôi thực sự, và tôi đang tìm gợi ý về cách để làm cho nó tốt hơn và cũng chắc chắn rằng tôi đang làm nó đúng cách. Điều lớn nhất là tôi cần nó để được thread an toàn, mà rõ ràng là nó không phải là ở trạng thái hiện tại của nó. Không chắc chắn cách tốt nhất để làm điều đó.

Answer 1

Có một phương pháp TextWriter.Synchronized trong đó sản xuất một phiên bản thread-safe của TextWriter. Hãy thử điều đó.

Answer 2

Tôi không nghĩ có cách nào đơn giản xung quanh khóa nếu bạn muốn ghi vào cùng một tệp từ nhiều chuỗi.

Vì vậy, giải pháp đơn giản là thêm lock xung quanh mọi cuộc gọi đến StreamWriter. Ngoài ra, bạn có thể đệm đầu ra trong bộ nhớ và chỉ ghi nó vào tập tin một lần trong một thời gian mà vẫn yêu cầu khóa, nhưng tranh chấp khóa sẽ thấp hơn rất nhiều. Tuy nhiên, nếu bạn đi đến chiều dài đó, bạn cũng có thể đi với một khung đăng nhập thích hợp như log4net, which is thread-safe.

Answer 3

a) Không bao gồm "Nhật ký" trong tên phương thức. Rõ ràng là một nhật ký logger. .Warning, .Error, vv là các tên phương thức tốt hơn vì chúng mô tả mức độ mà mục nhật ký có.

b) Tạo chủ đề nền viết cho nhật ký.

c) Nhập các mục nhập từ phương thức ghi nhật ký và báo hiệu chuỗi công nhân.

d) Sử dụng (Tôi không biết nếu tôi nhớ tên phương pháp chính xác)

var methodInfo = new StackFrame(1).GetMethod(); 
var classAndMethod = methodInfo.DeclaringType.Name + "." + methodInfo.Name; 

để có được những phương pháp gọi điện thoại.

Làm như vậy sẽ chỉ cung cấp cho bạn một chuỗi truy cập tệp.

Answer 4

Điều này được tự động xử lý cho bạn nếu bạn sử dụng NLog - bạn xác định tất cả các trình ghi nhật ký của mình trong tệp .config và sau đó bạn truy cập tất cả chúng qua lớp LogManager tĩnh, là Singleton.

Dưới đây là một ví dụ minh họa tính chất thread-safe của NLog:

http://nlog-project.org/wiki/Tutorial#Adding_NLog_to_an_application

Answer 5

Có thể bạn nên thử NLog hoặc Log4net. Cả hai đều là khung đăng nhập tuyệt vời.

Nhưng nếu bạn muốn viết thành phần nhật ký của riêng mình, Khóa là phải khi bạn xuất thông điệp tường trình. Thông thường, việc lưu thông điệp tường trình vào bộ nhớ và ghi chúng vào tệp một lần trong một thời gian.

Answer 6

Một khuôn khổ khác bổ sung những vấn đề này cho bạn là the Object Guy's logging framework. Nó có thể tùy ý đăng nhập trong nền.Nhiều luồng có thể đăng nhập vào cùng một tệp. Và nhiều quy trình có thể đăng nhập vào cùng một tệp.

Answer 7

Hoặc bạn có thể sử dụng một lớp học với phương pháp chỉ chia sẻ ..

Imports System.Threading 

Public Class Logger 
    Private Shared ReadOnly syncroot As New Object 

    Public Shared Sub log(ByVal vInt As Integer) 
     ThreadPool.QueueUserWorkItem(New WaitCallback(AddressOf logThread), CStr(vInt)) 
    End Sub 

    Public Shared Sub log(ByVal vStr As String) 
     ThreadPool.QueueUserWorkItem(New WaitCallback(AddressOf logThread), vStr) 
    End Sub 

    Private Shared Sub logThread(ByVal o As Object) 
     Dim str As String = CStr(o) 
     SyncLock syncroot 
      Using objWriter As New System.IO.StreamWriter(GetLogPath, True) 

       objWriter.WriteLine(str) 
       objWriter.Close() 

      End Using 
     End SyncLock 
    End Sub 

    Private Shared Function GetLogPath() As String 
     Return "logs.txt" 
    End Function 
End Class 

tôi thấy nó có thể sử dụng nhiều cách này vì sử dụng một singleton:

Logger.log("Something to log") 

Cheers