准备如下
1.一个客户端Web项目
2.一台安装好Node.js的window10
3.一把好用的梯子（如果没有需要手动下载一些打包工具）
项目结构如下
这只是一个纯H5项目，images存放图片资源，src存放业务源码资源，index.html页面入口，main.js主控制JS，package.json安装依赖
首先通过node安装electron依赖
安装electron(v6.0.1),electron-packager(v22.4.1)和electron-builder(v22.4.1)，指令如下 npm install electron-packager --save-dev -g npm install electron-builder --save-dev -g
Package.json：配置文件（重要）
{
"name": "xxArt",
"version": "1.0.1",
"description": "appDes",
"main": "main.js",
"private": true,
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"pack": "electron-builder --dir",
"dist": "electron-builder",
"dev": "electron main.js",
"mac": "electron-builder --macos"
},
"keywords": [
"ricequant",
"MAC"
],
"author": "packageAuthor",
"license": "copyright for dwart company",
"bugs": {
"url": "https://github.com/lithium2013/ricequant-mac-address/issues"
},
"homepage": "https://github.com/lithium2013/ricequant-mac-address#readme",
"dependencies": {
"koa": "^2.3.0",
"macaddress": "^0.2.8"
},
"devDependencies": {
"electron": "^6.0.1",
"electron-builder": "^22.4.1"
},
"build": {
"appId": "com.xxx",
"productName": "AppName",
"copyright": "dwart",
"mac": {
"category": "your.app.category.type",
"target": ["dmg","zip"],
"icon":"images/icon.ico"
},
"dmg": {
"title": "AppNameMAC",
"icon":"images/icon.ico",
"contents": [
{
"x": 110,
"y": 150
},
{
"x": 240,
"y": 150,
"type": "link",
"path": "/Applications"
}
],
"window": {
"x": 400,
"y": 400
}
},
"win": {
"icon": "images/icon.ico",
"target":["nsis","zip"],
"icon":"images/icon.ico",
"legalTrademarks":"http://xxx.com/"
},
"nsis": {
"oneClick": false,
"guid": "com.xx",
"perMachine": true,
"allowElevation": true,
"allowToChangeInstallationDirectory": true,
"installerIcon": "./images/icon.ico",
"uninstallerIcon": "./images/icon.ico",
"installerHeaderIcon": "./images/icon.ico",
"createDesktopShortcut": true,
"createStartMenuShortcut": true,
"shortcutName": "AppName"
}
}
}
electron-builder很多依赖包都无法下载到本地，需要我们离线下载到本地，如果是window平台构建，将下载下来得包解压放里面极客
（C:\Users\xxx\AppData\Local\electron-builder\Cache）放这下面
相关详细配置说明
1. 基础配置
"build": { // 这里是electron-builder的配置
"productName":"xxxx",//项目名 这也是生成的exe文件的前缀名
"appId": "com.xxx.xxxxx",//包名
"copyright":"xxxx",//版权 信息
"directories": { // 输出文件夹
"output": "build"
},
// windows相关的配置
"win": {
"icon": "xxx/icon.ico"//图标路径
}
}
2. 打包目标配置 要打包成安装程序的话我们有两种方式
1）使用NSIS工具对我们的文件夹再进行一次打包，打包成exe
2）通过electron-builder的nsis直接打包成exe，配置如下
"win": { // 更改build下选项
"icon": "build/icons/aims.ico",
"target": [
{
"target": "nsis" // 我们要的目标安装包
}
]
}
3）其他平台配置
"dmg": { // macOSdmg
"contents": [
...
]
},
"mac": { // mac
"icon": "build/icons/icon.icns"
},
"linux": { // linux
"icon": "build/icons"
}
4）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脚本 这个对于构建需求严格得安装过程相当有用。
}
关于include 和 script 到底选择哪一个 ？
在对个性化安装过程需求并不复杂，只是需要修改一下安装位置，卸载提示等等的简单操作建议使用include配置,如果你需要炫酷的安装过程，建议使用script进行完全自定义
5）关于操作系统的配置
主要是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"
]
}
]}
6）更新配置
下面这个是给更新用的配置，主要是为了生成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"
}
}
常见错误
NPM下载的问题
因为NPM在国内比较慢。导致electron-V.xxxx.zip下载失败。这些东西如果是第一次打包的话是需要下载对应electron版本的支持文件。解决办法有两个
- 设置镜像：在C盘User中找到.npmrc文件。然后加入下面这句代码,但是这个有时候也不是很好用
ELECTRON_MIRROR=http://npm.taobao.org/mirrors/electron/
- 直接去淘宝镜像文件库找到对应的文件并下载，放到指定的目录下，electron的淘宝镜像地址(https://npm.taobao.org/mirrors/electron/)。下载完之后放到指定的文件。一般文件得地址在C:\Users\Administrator\AppData\Local\electron\Cache。例如我要下载1.8.4版本的electron，那么找到镜像下得文件然后放到指定文件夹中。
(如果是在执行npm install时下载不下来)直接在淘宝镜像下载对应版本的zip，然后扔到C:\Users\YourUserName\.electron就行
NSIS下载问题
如果你要打NSIS得包还需要西再下载nsis-resources-xxx等等包。经过上面得经验这下我们知道缺什么就填什么呗，通过错误日志我们可以得到我们要下载得版本，一般错误中通常会展示github下载地址，直接点开连接去下载。但是位置这次不一样了。因为这是electron-builder的支持环境所以我们要放在C:\Users\xxx\AppData\Local\electron-builder\cache\nsis\下了。
关于上述过程使用到的打包插件可以关注公众号回复“electron”即可获取文件下载