C＃我正确使用锁吗？

Question

我目前正在尝试编写一个线程安全的记录器类。 我对这方面的正确设计和最佳实践不是很熟悉。 我的代码有缺陷吗？

public class WriteStuff
{
    private readonly StreamWriter m_Writer;
    private readonly object m_WriteLock = new object ();

    public WriteStuff(String path)
    {
        m_Writer = File.CreateText (path);

        m_Writer.WriteLine ("x");
        m_Writer.Flush ();
    }

    public void ListenTo(Foo foo)
    {
        foo.SomeEvent += new EventHandler<SomeArgs> (Foo_Update);
    }

    private void Foo_Update(object sender, SomeArgs args)
    {
        lock (m_WriteLock) {
            m_Writer.WriteLine (args);
            m_Writer.Flush ();
        }
    }
}

Answer 1

嗯，这看起来对我好; 我可能IDisposable实现为Close()文件的一种方法，但是......

当然，您也可以使用任何（许多）预先封装的日志框架。

---

更新：

一想法：您可能想要考虑如果文件已经存在会发生什么; 你不想踩踏你的日志......

Answer 2

您发布的内容从多线程角度看起来很好。 虽然我可能是错的，但似乎任何其他代码执行某些多线程（甚至使用foo对象）应该是安全的。 当然，我在代码段中看不到任何死锁 。

还有一些值得注意的事情（除了非常小心死锁和严格测试以确保它们不会发生）：

• 最好是把一个锁周围的代码在构造函数中，我相信这是可能在某些情况下，该方法可以前的构造块已经完成执行调用。 （如果我错了，请有人纠正我。）
• 在这种情况下， StreamWriter对象是私有的，这很好。 如果它是受保护的或内部的，你肯定必须小心其他代码如何使用该对象（实际上我认为最好几乎总是将这些对象声明为私有）。
• 你已经完成了正确的锁定！ 锁定单独的私有实例对象始终是最安全的，因为您知道该对象不能被您自己的任何其他代码锁定（如果您锁定this对象或StreamWriter对象本身则不是这种情况）。

尽管如此，我可能会遗漏一些东西，并且上面没有显示的其他代码可能会导致问题的可能性很小，但据我所知，除了构造函数代码可能缺少锁定之外，代码没有缺陷。 当您开始执行更复杂的多线程时，尤其是跨类/实例，您更可能需要注意死锁情况。

无论如何，希望有所帮助。

Answer 3

事件处理程序与事件生成器位于同一个线程上，这意味着您的应用程序可能最终被日志文件写入阻止。

private void Foo_Update(object sender, SomeArgs args)        { 
    ThreadPool.QueueUserWorkItem(WriteAsync, args);
}

private void WriteAsync(object state) {  
    SomeArgs args = (SomeArgs)state;    
    lock (m_WriteLock) {                        
       m_Writer.WriteLine (args);                        
       m_Writer.Flush ();                
   }        
}