|
| 1 | +import { app, BrowserWindow } from 'electron' |
| 2 | + |
| 3 | +/** |
| 4 | + * 确保 Electron 应用只运行一个实例的工具函数 |
| 5 | + * @typedef {Object} SingleInstanceOptions |
| 6 | + * @property {Function} [onSecondInstance] - 当第二个实例启动时的回调函数 |
| 7 | + * @property {boolean} [enableSandbox=false] - 是否启用沙箱模式 |
| 8 | + * @property {Function} [onSuccess] - 成功获取单例锁后的回调函数 |
| 9 | + * @property {Function} [onShowWindow] - 主窗口已展示回调 |
| 10 | + * @property {boolean} [forceFocus=true] - 是否强制聚焦已存在的窗口 |
| 11 | + * @property {boolean} [silentMode=false] - 静默模式,不显示任何提示 |
| 12 | + * @property {Function} [onError] - 错误处理回调函数 |
| 13 | + */ |
| 14 | + |
| 15 | +/** |
| 16 | + * 第二个实例启动时的回调函数类型 |
| 17 | + * @callback OnSecondInstanceCallback |
| 18 | + * @param {Event} event - Electron 事件对象 |
| 19 | + * @param {string[]} commandLine - 命令行参数数组 |
| 20 | + * @param {string} workingDirectory - 工作目录 |
| 21 | + * @param {BrowserWindow|null} mainWindow - 主窗口实例,如果存在的话 |
| 22 | + */ |
| 23 | + |
| 24 | +/** |
| 25 | + * 确保应用程序只运行单个实例 |
| 26 | + * @param {SingleInstanceOptions} options - 配置选项 |
| 27 | + * @returns {boolean} 是否成功获取单例锁 |
| 28 | + * |
| 29 | + * @example |
| 30 | + * // 基础使用 |
| 31 | + * ensureSingleInstance({ |
| 32 | + * onSuccess: () => { |
| 33 | + * app.whenReady().then(createWindow) |
| 34 | + * } |
| 35 | + * }); |
| 36 | + * |
| 37 | + * @example |
| 38 | + * // 高级使用 |
| 39 | + * ensureSingleInstance({ |
| 40 | + * onSecondInstance: (event, commandLine, workingDirectory, mainWindow) => { |
| 41 | + * if (mainWindow) { |
| 42 | + * mainWindow.webContents.send('new-instance-launched', commandLine); |
| 43 | + * } |
| 44 | + * }, |
| 45 | + * onSuccess: () => { |
| 46 | + * console.log('Successfully acquired lock'); |
| 47 | + * createWindow(); |
| 48 | + * }, |
| 49 | + * onError: (error) => { |
| 50 | + * console.error('Error in single instance check:', error); |
| 51 | + * }, |
| 52 | + * forceFocus: true, |
| 53 | + * silentMode: false |
| 54 | + * }); |
| 55 | + * |
| 56 | + * @throws {Error} 如果在非 Electron 环境中调用 |
| 57 | + */ |
| 58 | +function ensureSingleInstance(options = {}) { |
| 59 | + // 参数解构与默认值设置 |
| 60 | + const { |
| 61 | + onSecondInstance, |
| 62 | + enableSandbox = false, |
| 63 | + onSuccess, |
| 64 | + onShowWindow, |
| 65 | + onError, |
| 66 | + forceFocus = true, |
| 67 | + silentMode = false, |
| 68 | + } = options |
| 69 | + |
| 70 | + // 验证运行环境 |
| 71 | + if (!app || !BrowserWindow) { |
| 72 | + const error = new Error('ensureSingleInstance must be called in Electron environment') |
| 73 | + if (onError) { |
| 74 | + onError(error) |
| 75 | + return false |
| 76 | + } |
| 77 | + throw error |
| 78 | + } |
| 79 | + |
| 80 | + try { |
| 81 | + // 沙箱模式检查 |
| 82 | + if (enableSandbox) { |
| 83 | + !silentMode && console.log('Sandbox mode enabled, skipping single instance check') |
| 84 | + onSuccess?.() |
| 85 | + return true |
| 86 | + } |
| 87 | + |
| 88 | + // 请求单例锁 |
| 89 | + const gotTheLock = app.requestSingleInstanceLock() |
| 90 | + |
| 91 | + // 如果无法获取锁,说明已有实例在运行 |
| 92 | + if (!gotTheLock) { |
| 93 | + !silentMode && console.log('Application instance already running, quitting...') |
| 94 | + app.quit() |
| 95 | + return false |
| 96 | + } |
| 97 | + |
| 98 | + // 监听第二个实例的启动 |
| 99 | + app.on('second-instance', (event, commandLine, workingDirectory) => { |
| 100 | + try { |
| 101 | + // 获取所有窗口 |
| 102 | + const windows = BrowserWindow.getAllWindows() |
| 103 | + const mainWindow = windows.length ? windows[0] : null |
| 104 | + |
| 105 | + // 处理窗口焦点 |
| 106 | + onShowWindow?.(mainWindow, commandLine) |
| 107 | + |
| 108 | + if (mainWindow) { |
| 109 | + if (mainWindow.isMinimized() || !mainWindow.isVisible()) { |
| 110 | + mainWindow.show() |
| 111 | + } |
| 112 | + if (forceFocus) { |
| 113 | + mainWindow.focus() |
| 114 | + } |
| 115 | + } |
| 116 | + |
| 117 | + // 调用用户自定义的回调 |
| 118 | + onSecondInstance?.(event, commandLine, workingDirectory, mainWindow) |
| 119 | + } |
| 120 | + catch (error) { |
| 121 | + !silentMode && console.error('Error handling second instance:', error) |
| 122 | + onError?.(error) |
| 123 | + } |
| 124 | + }) |
| 125 | + |
| 126 | + // 调用成功回调 |
| 127 | + onSuccess?.() |
| 128 | + return true |
| 129 | + } |
| 130 | + catch (error) { |
| 131 | + !silentMode && console.error('Error in ensureSingleInstance:', error) |
| 132 | + onError?.(error) |
| 133 | + return false |
| 134 | + } |
| 135 | +} |
| 136 | + |
| 137 | +/** |
| 138 | + * 检查当前是否为应用程序的主实例 |
| 139 | + * @returns {boolean} 如果是主实例返回 true,否则返回 false |
| 140 | + */ |
| 141 | +function isMainInstance() { |
| 142 | + return app.requestSingleInstanceLock() |
| 143 | +} |
| 144 | + |
| 145 | +/** |
| 146 | + * 释放单例锁,允许其他实例启动 |
| 147 | + * @returns {void} |
| 148 | + */ |
| 149 | +function releaseSingleInstanceLock() { |
| 150 | + app.releaseSingleInstanceLock() |
| 151 | +} |
| 152 | + |
| 153 | +export { |
| 154 | + ensureSingleInstance, |
| 155 | + isMainInstance, |
| 156 | + releaseSingleInstanceLock, |
| 157 | +} |
0 commit comments