ManagementObjectSearcher 导致 onclick 处理程序的重入问题

Question

我在保护一段代码时遇到了一个奇怪的问题。我的应用程序是一个托盘应用程序。我在我的类 (ApplicationContext) 中创建了一个 NotifyIcon。我已经为 NotifyIcon 对象分配了一个气球点击处理程序和一个双击处理程序。还有一个上下文菜单，但我没有显示所有代码。只有重要的部分。

 public class SysTrayApplicationContext: ApplicationContext
 {
    private NotifyIcon notifyIcon;
    private MainForm afDashBoardForm;

   public SysTrayApplicationContext()
   {
    this.notifyIcon = new NotifyIcon();
    this.notifyIcon.BalloonTipClicked += notifyIcon_BalloonTipClicked;
    this.notifyIcon.MouseDoubleClick += notifyIcon_MouseDoubleClick;
     // ... more code
   }

两个处理程序都启动或创建/显示我的表单：

        private void notifyIcon_MouseDoubleClick(object sender, MouseEventArgs e)
       {
          if (e.Button == MouseButtons.Left)
          {
              openDashboard();
          }
       }

    private void notifyIcon_BalloonTipClicked(object sender, EventArgs e)
    {
        openDashboard();
    }

    private void openDashboard()
    {
            if (dashBoardForm != null)
            {
                log.Debug("Dashboard form created already, so Activate it");
                dashBoardForm.Activate();
            }
            else
            {
                log.Debug("Dashboard form does not exist, create it");
                dashBoardForm = new MainForm();
                dashBoardForm.Show();
            }
    }

上面的代码有问题。可能不止 1 个。问题：可以显示 2 个仪表板表单，这不是我想要的。如果用户在显示气球消息时双击托盘图标会导致 openDashboard 中出现竞争条件。我可以很容易地重现这一点。因此，我在 openDashboard 代码中的代码周围添加了一个锁，令我惊讶的是，这并没有阻止显示 2 个仪表板表单。我应该无法创建 2 个 MainForms。我哪里错了？

这里是带有锁语句的更新代码：

        private void openDashboard()
        {
          lock (dashBoardFormlocker)
          {
            if (dashBoardForm != null)
            {
                log.Debug("Dashboard form created already, so Activate it");
                dashBoardForm.Activate();
            }
            else
            {
                log.Debug("Dashboard form does not exist, create it");
                dashBoardForm = new MainForm();
                dashBoardForm.Show();
            }
         }
      }

注意：锁对象已添加到类中并在构造函数中初始化。

private object dashBoardFormlocker;

更新：显示更多代码。这就是代码开始的方式：

    static void Main()
    {
        if (SingleInstance.Start())
        {
            Application.EnableVisualStyles();
            Application.SetCompatibleTextRenderingDefault(false);
            XmlConfigurator.Configure();
            // For a system tray application we don't want to create 
            // a form, we instead create a new ApplicationContext.  The Run method takes
            Application.Run(new SysTrayApplicationContext());
            SingleInstance.Stop();
            SingleInstance.Dispose();
        }
    }
}

更新 2：为清晰起见提供更多代码

public partial class MainForm : Form
{

    public MainForm()
    {
        log.Trace("MainForm constructor...");
        InitializeComponent();
        // ... code not shown
        this.label_OSVersion.Text = getOSFriendlyName();

        // .. more code
    }

    private string getOSFriendlyName()
    {
        try
        {
            string result = string.Empty;
            var mgmtObj = (from x in new ManagementObjectSearcher("SELECT Caption FROM Win32_OperatingSystem").Get().OfType<ManagementObject>()
                           select x.GetPropertyValue("Caption")).FirstOrDefault();
            result = mgmtObj != null ? mgmtObj.ToString() : string.Empty;
            OperatingSystem os = Environment.OSVersion; 
            String sp = os.ServicePack ?? string.Empty;

            return !string.IsNullOrWhiteSpace(result) ? result + sp : "Unknown";
        }
        catch (System.Exception ex)
        {
            log.Error("Error trying to get the OS version", ex);
            return "Unknown";
        }
    }
}

Answer 1

主 UI 线程必须始终泵送消息循环以支持来自 COM 组件的通信。 因此，当您从 UI 线程执行阻塞操作（例如锁定或加入线程）时（编辑：根据 Peter Duniho 的修复进行编辑），UI 线程将进入“可提醒”状态，允许 COM 调度某些类型的消息，其中turn 可能会导致像您的场景一样的重入问题。 查看这个问题的答案 (Why did entering a lock on a UI thread trigger an OnPaint event?) 以获得更准确的解释。

查看ManagementObjectSearcher.Get的源码有一个锁（在Initialize里面），由于你是从你的form的构造函数中调用的，可能会导致第二个事件触发，而form的构造函数还没有完成.对 dashBoardFormlocker 变量的赋值仅在构造函数完成后发生，因此这可以解释为什么它在第二个条目上为空。

故事的寓意是永远不要在 UI 线程上执行阻塞操作。

Answer 2

如果没有可靠地重现问题的a good, minimal, complete code example，就不可能确定问题出在哪里。但是the guess by answerer tzachs 似乎是合理的。如果是这样，您可以通过将方法更改为如下所示来解决您的问题：

private bool _dashboardOpen;

private void openDashboard()
{
    if (_dashboardOpen)
    {
        if (dashBoardForm != null)
        {
            log.Debug("Dashboard form created already, so Activate it");
            dashBoardForm.Activate();
        }
    }
    else
    {
        log.Debug("Dashboard form does not exist, create it");
        _dashboardOpen = true;
        dashBoardForm = new MainForm();
        dashBoardForm.Show();
    }
}

这样，任何重新打开窗口的尝试都会被检测到。请注意，您仍然需要在实际激活之前检查null；您无法激活尚未真正完成创建的窗口。无论如何，随后对Show() 的调用将负责激活，因此在重入情况下忽略激活应该无关紧要。