我们相信:世界是美好的,你是我也是。平行空间的世界里面,不同版本的生活也在继续...

在您高高兴兴的构建了一个electronexe后,是不是发现可以多次点开?可以同时存在多个实例?那么本文就是讲述如何在electron开发中,避免打开多个实例的。

苏南大叔:如何保证electron只启动一个实例?单实例教程 - electron-single-instance
如何保证electron只启动一个实例?单实例教程(图5-1)

本文的主体代码来自 http://electron.org.cn/doc/api/app.html,苏南大叔稍稍进行了修改,以适应于 quick-start 这个demo,主要用到了appSingleInstance方法,执行的是win环境下的exe

mac环境下,本文略有不同。如果没有本文的代码,正常情况下来说,mac下面也会是一个实例。但是在命令行下面多次启动的话,会是多个实例。

190121更新:本篇文章适合于目前electron所有版本,但是在electron3.x以后有个新的函数叫做:requestSingleInstanceLock,也可以实现类似目的。

代码展示

下面的代码来自于main.js

const electron = require('electron')
const app = electron.app
const BrowserWindow = electron.BrowserWindow

//...

let mainWindow

function createWindow(){
  mainWindow = new BrowserWindow({width: 800, height: 600})
  mainWindow.loadURL("http://electron.org.cn/")
  mainWindow.on('closed', function () {
    mainWindow = null
  })
}

// 关键代码在这里
const shouldQuit = app.makeSingleInstance((commandLine, workingDirectory) => {
  if (mainWindow) {
    if (mainWindow.isMinimized()) mainWindow.restore()
    mainWindow.focus()
  }
})
if (shouldQuit) {
  app.quit()
}
// 关键代码在这里

app.on('ready', createWindow)
//...

makeSingleInstance函数是整个功能需求的核心。大家仔细看看这里即可。代码很好理解,苏南大叔就不详细解释了。

苏南大叔:如何保证electron只启动一个实例?单实例教程 - main
如何保证electron只启动一个实例?单实例教程(图5-2)

截图展示

下面展示一下相关的效果截图,大家可以对比看看。

使用makeSingleInstance之前的效果截图:

苏南大叔:如何保证electron只启动一个实例?单实例教程 - multi
如何保证electron只启动一个实例?单实例教程(图5-3)

使用makeSingleInstance之后的效果截图:

苏南大叔:如何保证electron只启动一个实例?单实例教程 - result
如何保证electron只启动一个实例?单实例教程(图5-4)

苏南大叔:如何保证electron只启动一个实例?单实例教程 - exe
如何保证electron只启动一个实例?单实例教程(图5-5)

需要说明的是:

  • 本段截图都是多次点击启动之后的截图。
  • 本文中的exe都是经过electron-packager ./打包后的结果。
  • exe在makeSingleInstance的作用下,即使是命令行模式electron ./,也是只开启一个实例的。
  • mac下,即使不加这段makeSingleInstance,也是默认只开启一个实例的。而在命令行下,是可以多次启动同一个dmg的。加上这段makeSingleInstance后,命令行下面,也只能启动一个。

结语

electron启动单实例的基本目的,通过函数makeSingleInstance()达到了。更多electron的相关资讯,请点击苏南大叔的文章:

如果本文对您有帮助,或者节约了您的时间,欢迎打赏瓶饮料,建立下友谊关系。
本博客不欢迎:各种镜像采集行为。请尊重原创文章内容,转载请保留作者链接。

 【福利】 腾讯云最新爆款活动!1核2G云服务器首年50元!

 【源码】本文代码片段及相关软件,请点此获取更多信息

 【绝密】秘籍文章入口,仅传授于有缘之人   electron