app
app 模块是为了控制整个应用的生命周期设计的,可以通过app.on方法可监听Electron的整个生命周期中的事件,比如初始化,窗口退出等等。
一、事件列表
1.1、ready事件
当 Electron 完成初始化时被触发,往往监听此事件来执行加载窗口的初始化。
app.on('ready', function createWindow() {
mainWindow = new BrowserWindow({width: 800, height: 600});
mainWindow.loadURL(url.format({
pathname: path.join(__dirname, 'index.html'),
protocol: 'file',
slashes: true
}))
mainWindow.webContents.openDevTools()
mainWindow.on('closed', function() {
mainWindow = null;
})
})
1.2、window-all-closed事件
当所有的窗口都被关闭时触发。
如果没有监听此事件,当所有窗口都已关闭时,默认行为是退出应用程序。但如果你监听此事件, 将由你来控制应用程序是否退出,但是需要注意的是,此时before-quit、will-quit、quit事件,将失效。
如果用户按下了 Cmd + Q,或者开发者调用了 app.quit() , Electron 将会先尝试关闭所有的窗口再触发 will-quit 事件,在这种情况下 window-all-closed 不会被触发。
app.on('window-all-closed',function(){
// 在 macOS 上,除非用户用 Cmd + Q 确定地退出,
// 否则绝大部分应用及其菜单栏会保持激活。
if(process.platform!=='darwin'){
app.quit()
}
})
1.3、before-quit事件
在应用程序开始关闭它的窗口的时候被触发。 调用 event.preventDefault() 将会阻止终止应用程序的默认行为。
1.4、will-quit事件
当所有的窗口已经被关闭,应用即将退出时被触发。 调用 event.preventDefault() 将会阻止终止应用程序的默认行为。
1.5、quit事件
当应用程序正在退出时触发。
针对window-all-closed、before-quit、will-quit、quit四种监听应用退出的方法,可能有的人会有不理解的地方,我们可以做一个小测试,首先我们同时监听这四个事件。
app.on('window-all-closed',function(){
//窗口全部关闭事件
console.log('window-all-closed start')
})
app.on('before-quit',function(){
//在应用程序开始关闭它的窗口的时候被触发
console.log('before-quit start')
})
app.on('will-quit',function(){
//应用程序的窗口已经关闭,应用即将退出
console.log('will-quit start')
})
app.on('quit',function(){
//应用程序正在退出
console.log('quit start')
})
我们这边同时监听了上述的四个事件,然后我们启动程序,关闭窗口,查看打印的结果
从打印的结果,可以看出,当window-all-closed事件被监听之后,其他三个事件都会失效。
然后我们注释掉window-all-closed事件,重新启动程序,关闭窗口。
//app.on('window-all-closed',function(){
// //窗口全部关闭事件
// console.log('window-all-closed start')
//})
app.on('before-quit',function(){
//在应用程序开始关闭它的窗口的时候被触发
console.log('before-quit start')
})
app.on('will-quit',function(){
//应用程序的窗口已经关闭,应用即将退出
console.log('will-quit start')
})
app.on('quit',function(){
//应用程序正在退出
console.log('quit start')
})
查看打印结果
从测试结果来看,四者之间的区别很明显:当监听了window-all-closed之后,其它三种事件监听就会失效。其它三种事件的执行顺序,从他们的语义可以得知:before-quit-->will-quit-->quit
1.6、open-file事件(macOS)
当用户想要在应用中打开一个文件时触发。open-file 事件常常在应用已经打开并且系统想要再次使用应用打开文件时被触发。 open-file 也会在一个文件被拖入 dock 且应用还没有运行的时候被触发。 请确认在应用启动的时候(甚至在 ready 事件被触发前)就对 open-file 事件进行监听,以处理这种情况。
1.7、open-url事件(macOS)
当用户想要在应用中打开一个url的时候被触发。URL格式必须要提前标识才能被你的应用打开。
1.8、activate事件(macOS)
当应用被激活时触发,常用于点击应用的 dock 图标的时候。
1.9、browser-window-blur事件
当一个 BrowserWindow 失去焦点的时候触发。
1.10、browser-window-focus事件
当一个 BrowserWindow 获得焦点的时候触发。
1.11、'browser-window-created事件
当一个 BrowserWindow 被创建的时候触发。
二、方法列表
app.quit()
试图关掉所有的窗口。before-quit 事件将会最先被触发。如果所有的窗口都被成功关闭了, will-quit 事件将会被触发,默认下应用将会被关闭。
app.exit(exitCode)
带着exitCode退出应用,exitCode 默认为0
所有的窗口会被立刻关闭,不会询问用户。before-quit 和 will-quit 这2个事件不会被触发
app.isReady()
返回 Boolean - true 如果Electron 初始化完成, false 其他情况.
app.focus()
在Linux系统中, 使第一个可见窗口获取焦点. macOS, 让该应用成为活动应用程序。 Windows, 使应用的第一个窗口获取焦点.
app.hide() //macOS
隐藏所有的应用窗口,不是最小化.仅针对macOS
app.show() //macOS
隐藏后重新显示所有的窗口,不会自动选中他们。.仅针对macOS
app.getAppPath()
返回当前应用所在的文件路径。
app.getPath(name)
返回一个与 name 参数相关的特殊文件夹或文件路径。当失败时抛出一个 Error 。
你可以通过名称请求以下的路径:
home 用户的 home 文件夹(主目录)
appData 当前用户的应用数据文件夹,默认对应:
%APPDATA% Windows 中
$XDG_CONFIG_HOME or ~/.config Linux 中
~/Library/Application Support macOS 中
userData 储存你应用程序设置文件的文件夹,默认是 appData 文件夹附加应用的名称
temp 临时文件夹
exe 当前的可执行文件
modulelibchromiumcontent 库
desktop 当前用户的桌面文件夹
documents 用户文档目录的路径
downloads 用户下载目录的路径.
music 用户音乐目录的路径.
pictures 用户图片目录的路径.
videos 用户视频目录的路径.