Windows禁止应用多实例

2023年3月27日字数统计：769

“简单”研究了一下Windows如何禁止应用开启多实例，实际有两个通用方案：使用 CreateFileW 在临时文件夹中创建一个独占的文件实现互斥以及使用 CreateMutexExW 创建一个独占的具名互斥锁实现互斥；需要监听端口的程序使用 bind 时也自带这种效果，这些方法都能实现原子的互斥。

微软实际上推荐使用 CreateFileW 在用户临时文件夹里创建唯一的文件，因为这样可以只禁止单用户多实例不禁止每个用户有自己的实例，但考虑到使用文件的方式会创建不必要的文件，并且获得临时文件夹路径的API不保证临时文件夹一定可用（这代表可能因此出现其他的失败情景或者需要进一步处理），因此我选择了一种折衷方案：获得临时文件夹的路径作为具名互斥锁的部分名字。

基础代码非常简单：

C++

// use user's temp folder name as part of mutex name
// extra name
auto constexpr extra{ L"PlayerWinMutex\0"sv };
// name buffer
auto name{ std::to_array<wchar_t, MAX_PATH + 2 + extra.size() + 1>({}) };
// get tmp folder, not guaranteed path availablity
auto length{ GetTempPathW(static_cast<DWORD>(name.size()), &name[0]) };
// add extra to path
std::memcpy(&name[length], extra.data(), extra.size() + 1);
// mutex name can't contain '\'
std::replace(&name[0], &name[length], '\\', '/');
// check mutex is held by another instance, NO NEED TO USE GetLastError
if (!::CreateMutexExW(nullptr, &name[0], CREATE_MUTEX_INITIAL_OWNER, NULL)) {
    // do something else,
    // such as print log, notify user or synchroniz with other instance
    ::ExitProcess(1u);
}

注意，由于互斥锁是独占的，因此 CreateMutexExW 一定会因为无法创建同名互斥锁而返回0，不需要使用 GetLastError 进行额外的判断。

对于GUI程序，新实例可以选择将旧实例唤醒并置于顶层，我采用如下设计：将上面的互斥代码放置于程序创建窗口之前，并且在发现已经存在实例的分支中加入如下代码：

C++

// enumerate all direct child windows of desktop
for (auto pre{ ::FindWindowExW(nullptr, nullptr, nullptr, nullptr) };
    // return null if at the end
    pre != nullptr;
    // pass the pre as the 2nd argument to get next handle
    pre = ::FindWindowExW(nullptr, pre, nullptr, nullptr))
{
    // check if window has the specified property
    // set in MainWindow constructor
    if (::GetPropW(pre, L"PlayerWinRT")) {
        // show and restore window
        ::ShowWindow(pre, SW_RESTORE);
        // activate, set foreground and get forcus
        ::SetForegroundWindow(pre);
        // exit app, DO NOT USE this->EXIT BECAUSE NOT CONSTRUCTED
        ::ExitProcess(1u);
    }
}

在创建窗口时添加如下代码：

C++

HWND handle; // current window's handle

::SetPropW(handle, L"PlayerWinRT", handle);

原理是通过给窗口设置一个辨识应用的属性名（字符串），注意微软的文档有误，SetPropW 的第三个参数（属性值的HANDLE）为必填，如果该值为0会导致 GetPropW 返回0（等同于属性不存在），这里使用当前窗口的句柄作为属性的值，并无实际意义。

对于WinUI 3应用，微软提供了一种“简单”的方法可以阻止多实例：App Lifecycle。