Electron Boilerplate 项目教程

1. 项目的目录结构及介绍

Electron Boilerplate 项目的目录结构如下：

electron-boilerplate/
├── .github/
│   └── workflows/
├── build/
│   └── static/
├── config/
├── index.css
├── index.html
├── index.js
├── jsconfig.json
├── license
├── menu.js
├── package.json
├── readme.md
└── ...

目录结构介绍

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• build/static/: 用于存放静态资源文件。
• config/: 配置文件目录。
• index.css: 主样式文件。
• index.html: 主 HTML 文件。
• index.js: 主 JavaScript 文件。
• jsconfig.json: JavaScript 配置文件。
• license: 项目许可证文件。
• menu.js: 菜单配置文件。
• package.json: 项目的依赖和脚本配置文件。
• readme.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件是 index.js。这个文件是 Electron 应用的入口点，负责初始化应用窗口和加载主页面。

// index.js
const {app, BrowserWindow} = require('electron');
const path = require('path');

function createWindow () {
  const mainWindow = new BrowserWindow({
    width: 800,
    height: 600,
    webPreferences: {
      preload: path.join(__dirname, 'preload.js')
    }
  });

  mainWindow.loadFile('index.html');
}

app.whenReady().then(() => {
  createWindow();

  app.on('activate', function () {
    if (BrowserWindow.getAllWindows().length === 0) createWindow();
  });
});

app.on('window-all-closed', function () {
  if (process.platform !== 'darwin') app.quit();
});

启动文件介绍

• app: Electron 的 app 模块，负责控制应用的生命周期。
• BrowserWindow: 用于创建和管理应用窗口。
• createWindow(): 创建主窗口并加载 index.html 文件。
• app.whenReady(): 在应用准备好后调用 createWindow() 函数。
• app.on('activate'): 在 macOS 上，当应用被激活时，如果没有其他窗口打开，则创建新窗口。
• app.on('window-all-closed'): 当所有窗口关闭时，退出应用（macOS 除外）。

3. 项目的配置文件介绍

项目的配置文件主要包括 package.json 和 jsconfig.json。

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。

{
  "name": "electron-boilerplate",
  "version": "1.0.0",
  "description": "Boilerplate to kickstart creating an app with Electron",
  "main": "index.js",
  "scripts": {
    "start": "electron .",
    "build": "electron-builder"
  },
  "dependencies": {
    "electron": "^12.0.0"
  },
  "devDependencies": {
    "electron-builder": "^22.10.5"
  }
}

jsconfig.json

jsconfig.json 文件用于配置 JavaScript 项目的编译选项。

{
  "compilerOptions": {
    "target": "es6",
    "module": "commonjs",
    "allowSyntheticDefaultImports": true
  },
  "exclude": [
    "node_modules",
    "dist"
  ]
}

配置文件介绍

• package.json:
  • name: 项目名称。
  • version: 项目版本。
  • description: 项目描述。
  • main: 主入口文件。
  • scripts: 包含启动和构建项目的脚本。
  • dependencies: 项目运行时的依赖。