umi-plugin-electron-builder

本插件提供基于umijs的electron的开发及打包，无需修改项目结构，支持混合项目结构和main+renderer项目结构，仅支持 umijs4

混合项目结构示例 点此访问

main+renderer项目结构示例 点此访问

使用混合项目结构时，插件可自动生成项目文件，使用main+renderer项目结构时，请参考示例修改目录结构

更新日志

umi3请使用2.x版本插件，点此访问

安装

``shell
$ yarn add umi-plugin-electron-builder --dev
`

umi4需要手动启用插件

`typescript
import { defineConfig } from "umi";

export default defineConfig({
npmClient: "yarn",
plugins: ["umi-plugin-electron-builder"],
});
`

配置完成之后，执行

`shell
$ yarn postinstall
`

执行以下指令，生成主进程文件 src/main/index.ts

`shell
$ yarn electron:init
`

默认安装最新版本的 electron

自动在 package.json 增加以下配置，使用@umijs/max时，请将以下命令中的umi修改为max

`json5
{
scripts: {
'rebuild-deps': 'electron-builder install-app-deps',
'electron:init': 'umi electron init',
'electron:dev': 'umi dev electron',
'electron:build:win': 'umi build electron --win',
'electron:build:mac': 'umi build electron --mac',
'electron:build:linux': 'umi build electron --linux',
},
//这里需要修改成你自己的应用名称
name: 'electron_builder_app',
version: '0.0.1',
}
`

$3

你可以手动将 package.json 中的 electron 修改至低版本，插件与 electron 版本无关

$3

`
$ yarn electron:dev
`

$3

`json5
{
"version": "0.2.0",
"configurations": [
{
"type": "node-terminal",
"request": "launch",
"name": "debug electron:dev",
"command": "yarn electron:dev",
"skipFiles": [
"/**"
],
"sourceMapPathOverrides": {
"webpack://main/./": "${workspaceFolder}/src/main/"
},
"resolveSourceMapLocations": [
"${workspaceFolder}/src/.umi/electron/**",
"${workspaceFolder}/src/renderer/.umi/electron/**"
],
"autoAttachChildProcesses": true
}
]
}
`

$3

打包路径不能有中文，electron-builder不能跨平台打包，请在对应系统上打包

`
//windows
$ umi build electron --win
//mac
$ umi build electron --mac
//linux
$ umi build electron --linux
//按平台打包
$ umi build electron --win --ia32 //32位
$ umi build electron --win --x64 //64位
$ umi build electron --win --armv7l //arm32位
$ umi build electron --win --arm64 //arm64位
`

$3

例：使用 serialport 插件

`
$ yarn add serialport @types/serialport
`

$3

`typescript
import Config from '@umijs/bundler-webpack/compiled/webpack-5-chain';
import { defineConfig } from 'umi';
import { InlineConfig } from 'vite';

export default defineConfig({
electronBuilder: {
//可选参数
buildType: 'vite', //webpack或vite，当编译出现问题，可尝试切换为webpack
//并行构建，默认关闭，如开启出现问题，请关闭此功能
parallelBuild: false, //并行构建，开启时主进程和渲染进程同时编译
mainSrc: 'src/main', //默认主进程目录
preloadSrc: 'src/preload', //默认preload目录，可选，不需要可删除
routerMode: 'hash', //路由 hash或memory,仅electron下有效，推荐使用hash
outputDir: 'dist_electron', //默认打包目录
externals: ['serialport'], //node原生模块配置，打包之后找不到包也需要配置在这里
rendererTarget: 'web', //构建目标electron-renderer或web，使用上下文隔离时，必须设置为web
debugPort: 5858, //主进程调试端口
//2.1.0新增
preloadEntry: {
//默认值 key为preload文件名 值为preload输出文件名
//输出文件名不能为main.js会和主进程文件名冲突
//文件名为preload目录下多文件名
//多级目录时key为xxxx/xxxx.ts
//使用时输出文件会和主进程在同一目录下 preload: path.join(__dirname, 'preload.js')
'index.ts': 'preload.js',
},
viteConfig(config: InlineConfig, type: "main" | "preload") {
//主进程Vite配置
//配置参考 https://vitejs.dev/config/
//ConfigType分为main和preload可分别配置
},
//通过 webpack-chain 的 API 修改 webpack 配置。
mainWebpackChain(config: Config, type: "main" | "preload") {
//ConfigType分为main和preload可分别配置
// if (type === 'main') {}
// if (type === 'preload') {}
},
//2.1.10新增 开启自定义主进程日志时
logProcess(log: string, type: "normal" | "error") {
if (type === 'normal') {
console.log(log);
} else if (type === 'error') {
console.error(log);
}
},
builderOptions: {
//配置参考 https://www.electron.build/configuration/configuration
appId: 'com.test.test',
productName: '测试',
publish: [
{
provider: 'generic',
url: 'http://localhost/test',
},
],
}, //electronBuilder参数
},
routes: [{ path: '/', component: '@/pages/index' }],
});
``

在 Electron10 以上使用contextIsolation时 rendererTarget 需要设置成
web

builderOptions参考 Electron Builder

$3

esbuild 暂不支持 typescript decorator metadata

Vite 与 typeorm 冲突，typeorm 在主进程无法使用

相关 Issue https://github.com/evanw/esbuild/issues/257