Electron Forge 项目教程

1. 项目目录结构及介绍

Electron Forge 是一个用于构建和发布 Electron 应用程序的工具集。以下是 Electron Forge 项目的典型目录结构及其介绍：

electron-forge-project/
├── .electron-forge/
│   ├── cache/
│   └── config/
├── node_modules/
├── src/
│   ├── main.js
│   ├── renderer.js
│   └── index.html
├── package.json
├── forge.config.js
└── README.md

目录结构说明：

• .electron-forge/: 这是 Electron Forge 的内部目录，包含缓存和配置文件。

  • cache/: 缓存文件，用于加速构建过程。
  • config/: 配置文件，包含 Electron Forge 的内部配置。

• node_modules/: 项目依赖的 Node.js 模块。

• src/: 源代码目录，包含应用程序的主要代码。

  • main.js: Electron 的主进程文件。
  • renderer.js: Electron 的渲染进程文件。
  • index.html: 应用程序的主 HTML 文件。

• package.json: 项目的元数据和依赖管理文件。

• forge.config.js: Electron Forge 的配置文件。

• README.md: 项目的说明文档。

2. 项目的启动文件介绍

在 Electron Forge 项目中，启动文件主要包括 main.js 和 renderer.js。

main.js

main.js 是 Electron 应用程序的主进程文件。它负责创建和管理应用程序的窗口、处理系统事件等。以下是一个简单的 main.js 示例：

const { app, BrowserWindow } = require('electron');

function createWindow() {
  const mainWindow = new BrowserWindow({
    width: 800,
    height: 600,
    webPreferences: {
      nodeIntegration: true,
    },
  });

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

app.whenReady().then(createWindow);

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

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

renderer.js

renderer.js 是 Electron 应用程序的渲染进程文件。它负责处理用户界面和与主进程的通信。以下是一个简单的 renderer.js 示例：

document.getElementById('app').innerText = 'Hello, Electron!';

3. 项目的配置文件介绍

Electron Forge 的配置文件是 forge.config.js。它用于配置 Electron Forge 的各种选项，如构建、发布等。

forge.config.js

以下是一个简单的 forge.config.js 示例：

module.exports = {
  packagerConfig: {
    name: 'MyApp',
    icon: 'src/icon',
  },
  makers: [
    {
      name: '@electron-forge/maker-squirrel',
      config: {
        name: 'my_app',
      },
    },
    {
      name: '@electron-forge/maker-zip',
      platforms: ['darwin'],
    },
    {
      name: '@electron-forge/maker-deb',
      config: {},
    },
    {
      name: '@electron-forge/maker-rpm',
      config: {},
    },
  ],
};

配置文件说明：

• packagerConfig: 配置应用程序打包的选项，如应用程序名称、图标等。
• makers: 配置构建目标平台和打包工具，如 maker-squirrel 用于 Windows 平台，maker-zip 用于 macOS 平台等。

通过以上配置，Electron Forge 可以根据不同的平台生成相应的安装包。