天天看點

C#如何防止程式多次運作的技巧(精典)

一、引言

最近發現很多人在論壇中問到如何防止程式被多次運作的問題的,是以這裡就記錄下來,希望給遇到同樣問題的朋友有所參考的,同時也是對自己的一個積累。在介紹具體實作代碼之前,我們必須明确解決這個問題的思路是什麼的?下面隻要分享我的一個思考的這個問題的方式:

1、當我們點選一個exe檔案時,此時該exe程式将會運作,我們可以看到該程式的界面,對于計算機而言,就是會在系統上開啟一個該程式的進行,這個我們可以通過任務管理器來檢視的(當我們點選exe之後,程式運作,系統會建立一個與與程式同名的程序)

2、既然我們要防止程式運作多次,也就是說程式隻能運作一次,從作業系統的角度來講就是該程式的程序隻能是唯一的,分析到這裡我們自然就想到了,要保證該程式程序隻有一個,我們就要判斷下該程式程序是否在自己的作業系統上運作了,如果已經運作了一個程序,當我們下次運作exe的時候,此時不是再開啟該程式程序,而是退出,彈出一個提示框告訴使用者該程式已經運作,如果作業系統沒有運作該程式程序,則運作這個程式。

3、進而這個問題就轉換為判斷該程式程序的數量問題了,此時我們就想.NET 有沒有提供一個類可以獲得該程序名的數量,如果數量大于1則說明該程式已經運作了,小于就表明程式沒有運作。如果熟悉.NET類庫的人肯定知道.NET類庫中有一個Process類,該類的意思就是一個程序的抽象。(有些人就會說,我一開始不知道有這個類那怎麼辦呢?那就是考驗你英文了,因為程序的英文就是Process,然而所有程式設計語言的命名都很通俗易懂,此時就可以用Process在MSDN上搜尋,這樣你也就發現這個類了)

4、除了第三點中提出找程序數量的思路外,還有另外一種實作思路就是——我們能不能讓運作一個程序的時候,讓該程序具有一個變量,該變量是唯一辨別該程序,當點選exe檔案預建立一個改程式程序時,我們去判斷這個變量是否存在,如果存在就說明這個程序已經運作,進而退出本次的程式,并且提示給使用者說該程式已經運作。

從上面的分析過程中可以看出,我們解決這個問題的思路就是從程序入手,第三點的思路就是直接從程序數量入手,而第四點思路也是從程序入手,隻是做了一個變換罷了,讓一個變量來唯一辨別一個程序,當變量存在時說明該程式程序也運作了。

二、使用互斥量Mutex

弄懂了主要的實作思路之後,下面看代碼實作就完全不是問題了,使用互斥量的實作就是第四點的思路的展現,我們用為該程式程序建立一個互斥量Mutex對象變量,當運作該程式時,該程式程序就具有了這個互斥的Mutex變量,如果再次運作該程式時,通過檢查該互斥變量是否存在(來替換檢測這個程序是否存在),如果存在則說明程式已運作,否則就沒運作。這裡需要注意的是:從我的多線程同步的文章大家可以知道,Mutex類也可以對線程進行同步,那是不是其他對線程同步的類也可以解決本專題中的問題呢?答案是否定,之是以Mutex類可以解決這個問題,是因為Mutex類除了可以對線程同步,也可以對程序同步。下面就具體看看實作代碼吧:

using System;
using System.Threading;
using System.Windows.Forms;

namespace OnlyInstanceRunning
{
  static class Program
  {
    /// <summary>
    /// 應用程式的主入口點。
    /// </summary>
    [STAThread]
    static void Main()
    {
      #region 方法一:使用互斥量
      bool createNew;

      // createdNew:
      // 在此方法傳回時,如果建立了局部互斥體(即,如果 name 為 null 或空字元串)或指定的命名系統互斥體,則包含布爾值 true;
      // 如果指定的命名系統互斥體已存在,則為false
      using (Mutex mutex = new Mutex(true, Application.ProductName, out createNew))
      {
        if (createNew)
        {
          Application.EnableVisualStyles();
          Application.SetCompatibleTextRenderingDefault(false);
          Application.Run(new Form1());
        }
        // 程式已經運作的情況,則彈出消息提示并終止此次運作
        else
        {
          MessageBox.Show("應用程式已經在運作中...");
          System.Threading.Thread.Sleep(1000);

          // 終止此程序并為基礎作業系統提供指定的退出代碼。
          System.Environment.Exit(1);
        }
      }

      #endregion
    }
  }
}
      

  三、直接判斷程序是否存在的方式來解決這個問題

3.1 判斷該程式程序數量的方式

有了上面的思路分析之後,相信大家看下面代碼會覺得一目了然,這裡就不多解釋了,直接看代碼:

#region 方法二:使用程序名
      Process[] processcollection = Process.GetProcessesByName(Application.CompanyName);
      // 如果該程式程序數量大于,則說明該程式已經運作,則彈出提示資訊并提出本次操作,否則就建立該程式
      if (processcollection.Length >= 1)
      {
        MessageBox.Show("應用程式已經在運作中。。");
        Thread.Sleep(1000);
        System.Environment.Exit(1);
      }
      else
      {
        Application.EnableVisualStyles();
        Application.SetCompatibleTextRenderingDefault(false);
        // 運作該應用程式
        Application.Run(new Form1());
      }
      #endregion 
      

  3.2 直接判斷程式程序是否存在的方式

using System;
using System.Diagnostics;
using System.Reflection;
using System.Runtime.InteropServices;
using System.Windows.Forms;

namespace Way3
{
  static class Program
  {
    #region 方法三:使用的Win32函數的聲明
    /// <summary>
    /// 設定視窗的顯示狀态
    /// Win32 函數定義為:http://msdn.microsoft.com/en-us/library/windows/desktop/ms633548(v=vs.85).aspx
    /// </summary>
    /// <param name="hWnd">視窗句柄</param>
    /// <param name="cmdShow">訓示視窗如何被顯示</param>
    /// <returns>如果窗體之前是可見,傳回值為非零;如果窗體之前被隐藏,傳回值為零</returns>
    [DllImport("User32.dll")]
    private static extern bool ShowWindow(IntPtr hWnd, int cmdShow);

    /// <summary>
    /// 建立指定視窗的線程設定到前台,并且激活該視窗。鍵盤輸入轉向該視窗,并為使用者改變各種可視的記号。
    /// 系統給建立前台視窗的線程配置設定的權限稍高于其他線程。
    /// </summary>
    /// <param name="hWnd">将被激活并被調入前台的視窗句柄</param>
    /// <returns>如果視窗設入了前台,傳回值為非零;如果視窗未被設入前台,傳回值為零</returns>
    [DllImport("User32.dll")]
    private static extern bool SetForegroundWindow(IntPtr hWnd);

    // 訓示視窗為普通顯示
    private const int WS_SHOWNORMAL = 1;
    #endregion

    /// <summary>
    /// 應用程式的主入口點。
    /// </summary>
    [STAThread]
    static void Main()
    {
      #region 方法三:調用Win32 API,并激活運作程式的視窗顯示在最前端
      // 這種方式在VS調用的情況不成立的,因為在VS中按F5運作的程序為OnlyInstanceRunning.vshost,從這個程序的命名就可以看出,該程序為OnlyInstanceRunning程序的宿主程序
      // 關于這個程序的更多内容可以檢視:http://msdn.microsoft.com/zh-cn/library/ms185331(v=vs.100).aspx
      // 而直接點OnlyInstanceRunning.exe運作的程式程序為OnlyInstanceRunning,
      // 但是我們可以一些小的修改,即currentProcess.ProcessName.Replace(".vshose","")此時無論如何都為 OnlyInstanceRunning

      // 獲得正在運作的程式,如果沒有相同的程式,則運作該程式
      Process process = RunningInstance();
      if (process == null)
      {
        Application.EnableVisualStyles();
        Application.SetCompatibleTextRenderingDefault(false);
        Application.Run(new Form1());
      }
      else
      {
        // 已經運作該程式,顯示資訊并使程式顯示在前端
        MessageBox.Show("應用程式已經在運作中......");
        HandleRunningInstance(process);
      }
      #endregion 
    }

    #region 方法三定義的方法
    /// <summary>
    /// 擷取正在運作的程式,沒有運作的程式則傳回null
    /// </summary>
    /// <returns></returns>
    private static Process RunningInstance()
    {
      // 擷取目前活動的程序
      Process currentProcess = Process.GetCurrentProcess();

      // 根據目前程序的程序名獲得程序集合
      // 如果該程式運作,程序的數量大于1
      Process[] processcollection = Process.GetProcessesByName(currentProcess.ProcessName.Replace(".vshost", ""));
      foreach (Process process in processcollection)
      {
        // 如果程序ID不等于目前運作程序的ID以及運作程序的檔案路徑等于目前程序的檔案路徑
        // 則說明同一個該程式已經運作了,此時将傳回已經運作的程序
        if (process.Id != currentProcess.Id)
        {
          if (Assembly.GetExecutingAssembly().Location.Replace("/", "\\") == process.MainModule.FileName)
          {
            return process;
          }
        }
      }

      return null;
    }

    /// <summary>
    /// 顯示已運作的程式
    /// </summary>
    /// <param name="instance"></param>
    private static void HandleRunningInstance(Process instance)
    {
      // 顯示視窗
      ShowWindow(instance.MainWindowHandle, WS_SHOWNORMAL);

      // 把窗體放在前端
      SetForegroundWindow(instance.MainWindowHandle);
    }

    #endregion
  }
}
      

  3.3 解決3.2實作方式中存在的問題——隻能是最小化的窗體顯示出來,如果隐藏到托盤中則不能把運作的程式顯示出來

using System;
using System.Diagnostics;
using System.Runtime.InteropServices;
using System.Windows.Forms;

namespace Way4
{
  static class Program
  {

    #region 方法四:使用的Win32函數的聲明

    /// <summary>
    /// 找到某個視窗與給出的類别名和視窗名相同視窗
    /// 非托管定義為:http://msdn.microsoft.com/en-us/library/windows/desktop/ms633499(v=vs.85).aspx
    /// </summary>
    /// <param name="lpClassName">類别名</param>
    /// <param name="lpWindowName">視窗名</param>
    /// <returns>成功找到傳回視窗句柄,否則傳回null</returns>
    [DllImport("user32.dll")]
    public static extern IntPtr FindWindow(string lpClassName, string lpWindowName);

    /// <summary>
    /// 切換到視窗并把視窗設入前台,類似 SetForegroundWindow方法的功能
    /// </summary>
    /// <param name="hWnd">視窗句柄</param>
    /// <param name="fAltTab">True代表視窗正在通過Alt/Ctrl +Tab被切換</param>
    [DllImport("user32.dll ", SetLastError = true)]
    static extern void SwitchToThisWindow(IntPtr hWnd, bool fAltTab);

    ///// <summary>
    ///// 設定視窗的顯示狀态
    ///// Win32 函數定義為:http://msdn.microsoft.com/en-us/library/windows/desktop/ms633548(v=vs.85).aspx
    ///// </summary>
    ///// <param name="hWnd">視窗句柄</param>
    ///// <param name="cmdShow">訓示視窗如何被顯示</param>
    ///// <returns>如果窗體之前是可見,傳回值為非零;如果窗體之前被隐藏,傳回值為零</returns>
    [DllImport("user32.dll", EntryPoint = "ShowWindow", CharSet = CharSet.Auto)]
    public static extern int ShowWindow(IntPtr hwnd, int nCmdShow);
    public const int SW_RESTORE = 9;
    public static IntPtr formhwnd;
    #endregion

    /// <summary>
    /// 應用程式的主入口點。
    /// </summary>
    [STAThread]
    static void Main()
    {
      #region 方法四: 可以是托盤中的隐藏程式顯示出來
      // 方法四相對于方法三而言應該可以說是一個改進,
      // 因為方法三隻能是最小化的窗體顯示出來,如果隐藏到托盤中則不能把運作的程式顯示出來
      // 具體問題可以看這個文章:http://social.msdn.microsoft.com/Forums/zh-CN/6398fb10-ecc2-4c03-ab25-d03544f5fcc9
      Process currentproc = Process.GetCurrentProcess();
      Process[] processcollection = Process.GetProcessesByName(currentproc.ProcessName.Replace(".vshost", string.Empty));
      // 該程式已經運作,
      if (processcollection.Length >= 1)
      {
        foreach (Process process in processcollection)
        {
          if (process.Id != currentproc.Id)
          {
            // 如果程序的句柄為0,即代表沒有找到該窗體,即該窗體隐藏的情況時
            if (process.MainWindowHandle.ToInt32() == 0)
            {
              // 獲得窗體句柄
              formhwnd = FindWindow(null, "Form1");
              // 重新顯示該窗體并切換到帶入到前台
              ShowWindow(formhwnd, SW_RESTORE);
              SwitchToThisWindow(formhwnd, true);
            }
            else
            {
              // 如果窗體沒有隐藏,就直接切換到該窗體并帶入到前台
              // 因為窗體除了隐藏到托盤,還可以最小化
              SwitchToThisWindow(process.MainWindowHandle, true);
            }
          }
        }
      }
      else
      {
        Application.EnableVisualStyles();
        Application.SetCompatibleTextRenderingDefault(false);
        Application.Run(new Form1());
      }
      #endregion
    }
  }
}
      

  四、程式實作效果

四種實作方式的運作效果都是差不多的,這裡就以實作方式一作為示範的,具體實作效果如下圖:

C#如何防止程式多次運作的技巧(精典)

五、總結

寫這個專題主要是看到原因是看到有些朋友問了這樣的問題,是以就總結下具體的實作代碼來幫助遇到同樣問題的朋友做一個參考,同時也是對自己一個學習的積累和複習。