WinForm中的一种死锁场景

最近客户反映系统总是时不时的卡死一次,开始以为是电脑环境问题,后来发现其他电脑上也会出现这种问题。收到反馈后，就开始找原因呀 ，重现呀。折腾了一上午终于找到了原因：“死锁”；

这个死锁发生的有点奇怪。因为只有一个同步根，怎么也会死锁呢。下面写一段小代码 描述一下发生死锁的情形：

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using System.Threading;

namespace DeadLock
{
    public partial class Form1 : Form
    {
        Button btnGetValue;
        public Form1()
        {
            InitializeComponent();
            this.Controls.Add(btnGetValue);
            btnGetValue.Click += new EventHandler(btnGetValue_Click);
            DataPoolManager.GetInstance().ValueChanged += new DataPoolManager.ValueChangedHandle(Form1_ValueChanged);
        }

        void btnGetValue_Click(object sender, EventArgs e)
        {
            int index = 0;
            string colName = string.Empty;
            //do something....
            DataPoolManager.GetInstance().GetValue(index, colName);
        }

        void Form1_ValueChanged(object sender, EventArgs e)
        {
            //do something...
            Thread.Sleep(100);
            //造成死锁的位置
            this.Invoke((MethodInvoker)delegate()
            {
                //do something
            });
        }
    }

    public class DataPoolManager
    {
        private DataPoolManager() { }

        static DataPoolManager instance;

        public static DataPoolManager GetInstance()
        {
            if (instance == null)
            {
                lock (syncRoot)
                {
                    if (instance == null)
                    {
                        instance = new DataPoolManager();
                    }
                }
            }
            return instance;
        }

        /// <summary>
        /// 同步根
        /// </summary>
        static readonly object syncRoot = new object();

        public delegate void ValueChangedHandle(object sender,EventArgs e);

        /// <summary>
        /// 肇事事件 ,该事件被UI窗体注册
        /// </summary>
        public event ValueChangedHandle ValueChanged;

        /// <summary>
        /// 这个方法可能被UI线程调用
        /// </summary>
        public string GetValue(int rowIndex, string colName)
        {
            //造成死锁的位置
            lock (syncRoot)
            {
                //do something...
                Thread.Sleep(100);
                return DateTime.Now.ToString("yyyy-MM-dd HH:MM ss");
            }
        }

        /// <summary>
        /// 这个方法由线程池中的某个线程调用,是个比较耗时的操作
        /// </summary>
        public bool SetValue(string key, string colName, string newValue)
        {
            bool result = false;
            lock (syncRoot)
            {
                // do something...
                Thread.Sleep(100);
                if (result == true)
                {
                    //引发肇事事件
                    OnValueChanged(new EventArgs());
                }
            }
            return result;
        }

        private void OnValueChanged(EventArgs eventArgs)
        {
            ValueChangedHandle handle = ValueChanged;
            if (handle != null)
            {
                handle(this, eventArgs);
            }
        }

    }
}

 

在窗体上注册了 DataPoolManager 的 ValueChanged 事件  ,该事件不是由UI线程引发的,所以在事件处理中 使用了 this.Invoke 方法 ，见代码第37行。这本没什么错误，但是关键在于 这个事件是在 DataPoolManager 对象中 SetValue 方法中的 Lock 语句块中引发的 。这就意味着如果该事件不执行完，同步根将一直被“占用”。这时候 ，在SetValue方法没有引发事件之前 ,如果UI线程调用了 GetValue 方法 ,UI线程将在代码的 第 83 行出等待 ,而 执行 SetValue的方法引发事件后,在 代码 37 行出 执行 this.Invoke 的时候 发生死锁。

找到原因了，问题就好解决了，有两个解决方案：

1，SetValue 方法中，引发事件的操作放到Lock块的外部执行。如下：

        public bool SetValue(string key, string colName, string newValue)
        {
            bool result = false;
            lock (syncRoot)
            {
                // do something...
                Thread.Sleep(100);
            }
            if (result == true)
            {
                //在同步块外部引发事件
                OnValueChanged(new EventArgs());
            }
            return result;
        }

2，将事件处理中的this.Invoke 改成 this.BeginInvoke:

void Form1_ValueChanged(object sender, EventArgs e)
       {
           //do something...
           Thread.Sleep(100);
           //不等待返回
           this.BeginInvoke((MethodInvoker)delegate()
           {
               //do something
           });
       }