umi-plugin-electron-builder 项目教程

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

umi-plugin-electron-builder/
├── src/
│   ├── main/
│   │   └── main.ts
│   ├── renderer/
│   │   ├── pages/
│   │   ├── app.tsx
│   │   └── index.tsx
├── package.json
├── umirc.js
└── README.md

• src/main/main.ts: Electron 主进程文件，负责启动和管理 Electron 窗口。
• src/renderer/pages/: React 组件和页面文件，用于构建应用的用户界面。
• src/renderer/app.tsx: 渲染进程的入口文件，初始化 React 应用。
• src/renderer/index.tsx: 渲染进程的根组件。
• package.json: 项目依赖和脚本配置文件。
• umirc.js: Umi 配置文件，用于配置插件和路由等。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

主进程启动文件

src/main/main.ts 是 Electron 的主进程启动文件，主要负责创建和管理应用窗口。以下是一个简单的示例：

import { app, BrowserWindow } from 'electron';
import path from 'path';

let mainWindow: BrowserWindow | null = null;

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

  mainWindow.loadURL('http://localhost:8000');

  mainWindow.on('closed', () => {
    mainWindow = null;
  });
}

app.on('ready', createWindow);

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

app.on('activate', () => {
  if (mainWindow === null) {
    createWindow();
  }
});

渲染进程启动文件

src/renderer/app.tsx 是 React 应用的入口文件，负责初始化 React 应用。以下是一个简单的示例：

import React from 'react';
import ReactDOM from 'react-dom';
import { ConfigProvider } from 'antd';
import zhCN from 'antd/lib/locale/zh_CN';
import App from './App';

ReactDOM.render(
  <ConfigProvider locale={zhCN}>
    <App />
  </ConfigProvider>,
  document.getElementById('root')
);

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。以下是一个示例：

{
  "name": "umi-plugin-electron-builder",
  "version": "1.0.0",
  "main": "dist/main/main.js",
  "scripts": {
    "start": "umi dev",
    "build": "umi build",
    "electron:dev": "umi dev electron",
    "electron:build": "umi build electron"
  },
  "dependencies": {
    "umi": "^3.0.0",
    "electron": "^12.0.0"
  },
  "devDependencies": {
    "umi-plugin-electron-builder": "^1.0.0"
  }
}

umirc.js

umirc.js 文件是 Umi 的配置文件，用于配置插件、路由和其他 Umi 相关设置。以下是一个示例：

export default {
  plugins: [
    ['umi-plugin-electron-builder', {
      mainFile: 'src/main/main.ts',
    }],
  ],
  routes: [
    { path: '/', component: 'index' },
  ],
};

通过以上配置，你可以轻松地使用 umi-plugin-electron-builder 插件来构建和打包 Electron 应用。