electron 初探
electron 是什么?
electron 的前身是 atomshell,它基于 chromium 和 node.js。这意味着我们可以使用 html,javascript,css 以及 node.js 等技术,快速实现一个跨平台的桌面应用。它有着丰富的 API 可供我们使用。和它类似的项目有 nw.js。
快速开始
electron-quick-start
是 electron 官方提供的种子项目,现在用它来做演示,首先启动这个项目:
# Clone this repository
git clone https://github.com/electron/electron-quick-start
# Go into the repository
cd electron-quick-start
# Install dependencies
npm install
# Run the app
npm start
然后,你可以看到... 我们熟悉的开发者工具!这也是理所当然的,本质上 electron 就是给 chromium 套了个壳子,所以我们才能用前端开发的方式写桌面应用。
electron 简介
electron 分为主进程和渲染进程,我们可以通过主进程创建 web 页面,每个 web 中都运行着一个渲染进程,它们互不干扰。
在 electron 中,主进程的代码写在 package 的 main 字段里面。在 electron-quick-start
项目里主进程是写在 main.js
里面的:
const electron = require('electron')
// Module to control application life.
const app = electron.app
// Module to create native browser window.
const BrowserWindow = electron.BrowserWindow
const path = require('path')
const url = require('url')
// Keep a global reference of the window object, if you don't, the window will
// be closed automatically when the JavaScript object is garbage collected.
let mainWindow
function createWindow () {
// Create the browser window.
mainWindow = new BrowserWindow({width: 800, height: 600})
// and load the index.html of the app.
mainWindow.loadURL(url.format({
pathname: path.join(__dirname, 'index.html'),
protocol: 'file:',
slashes: true
}))
// Open the DevTools.
// mainWindow.webContents.openDevTools()
// Emitted when the window is closed.
mainWindow.on('closed', function () {
// Dereference the window object, usually you would store windows
// in an array if your app supports multi windows, this is the time
// when you should delete the corresponding element.
mainWindow = null
})
}
// This method will be called when Electron has finished
// initialization and is ready to create browser windows.
// Some APIs can only be used after this event occurs.
app.on('ready', createWindow)
// Quit when all windows are closed.
app.on('window-all-closed', function () {
// On OS X it is common for applications and their menu bar
// to stay active until the user quits explicitly with Cmd + Q
if (process.platform !== 'darwin') {
app.quit()
}
})
app.on('activate', function () {
// On OS X it's common to re-create a window in the app when the
// dock icon is clicked and there are no other windows open.
if (mainWindow === null) {
createWindow()
}
})
// In this file you can include the rest of your app's specific main process
// code. You can also put them in separate files and require them here.
通过 BrowserWindow 接口创建一个 web 页面,并且加载 index.html
:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Hello World!</title>
</head>
<body>
<h1>Hello World!</h1>
<!-- All of the Node.js APIs are available in this renderer process. -->
We are using Node.js <script>document.write(process.versions.node)</script>,
Chromium <script>document.write(process.versions.chrome)</script>,
and Electron <script>document.write(process.versions.electron)</script>.
<script>
// You can also require other files to run in this process
require('./renderer.js')
</script>
</body>
</html>
如果你要写的是仅仅是一个存粹的网页的话,那么看到这里,已经可以撸起袖子干了,和在浏览器里面写,并没有太大的差别。
## 一些你可能还需要了解的点
- 有些 electron 的模块只能在主进程中使用,有些只能在渲染进程中使用,有些在两者中都能使用,请注意区分。
- 主进程和渲染进程是不能直接通信的,如果你需要通信,你可以使用
ipcMain
和ipcRenderer
模块,以事件发送监听的方式进行通信。 - 如果要在渲染进程中使用原本只能在主进程中使用的模块,可以通过 remote 模块,就像这样:
创建了一个原生的系统错误对话框。如果要在主进程中操作渲染进程,可以通过 BrowserWindow 的一个属性 -- webContentsconst remote = require('electron').remote; const dialog = remote.dialog; dialog.showErrorBox('演示', '错误对话框')
- 在 electron 中,操作剪切板是很容易的,你可以通过 clipboard 模块,这是主进程和渲染进程共有的。
- 在 electron 中,打开外链你可以通过 shell 模块,
shell.openExternal('https://github.com')
将会调用外部浏览器打开链接。 - 通过 webview 模块,可以在你的应用里直接嵌入网页。
- 你可以直接在网页中使用 node 模块,require(...)
- window.open 会打开一个新的 BrowserWindow 的实例窗口
- globalShortcut 可以注册全局快捷键
- menu 模块可以帮助创建原生的菜单和右键菜单
构建你的应用
可以通过 electron-builder
很方便的打包你的应用,只需少许配置。你还可以通过 travis-ci 等持续集成网站构建全部平台的安装程序。
自动更新
Nuts
使用GitHub作为后端,可以为 mac和windows 提供自动更新的支持,linux 没有内置自动更新器,建议使用包管理器。