electron-builder打包见解
Electron-builder打包详解
开发electron客户端程序,打包是绕不开的问题。下面就我在工作中的经验以及目前对electron-builder
的了解来分享一些心得。
基本概念
官网的定义
A complete solution to package and build a ready for distribution Electron app for macOS, Windows and Linux with “auto update” support out of the box.
关于electron
和electron-builder
的基础部分这篇文章就跳过了,有兴趣的话可以看这篇文章
如何使用
builder的使用和配置都是很简单的
builder配置有两种方式
package.json
中直接配置使用(比较常用,我们下面着重来讲这个)- 指定
electron-builder.yml
文件
demo地址会在文章末尾给出(demo项目中electron
使用得是V2.0.7
版本,目前更高得是2.0.8
版本)。
下面是一个简单的package.js
中带注释的配置
- 基础配置
"build": { // 这里是electron-builder的配置"productName":"xxxx",//项目名 这也是生成的exe文件的前缀名"appId": "com.xxx.xxxxx",//包名 "copyright":"xxxx",//版权 信息"directories": { // 输出文件夹"output": "build"}, // windows相关的配置"win": { "icon": "xxx/icon.ico"//图标路径 } }
在配置文件中加入以上的文件之后就可以打包出来简单的<font clolor="red">文件夹</font>,文件夹肯定不是我们想要的东西。下一步我们来继续讲别的配置。
- 打包目标配置
要打包成安装程序的话我们有两种方式,
- 使用NSIS工具对我们的文件夹再进行一次打包,打包成exe
- 通过electron-builder的nsis直接打包成exe,配置如下
"win": { // 更改build下选项"icon": "build/icons/aims.ico","target": [{"target": "nsis" // 我们要的目标安装包}]},
- 其他平台配置
"dmg": { // macOSdmg"contents": [...]},"mac": { // mac"icon": "build/icons/icon.icns"},"linux": { // linux"icon": "build/icons"}
- nsis配置
这个要详细的讲一下,这个nsis的配置指的是安装过程的配置,其实还是很重要的,如果不配置nsis那么应用程序就会自动的安装在C盘。没有用户选择的余地,这样肯定是不行的
关于nsis的配置是在build中nsis这个选项中进行配置,下面是部分nsis配置
"nsis": {"oneClick": false, // 是否一键安装"allowElevation": true, // 允许请求提升。 如果为false,则用户必须使用提升的权限重新启动安装程序。"allowToChangeInstallationDirectory": true, // 允许修改安装目录"installerIcon": "./build/icons/aaa.ico",// 安装图标"uninstallerIcon": "./build/icons/bbb.ico",//卸载图标"installerHeaderIcon": "./build/icons/aaa.ico", // 安装时头部图标"createDesktopShortcut": true, // 创建桌面图标"createStartMenuShortcut": true,// 创建开始菜单图标"shortcutName": "xxxx", // 图标名称"include": "build/script/installer.nsh", // 包含的自定义nsis脚本 这个对于构建需求严格得安装过程相当有用。"script" : "build/script/installer.nsh" // NSIS脚本的路径,用于自定义安装程序。 默认为build / installer.nsi
},
关于include
和 script
到底选择哪一个 ?
在对个性化安装过程需求并不复杂,只是需要修改一下安装位置,卸载提示等等的简单操作建议使用include
配置,如果你需要炫酷的安装过程,建议使用script
进行完全自定义。
NSIS
对于处理安装包这种东西,功能非常的强大。但是学习起来并不比一门高级语言要容易。其中的奥秘还要各位大佬自行探索
这里上一些学习资源
- NSIS初级篇
- NSIS 打包脚本基础
- 示例脚本
- NSIS论坛
- 关于操作系统的配置
主要是windows中64和32位的配置
CLI参数
electron-builder --ia32 // 32位
electron-builder // 64位(默认)
nsis中配置
"win": {"icon": "build/icons/aims.ico","target": [{"target": "nsis","arch": [ // 这个意思是打出来32 bit + 64 bit的包,但是要注意:这样打包出来的安装包体积比较大,所以建议直接打32的安装包。"x64", "ia32"]}]
}
- 更新配置
下面这个是给更新用的配置,主要是为了生成lastest.yaml
配置文件
"publish": [{"provider": "generic", // 服务器提供商 也可以是GitHub等等"url": "http://xxxxx/" // 服务器地址}
],
完整配置
基本上可用的完整的配置
"build": {"productName":"xxxx",//项目名 这也是生成的exe文件的前缀名"appId": "com.leon.xxxxx",//包名 "copyright":"xxxx",//版权 信息"directories": { // 输出文件夹"output": "build"}, "nsis": {"oneClick": false, // 是否一键安装"allowElevation": true, // 允许请求提升。 如果为false,则用户必须使用提升的权限重新启动安装程序。"allowToChangeInstallationDirectory": true, // 允许修改安装目录"installerIcon": "./build/icons/aaa.ico",// 安装图标"uninstallerIcon": "./build/icons/bbb.ico",//卸载图标"installerHeaderIcon": "./build/icons/aaa.ico", // 安装时头部图标"createDesktopShortcut": true, // 创建桌面图标"createStartMenuShortcut": true,// 创建开始菜单图标"shortcutName": "xxxx", // 图标名称"include": "build/script/installer.nsh", // 包含的自定义nsis脚本},"publish": [{"provider": "generic", // 服务器提供商 也可以是GitHub等等"url": "http://xxxxx/" // 服务器地址}],"files": ["dist/electron/**/*"],"dmg": {"contents": [{"x": 410,"y": 150,"type": "link","path": "/Applications"},{"x": 130,"y": 150,"type": "file"}]},"mac": {"icon": "build/icons/icon.icns"},"win": {"icon": "build/icons/aims.ico","target": [{"target": "nsis","arch": ["ia32"]}]},"linux": {"icon": "build/icons"}}
命令行参数(CLI)
Commands(命令):
electron-builder build 构建命名 [default]electron-builder install-app-deps 下载app依赖electron-builder node-gyp-rebuild 重建自己的本机代码electron-builder create-self-signed-cert 为Windows应用程序创建自签名代码签名证书electron-builder start 使用electronic-webpack在开发模式下运行应用程序(须臾要electron-webpack模块支持)
Building(构建参数):
--mac, -m, -o, --macos Build for macOS, [array]--linux, -l Build for Linux [array]--win, -w, --windows Build for Windows [array]--x64 Build for x64 (64位安装包) [boolean]--ia32 Build for ia32(32位安装包) [boolean]--armv7l Build for armv7l [boolean]--arm64 Build for arm64 [boolean]--dir Build unpacked dir. Useful to test. [boolean]--prepackaged, --pd 预打包应用程序的路径(以可分发的格式打包)--projectDir, --project 项目目录的路径。 默认为当前工作目录。--config, -c 配置文件路径。 默认为`electron-builder.yml`(或`js`,或`js5`)
Publishing(发布):
--publish, -p 发布到GitHub Releases [choices: "onTag", "onTagOrDraft", "always", "never", undefined]
<font color="red">Deprecated(废弃):</font>
--draft 请改为在GitHub发布选项中设置releaseType [boolean]--prerelease 请改为在GitHub发布选项中设置releaseType [boolean]--platform 目标平台 (请更改为选项 --mac, --win or --linux)[choices: "mac", "win", "linux", "darwin", "win32", "all", undefined]--arch 目标arch (请更改为选项 --x64 or --ia32)[choices: "ia32", "x64", "armv7l", "arm64", "all", undefined]
Other(其他):
--help Show help [boolean]--version Show version number [boolean]
Examples(例子):
electron-builder -mwl 为macOS,Windows和Linux构建(同时构建)electron-builder --linux deb tar.xz 为Linux构建deb和tar.xzelectron-builder -c.extraMetadata.foo=bar 将package.js属性`foo`设置为`bar`electron-builder --config.nsis.unicode=false 为NSIS配置unicode选项
TargetConfiguration(构建目标配置):
target: String - 目标名称,例如snap.
arch “x64” | “ia32” | “armv7l” | “arm64”> | “x64” | “ia32” | “armv7l” | “arm64” -arch支持列表
常见的错误
NPM
下载的问题因为
NPM
在国内比较慢。导致electron-V.xxxx.zip
下载失败。这些东西如果是第一次打包的话是需要下载对应electron
版本的支持文件。解决办法有两个- 设置镜像:在C盘User中找到
.npmrc
文件。然后加入下面这句代码,但是这个有时候也不是很好用
ELECTRON_MIRROR=http://npm.taobao.org/mirrors/electron/
- 直接去淘宝镜像文件库找到对应的文件并下载,放到指定的目录下,electron的淘宝镜像地址。下载完之后放到指定的文件。一般文件得地址在
C:\Users\Administrator\AppData\Local\electron\Cache
。例如我要下载1.8.4版本的electron
,那么找到镜像下得文件然后放到指定文件夹中。
- 设置镜像:在C盘User中找到
这就解决了这个问题,简单又暴力。
NSIS
下载问题如果你要打
NSIS
得包还需要西再下载nsis-resources-xxx
等等包。经过上面得经验这下我们知道缺什么就填什么呗,通过错误日志我们可以得到我们要下载得版本,一般错误中通常会展示github
下载地址,直接点开连接去下载。但是位置这次不一样了。因为这是electron-builder
的支持环境所以我们要放在C:\Users\Administrator\AppData\Local\electron-builder\cache\nsis\
下了。
一般情况下解决这些问题的思路就是,缺什么拿什么?。
总结
electron-builder是一个简单又强大的库。反正我是很服
Demo地址
原文地址 如果觉得有用得话给个⭐吧
electron-builder打包见解相关推荐
- electron builder 打包错误 cannot unpack electron zip file 解决方案
electron builder 打包错误 cannot unpack electron zip file 解决方案 参考文章: (1)electron builder 打包错误 cannot unp ...
- electron builder 打包错误相关问题
electron项目在打包成exe文件时,第一次打包成功,第二次打包就报错了,报错如下: 然后按照提示去下载(https://github.com/electron-userland/electron ...
- 【electron】 打包应用修改图标和进程名字
文章目录 导读 开发环境 打包流程 制作一个大于等于256*256的icon 修改package.json 执行 *npm run build* 生成应用 效果图 踩坑 icon必现大于等于 256* ...
- electron项目打包报错
electron项目打包报错 打包下载错误 Error: getaddrinfo ENOENT github-production-release-asset-2e65be.s3.amazonaws. ...
- electron项目打包成dmg
1.通过脚手架搭建的项目 官方文档有很详细的教程: electron-forge https://github.com/electron-userland/electron-forge 我采用的如下命 ...
- electron + vue /打包linux应用报错记录
1. electron + vue 打包linux应用报错记录 > icon图标导致的报错 ⨯ unknown output format set github.com/develar/app ...
- Electron加密打包文件
1.安装 electron-packager 注意:先复制一份package.json文件到./app目录下,(千万记住这一点,我在这步这折腾了好几个小时才弄明白)然后记得改下package.json ...
- Electron MAC 打包签名生成
配置.bash_profile(环境变量) 在命令行中输入: export PATH=/usr/bin:/usr/sbin:/bin:/sbin:/usr/X11R6/bin (这样可以保证命令行命令 ...
- Electron Vue 打包错误: InvalidConfigurationError: ‘build‘ in the application package.json
Electron Vue electron-builder 打包错误: InvalidConfigurationError: 'build' in the application package.js ...
最新文章
- Vue底层实现原理概述
- Yum编译安装Error Downloading Packages报错
- oracle Hash Join及三种连接方式
- 【ASP.NET】 【防止连续多次点击提交按钮 导致页面重复提交】
- 1、虚拟机内存管理、运行时数据区、线程共享区、Java堆、新生代、老年代、Eden区域分配、方法区、线程独占区、虚拟机栈
- Ubuntu Linux 永山(mount)分
- cmake 学习笔记(一)
- 【英语学习】【Daily English】U11 Work L01 Would you like a tour of the office?
- 图像处理算法工程师——1必备技能总结——2面试题大全
- Java集合干货——HashMap源码分析
- 计算方法实验(二):龙贝格积分法
- RK3288开发板——Debian8系统制作
- Unity引擎与Cocos引擎的区别
- win10触摸板升级教程
- 用手机访问计算机共享资源,怎么进入共享文件夹?手机访问电脑局域网共享文件夹的方法...
- OpenCV4 Viz模块使用学习(一)
- 百度Sugar BI 数据可视化里的标签页组件如何实现
- 运放脉冲宽度放大_创鑫激光纳秒级脉冲激光器应用于精细焊接
- 转载一个特征提取的方法——AE
- pytorch distiller filter channel剪枝