Electron Basic Notes
Getting Started
npm install -g electron-forge
electron-forge init my-new-project --template=react
cd my-new-project
electron-forge start
Basic Concepts
Process
主进程通过实例化 BrowserWindow，每个 BrowserWindow 实例都在它自己的渲染进程内返回一个 web 页面。 当 BrowserWindow 实例销毁时，相应的渲染进程也会终止。
主进程负责掌管所有的 web 页面和它们相应的渲染进程。 每个渲染进程都是相互独立的，它们只关心自己所运行的 web 页面。
在页面（渲染进程）中不允许调用原生 GUI 相关的 API，那是因为在网页（渲染进程）中中掌管原生 GUI 很危险，易造成内存泄露。 如果想在网页中进行 GUI 的操作，渲染进程必须向主进程传达请求，然后在主进程中完成操作。
在 Electron 中，有几种连接主进程和渲染进程的方法， 例如用于传送消息的 ipcRenderer 和 ipcMain 模块，以及用于 RPC 的 remote 模块.
Shared Data
- Web Storage API
- IndexedDB
- Electron IPC
// main process
globalThis.sharedObject = {
someProperty: 'default value',
}
// render process 1
require('remote').getGlobal('sharedObject').someProperty = 'new value'
// render process 2
console.log(require('remote').getGlobal('sharedObject').someProperty)
Process Communication
Main to Render
- webContents.executeJavaScript
- ipcRenderer
- ipcMain
Render to Main
- remote module
const { BrowserWindow } = require('electron').remote
const win = new BrowserWindow({ width: 800, height: 600 })
win.loadURL('https://github.com')
Render to Render
- Web Storage API
- IndexedDB
- Electron IPC e.g remote.getGlobal
Native UI
Menu
Application Menu
Contextual Menu
Dialog
- openFile
- openDirectory
- multiSelections
- createDirectory
- showHiddenFiles
- promptToCreate: windows only.
Electron Security
- only load secure content (HTTPS/WSS/FTPS)
- verify integrity of scripts via CSP and SRI
- don't trust external resources
- disable nodejs in renderers that display remote content
let win
function createBrowserWindow() {
win = new BrowserWindow({
width: 800,
height: 600,
title: 'Electron App',
webPreferences: {
nodeIntegration: false,
preload: path.join(__dirname, 'preload.js'),
},
})
}
// preload.js
const fs = require('node:fs')
globalThis.desktop = {
files: () => fs.readdirSync(__dirname),
}