Qt实现程序单实例运行(只能运行1个进程)及QSharedMemory用法

1. 问题提出

在开发时，经常遇到这样的需求或场景：程序只能被启动一次，不能启动多次，启动多次会导致混乱，如：可执行程序用到文件指针、串口句柄等。试想如果存在多个同一个文件的句柄或同一个串口的句柄，就可能在同一时刻对同一文件或串口进行写操作，这样会导致文件内容杂乱、损坏；现实中，当一个串口被一个程序占用时，另外一个程序尝试打开这个串口会报错，因此需要控制程序运行时只能开启一个实例，如何用Qt实现程序单实例运行？

2. 实现方法

直接上代码，看代码注释就能理解

cpp 复制代码

#include <QSharedMemory>
#include <QDebug>
bool programIsRunning(QSharedMemory**ppSharedMemory)
{
    /* 为共享内存定义一个字符串类型的key，该key用于标识共享内存对象。
     * key可以是任意字符串，但必须保证程序运行的机器上不能同时存在同样
     * 字符串表示的共享内存对象，否则就会造成共享内存访问混乱
     */
    const auto key = QString(QLatin1String("huaHaiFCSoftWare"));
    bool isRunning = false;
    auto pSharedMemory = new QSharedMemory(key); // 创建共享内存对象

    /* 将指向共享内存对象的指针的地址保存到一个二级指针上，
     * 便于程序退出时，删除该共享内存对象
     */
    ppSharedMemory = &pSharedMemory;

    // 创建一段大小为1024的共享内存段
    auto b = pSharedMemory->create(1024);

    /* 创建共享内存时也许出错了，获取错误码
     */
    auto errNo = pSharedMemory->error();

    /* 后续代码要读写刚才创建的共享内存中的内容，
     * 在读写共享内存之前要锁定该段共享内存,防止共享内存的内容被另外的
     * 进程或本程序的另外一个实例更改，有点类似多线程下访问数据需要加锁
     */
    pSharedMemory->lock();

    /* 如果上面create创建共享内存成功,那么就向共享内存
     * 写入一点东西，写入的东西可随意，这里写入的是共享内存对象的标识符
     */
    if(b)
    {
        auto pSharedMemoryData = static_cast<char*>(pSharedMemory->data()); // 获取共享内存的数据指针
        strncpy_s(pSharedMemoryData, 1024, key.toStdString().c_str(), strlen(key.toStdString().c_str()) + 1);
    }
    /*
     * 如果上面create创建共享内存失败，且失败的原因是该段共享内存存在了，证明
     * 存在本程序的一个实例已经在运行，该段共享内存就是这个已经在运行的实例创建的
    */
    else if(!b && (QSharedMemory::AlreadyExists == errNo))
    {
        /* 以读写模式将事先已经在运行的本程序的实例进程附到这段共享内存上，
         * 如果不调用attach，则data()函数将返回nullptr
         */
        pSharedMemory->attach();
        auto pSharedMemoryData = static_cast<char*>(pSharedMemory->data());

        /*将共享内存的内容读出并检测是否和以前写入
         *共享内存的内容一样，如果一样，证明本程序的
         *一个实例已经在运行，则就将正在运行标志isRunning设置为true
        */
        if((nullptr != pSharedMemoryData) && !strcmp(pSharedMemoryData, key.toStdString().c_str()))
        {
            qDebug() << QStringLiteral("程序已经在运行,\n同一程序不能开启多个!");
            isRunning = true;
        }
    }

    pSharedMemory->unlock(); // 访问完共享内存后，要解锁，否则其它进程或本程序的其它实例访问不了这段共享内存

    /* 注意：不能在本函数delete共享内存对象，否则create创建的共享内存的内容会
            释放，这样会造成本程序的多个实例启动时，会检测不到有本程序的实例已经在运行
     */
    //  delete pSharedMemory;
    return isRunning;
}

int main(int argc, char *argv[])
{
    QApplication a(argc, argv);
    QSharedMemory**ppSharedMemory = nullptr;

    // 如果发现本程序的一个实例已经在运行，则本次启动的实例进程直接退出
    if(programIsRunning(ppSharedMemory))
    {
        delete ppSharedMemory;
        return 1;
    }


    // 程序的其它代码略


    auto nRet = a.exec();

    // 当程序完全退出时才删除创建的共享内存对象
    delete ppSharedMemory;

    return nRet;
}