Qt實現應用程序單實例運行--LocalServer方式

使Qt應用程序能夠單實例運行的典型實現方法是使用共享內存實現。該方法實現簡單，代碼簡潔。

但有一個致命缺陷：共享內存（QSharedMemory）實現的單程序運行，當運行環境是UNIX時，並且程序不幸崩潰，會導致共享內存無法釋放，從而無法重新運行程序！

 

所以應該尋找其他的使Qt應用程序能夠單實例運行的方案。於是找到LocalSocket和LocalServer通訊方案（據說Qt官方商業版的QSingleApplication的原理好像跟這個差不多）。

“要用到Qt的QLocalSocket，QLocalServer類，這兩個類從接口上看和網絡通信socket沒有區別，但是它並不是真正的網絡API，只是模仿了而已。這兩個類在Unix/Linux系統上采用Unix域socket實現，而在Windows上則采用有名管道（named pipe）來實現。”

參見：

http://www.oschina.net/code/snippet_54100_629

http://blog.csdn.net/qq19831030qq/article/details/6199896

 

上面的方案實際操作過程中出現很多問題：

QString serverName = QCoreApplication::applicationName(); //獲取到的serverName為空

為了解決上面的問題，最直接的測試方法是先手動指定一個serverName，

然后將QFile::remove(m_localServer->serverName());改成QFile::remove(serverName);

 

當手動指定serverName時，習慣上將serverName設為當前的應用程序名，在linux下這又導致下面的問題

QFile::remove(m_localServer->serverName()); //執行刪除失敗(實際測試發現失敗原因是：嘗試刪除應用程序文件自身！)

 

 上面的兩個問題導致Qt應用程序無法單實例運行。

 

后來終於在StackOverflow上面看到解決方案：使用QLocalServer::removeServer()刪除LocalServer名

下面是實現代碼：

頭文件：

#ifndef SINGLEAPPLICATION_H
#define SINGLEAPPLICATION_H

#include <QObject>
#include <QApplication>
#include <QtNetwork/QLocalServer>
#include <QWidget>

class SingleApplication : public QApplication {
        Q_OBJECT
    public:
        SingleApplication(int &argc, char **argv);

        bool isRunning();                // 是否已經有實例在運行
        QWidget *w;                        // MainWindow指針

    private slots:
        // 有新連接時觸發
        void _newLocalConnection();

    private:
        // 初始化本地連接
        void _initLocalConnection();
        // 創建服務端
        void _newLocalServer();
        // 激活窗口
        void _activateWindow();

        bool _isRunning;                // 是否已經有實例在運行
        QLocalServer *_localServer;     // 本地socket Server
        QString _serverName;            // 服務名稱
};

#endif // SINGLEAPPLICATION_H

 CPP文件：

#include "SingleApplication.h"
#include <QtNetwork/QLocalSocket>
#include <QFileInfo>

#define TIME_OUT                (500)    // 500ms

SingleApplication::SingleApplication(int &argc, char **argv)
    : QApplication(argc, argv)
    , w(NULL)
    , _isRunning(false)
    , _localServer(NULL) {

    // 取應用程序名作為LocalServer的名字
    _serverName = QFileInfo(QCoreApplication::applicationFilePath()).fileName();

    _initLocalConnection();
}


////////////////////////////////////////////////////////////////////////////////
// 說明：
// 檢查是否已經有一個實例在運行, true - 有實例運行， false - 沒有實例運行
////////////////////////////////////////////////////////////////////////////////
bool SingleApplication::isRunning() {
    return _isRunning;
}

////////////////////////////////////////////////////////////////////////////////
// 說明：
// 通過socket通訊實現程序單實例運行，監聽到新的連接時觸發該函數
////////////////////////////////////////////////////////////////////////////////
void SingleApplication::_newLocalConnection() {
    QLocalSocket *socket = _localServer->nextPendingConnection();
    if(socket) {
        socket->waitForReadyRead(2*TIME_OUT);
        delete socket;

        // 其他處理，如：讀取啟動參數

        _activateWindow();
    }
}

////////////////////////////////////////////////////////////////////////////////
// 說明：
// 通過socket通訊實現程序單實例運行，
// 初始化本地連接，如果連接不上server，則創建，否則退出
////////////////////////////////////////////////////////////////////////////////
void SingleApplication::_initLocalConnection() {
    _isRunning = false;    

    QLocalSocket socket;
    socket.connectToServer(_serverName);
    if(socket.waitForConnected(TIME_OUT)) {
        fprintf(stderr, "%s already running.\n",
                _serverName.toLocal8Bit().constData());
        _isRunning = true;
        // 其他處理，如：將啟動參數發送到服務端
        return;
    }

    //連接不上服務器，就創建一個
    _newLocalServer();
}

////////////////////////////////////////////////////////////////////////////////
// 說明：
// 創建LocalServer
////////////////////////////////////////////////////////////////////////////////
void SingleApplication::_newLocalServer() {
    _localServer = new QLocalServer(this);
    connect(_localServer, SIGNAL(newConnection()), this, SLOT(_newLocalConnection()));
    if(!_localServer->listen(_serverName)) {
        // 此時監聽失敗，可能是程序崩潰時,殘留進程服務導致的,移除之
        if(_localServer->serverError() == QAbstractSocket::AddressInUseError) {
            QLocalServer::removeServer(_serverName); // <-- 重點 77             _localServer->listen(_serverName); // 再次監聽 78         }
    }
}

////////////////////////////////////////////////////////////////////////////////
// 說明：
// 激活主窗口
////////////////////////////////////////////////////////////////////////////////
void SingleApplication::_activateWindow() {
    if(w) {
        w->show();
        w->raise();
        w->activateWindow(); // 激活窗口
    }
}

調用示例：

#include "MainWindow.h"
#include "SingleApplication.h"

int main(int argc, char *argv[]) {
    SingleApplication a(argc, argv);
    if(!a.isRunning()) {
        MainWindow w;
        a.w = &w;

        w.show();

        return a.exec();
    }
    return 0;
}