线程安全日志类实现

Question

以下是实现相当简单的线程安全日志记录类的正确方法吗？

我知道我从未明确关闭 TextWriter，这会是一个问题吗？

当我最初使用 TextWriter.Synchronized 方法时，它似乎不起作用，直到我在静态构造函数中初始化它并将其设置为只读，如下所示：

public static class Logger
{
    static readonly TextWriter tw; 

    static Logger()
    {
        tw = TextWriter.Synchronized(File.AppendText(SPath() + "\\Log.txt")); 
    }

    public static string SPath()
    {
        return ConfigManager.GetAppSetting("logPath"); 
    }

    public static void Write(string logMessage)
    {
        try
        {
            Log(logMessage, tw);
        }
        catch (IOException e)
        {
            tw.Close();
        }
    }

    public static void Log(string logMessage, TextWriter w)
    {
        w.WriteLine("{0} {1}", DateTime.Now.ToLongTimeString(),
            DateTime.Now.ToLongDateString());
        w.WriteLine("  :");
        w.WriteLine("  :{0}", logMessage);
        w.WriteLine("-------------------------------");

        // Update the underlying file.
        w.Flush();
    }
}

Answer 1

我将在这里采取与其他答案完全不同的方法，并假设您实际上想学习如何编写更好的线程感知代码，并且不寻求我们的第 3 方建议（即使您实际上可能最终使用一个。）

正如其他人所说，您正在创建一个线程安全的 TextWriter 这意味着对 WriteLine 的调用是线程安全的，这并不意味着对 WriteLine 的大量调用> 将作为原子操作执行。我的意思是不能保证四个 WriteLine 调用会按顺序发生。您可能有一个线程安全的 TextWriter，但没有线程安全的 Logger.Log 方法；）为什么？因为在这四个调用期间的任何时候，另一个线程都可能决定也调用 Log。这意味着您的 WriteLine 调用将不同步。解决这个问题的方法是使用像这样的 lock 语句：

private static readonly object _syncObject = new object();

public static void Log(string logMessage, TextWriter w)    {
   // only one thread can own this lock, so other threads
   // entering this method will wait here until lock is
   // available.
   lock(_syncObject) {
      w.WriteLine("{0} {1}", DateTime.Now.ToLongTimeString(),
          DateTime.Now.ToLongDateString());
      w.WriteLine("  :");
      w.WriteLine("  :{0}", logMessage);
      w.WriteLine("-------------------------------");
      // Update the underlying file.
      w.Flush();
   }
}

所以，现在你有一个线程安全的 TextWriter 和一个线程安全的 Logger >。

有道理吗？

Answer 2

今天有人在讨论一些日志记录问题时向我指出了这篇文章。我们在这里已经有了很好的答案，但我添加我的答案只是为了展示 Logger 类的更简单版本，它以完全线程安全的方式执行完全相同的操作.
这里需要注意的一件主要事情是，线程安全不需要 TextWriter.Synchronized，因为我们是在适当的锁 内写入文件。

注意：这已经在 x0n 答案的评论部分讨论过。

public static class Logger
{
    static readonly object _locker = new object();

    public static void Log(string logMessage)
    {
        try
        {
            var logFilePath = Path.Combine(@"C:\YourLogDirectoryHere", "Log.txt");
            //Use this for daily log files : "Log" + DateTime.Now.ToString("yyyy-MM-dd") + ".txt";
            WriteToLog(logMessage, logFilePath);
        }
        catch (Exception e)
        {
            //log log-exception somewhere else if required!
        }
    }

    static void WriteToLog(string logMessage, string logFilePath)
    {
        lock (_locker)
        {
            File.AppendAllText(logFilePath,
                    string.Format("Logged on: {1} at: {2}{0}Message: {3}{0}--------------------{0}", 
                    Environment.NewLine, DateTime.Now.ToLongDateString(),
                    DateTime.Now.ToLongTimeString(), logMessage));
        }
    }
}

要记录某些内容，只需调用 as

Logger.Log("Some important event has occurred!");

它就会生成如下所示的日志条目

登录时间：2015 年 10 月 7 日，时间：02:11:23
消息：发生了一些重要事件！
--------------------

Answer 3

调用 TextWriter.Synchronized 将保护 的单个实例TextWriter，它不会同步您的写入，因此一个“Log”调用会保留在文件内。

如果您从多个线程调用 Write（或使用内部 TextWriter 实例的 Log），则各个 WriteLine 调用可能会交织在一起，使您的日期和时间戳无法使用。

我个人会使用已经存在的第三方日志记录解决方案。如果这不是一个选项，那么自己同步它（即使使用简单的锁）可能比使用框架的 TextWriter.Synchronized 包装器更有用。

Answer 4

您应该研究这个类（.NET 2.0 的一部分），无需“创建”您自己的记录器。使您能够登录到文本文件、事件视图等。

http ://msdn.microsoft.com/en-us/library/system.diagnostics.tracesource.aspx

您的“Log”方法可能看起来像这样（假设有一个名为'traceSource')：

    public void Log(TraceEventType eventType, string message)
    {
        this.traceSource.TraceEvent(eventType, 0, message);
        this.traceSource.Flush();
    }

支持此功能的是一个配置部分，它命名 TraceSource 并具有一些配置设置。假设当您在记录器中构造 TraceSource 时，您将使用配置中指定的跟踪源之一实例化它。

<system.diagnostics>
<sources>
  <source name="Sample" switchValue="Information,ActivityTracing">
    <listeners>
      <add name="file"
         initializeData="C:\temp\Sample-trace.log"
         traceOutputOptions="DateTime"
         type="System.Diagnostics.TextWriterTraceListener, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"/>
    </listeners>
  </source>
</sources>

另外，不要让你的记录器静态。相反，使用 Enterprise Library 5.0 Unity 进行依赖注入/IOC。

希望这有帮助！

Answer 5

如果您正在寻找一种简单的方法来检测代码，.NET 中已经存在该工具：

http://msdn.microsoft.com/en-us/library/system.diagnostics.trace.aspx

此外，第三方工具将为您提供强大的日志记录解决方案；示例包括 log4net、nLog，以及企业库。

我真的建议不要在这方面重新发明轮子:)