1. 程式人生 > >【C# 開發技巧】如何防止程序多次運行

【C# 開發技巧】如何防止程序多次運行

false name classname 發現 mic RR www. nvi lib

一、引言

最近發現很多人在論壇中問到如何防止程序被多次運行的問題的,如: http://social.msdn.microsoft.com/Forums/zh-CN/6398fb10-ecc2-4c03-ab25-d03544f5fcc9, 所以這裏就記錄下來,希望給遇到同樣問題的朋友有所參考的,同時也是對自己的一個積累。在介紹具體實現代碼之前,我們必須明確解決這個問題的思路是什麽的?下面只要分享我的一個思考的這個問題的方式:

  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
        }
    }
}

四、程序實現效果

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

技術分享圖片

原文鏈接:https://www.cnblogs.com/zhili/p/OnlyInstance.html

【C# 開發技巧】如何防止程序多次運行