快速开始

Electron 用 HTML + CSS + JavaScript 就能写跨平台桌面应用(Windows / macOS / Linux)。它的本质是:主进程(Node.js)负责窗口和系统能力,渲染进程(Chromium 页面)负责界面,两者通过 IPC 通信。

  • 安装 Node.js LTS(建议 18 / 20 及以上),自带 npm;node -v、npm -v 能输出版本即可。
  • 编辑器推荐 VS Code。
  • 国内下载 Electron 二进制较慢时,先设置镜像:
npm config set registry https://registry.npmmirror.com
npm config set electron_mirror https://npmmirror.com/mirrors/electron/

官方脚手架 Electron Forge 会生成完整工程,自带运行和打包脚本。

# 创建项目(默认模板)
npm init electron-app@latest my-app
 
cd my-app
npm start

想要前端框架 / Vite 热更新模板,加一个 template 参数:

npx create-electron-app@latest my-app --template=vite
npm start

生成的目录大致是这样:

my-app/
├── package.json      # main 指向主进程入口,scripts.start 启动应用
├── forge.config.js   # 打包配置(maker)
└── src/
    ├── main.js       # 主进程:创建窗口、生命周期
    ├── preload.js    # 预加载脚本:桥接安全 API
    └── index.html    # 渲染进程页面(界面)

新建目录后三步:

mkdir my-app && cd my-app
npm init -y
npm install --save-dev electron

1. package.json —— 关键是 main 指向主进程、start 用 electron 启动:

{
  "name": "my-app",
  "version": "1.0.0",
  "main": "main.js",
  "scripts": {
    "start": "electron ."
  },
  "devDependencies": {
    "electron": "^33.0.0"
  }
}

2. main.js —— 主进程入口,只负责开窗口:

const { app, BrowserWindow } = require('electron')
const path = require('node:path')
 
function createWindow () {
  const win = new BrowserWindow({
    width: 1024,
    height: 768,
    webPreferences: {
      preload: path.join(__dirname, 'preload.js'),
      contextIsolation: true,   // 默认值,务必保持 true
      nodeIntegration: false    // 页面里不直接用 Node
    }
  })
  win.loadFile('index.html')
  // 调试时可打开开发者工具
  // win.webContents.openDevTools()
}
 
app.whenReady().then(() => {
  createWindow()
  // macOS:点击 Dock 图标且没有窗口时重新创建
  app.on('activate', () => {
    if (BrowserWindow.getAllWindows().length === 0) createWindow()
  })
})
 
// 除 macOS 外,关闭所有窗口即退出
app.on('window-all-closed', () => {
  if (process.platform !== 'darwin') app.quit()
})

该主题尚不存在

您访问的页面并不存在。如果允许,您可以使用创建该页面按钮来创建它。

  • electron/快速开始.1793721275.txt.gz
  • 最后更改: 2026/11/03 23:54
  • 由 张叶安