在vue-cli-plugin-electron-builder下用electron:build打包或生成应用程序的两种方法

接上一篇文章使用vue-cli-plugin-electron-builder开发vue-cli3.0+Electron桌面开发应用

建议先看文章最后的几个坑,以免入坑不能爬坑

vue-cli-plugin-electron-builder打包构建用的是electron-builder,electron-builder的官网
我们已经安装过vue-cli-plugin-electron-builder就不用再去安装一遍electron-builder了,我也没有试过重新安装一遍好不好用,感兴趣的自行测试

第一步,到官网看文档

image.png

好巧,我们用的就是vue CLI3,点进去看看,然后get Start,点击左侧菜单Configuring

image.png
TIP

All CLI arguments passed to electron:build will be forwarded to electron-builder.
这句话的意思就是:这些参数都是通过electron:build命令来提交给electron-builder的。
再通俗的讲:我们用electron:build来打包的参数配置格式如图所示。即:

// vue.config.js

module.exports = {
  pluginOptions: {
    electronBuilder: {
      builderOptions: {
        // options placed here will be merged with default configuration and passed to electron-builder
      }
    }
  }
}

但是,我们在我们的项目中没有发现vue.config.js这个文件,这是由于vue-cli3.0是号称0配置的,所以我们自己在根目录下创建一个vue.config.js文件即可。注意!根目录!!!!


第二步,写配置参数

我们本质上用的还是electron-builder来进行打包的,所以参数肯定是在electron-builder的官网上
回到electron-builder官网,并点击菜单 Configuration


image.png

根据官网的文档,我们可以写出配置如下:

module.exports = {
    pluginOptions: {
        electronBuilder: {
            builderOptions: {
                "appId": "com.example.app",
                "productName":"aDemo",//项目名,也是生成的安装文件名,即aDemo.exe
                "copyright":"Copyright © 2019",//版权信息
                "directories":{
                    "output":"./dist"//输出文件路径
                },
                "win":{//win相关配置
                    "icon":"./shanqis.ico",//图标,当前图标在根目录下,注意这里有两个坑
                    "target": [
                        {
                            "target": "nsis",//利用nsis制作安装程序
                            "arch": [
                                "x64",//64位
                                "ia32"//32位
                            ]
                        }
                    ]
                }
                }
            }

    }
}

构建一下试试:
npm run electron:build

D:\Electron\demo>npm run electron:build

> demo@0.1.0 electron:build D:\Electron\demo
> vue-cli-service electron:build

 INFO  Bundling render process:

\  Building modern bundle for production...

 DONE  Compiled successfully in 5022ms                                                                                                                                                                                           4:45:31 PM


  File                                      Size             Gzipped

  dist_electron\bundled\js\chunk-vendors    65.14 KiB        23.43 KiB
  .2026470a.js
  dist_electron\bundled\js\app.4aea6141.    4.53 KiB         1.61 KiB
  js
  dist_electron\bundled\css\app.e2713bb0    0.33 KiB         0.23 KiB
  .css

  Images and other types of assets omitted.

 DONE  Build complete. The dist_electron\bundled directory is ready to be deployed.
 INFO  Check out deployment instructions at https://cli.vuejs.org/guide/deployment.html

|  Bundling main process...

 DONE  Compiled successfully in 5152ms                                                                                                                                                                                           4:45:36 PM


  File                                   Size              Gzipped

  dist_electron\bundled\background.js    160.44 KiB        49.67 KiB

  Images and other types of assets omitted.

 INFO  Building app with electron-builder:
  • electron-builder version=20.44.4
  • description is missed in the package.json appPackageFile=D:\Electron\demo\dist_electron\bundled\package.json
  • author is missed in the package.json appPackageFile=D:\Electron\demo\dist_electron\bundled\package.json
  • writing effective config file=dist\builder-effective-config.yaml
  • no native production dependencies
  • packaging       platform=win32 arch=x64 electron=5.0.0 appOutDir=dist\win-unpacked
  • no native production dependencies
  • packaging       platform=win32 arch=ia32 electron=5.0.0 appOutDir=dist\win-ia32-unpacked
  • building        target=nsis file=dist\aDemo Setup 0.1.0.exe archs=x64, ia32 oneClick=true perMachine=false
  • building block map blockMapFile=dist\aDemo Setup 0.1.0.exe.blockmap
 DONE  Build complete!

成功!


image.png
LINUX、MAC的道理一样,我基本用不到这两个系统,所以不做研究,感兴趣的可以自己看文档。
现在我们win系统32位和64位的生成出来了,那么如果将其制作成对应的安装程序呢?
有两种方法,第一种就是跟上面一样,写配置。第二种,就是运用NSIS工具。

第三步:制作成安装程序

第一种方法:配置参数的方法
module.exports = {
    pluginOptions: {
        electronBuilder: {
            builderOptions: {
                "appId": "com.example.app",
                "productName":"aDemo",//项目名,也是生成的安装文件名,即aDemo.exe
                "copyright":"Copyright © 2019",//版权信息
                "directories":{
                    "output":"./dist"//输出文件路径
                },
                "win":{//win相关配置
                    "icon":"./shanqis.ico",//图标,当前图标在根目录下,注意这里有两个坑
                    "target": [
                        {
                            "target": "nsis",//利用nsis制作安装程序
                            "arch": [
                                "x64"//64位
                            ]
                        }
                    ]
                },
                "nsis": {
                    "oneClick": false, // 是否一键安装
                    "allowElevation": true, // 允许请求提升。 如果为false,则用户必须使用提升的权限重新启动安装程序。
                    "allowToChangeInstallationDirectory": true, // 允许修改安装目录
                    "installerIcon": "./shanqis.ico",// 安装图标
                    "uninstallerIcon": "./shanqis.ico",//卸载图标
                    "installerHeaderIcon": "./shanqis.ico", // 安装时头部图标
                    "createDesktopShortcut": true, // 创建桌面图标
                    "createStartMenuShortcut": true,// 创建开始菜单图标
                    "shortcutName": "demo", // 图标名称
                },
                }
            }

    }
}

注意我只生成了64位,安装试一试:

image.png
image.png

image.png

image.png
正常!
如果要求更高的话,还可以自定义很多东西。还是看文档!
这篇文章写得挺详细,可以参考,网址
注意一点,他的配置文件和我们的不一样,我们是在vue.config.js中,并且没有build!
第二种方法:利用nsis软件

我们没有配置nsis时,同时构建了32位和64位

module.exports = {
    pluginOptions: {
        electronBuilder: {
            builderOptions: {
                "appId": "com.example.app",
                "productName":"aDemo",//项目名,也是生成的安装文件名,即aDemo.exe
                "copyright":"Copyright © 2019",//版权信息
                "directories":{
                    "output":"./dist"//输出文件路径
                },
                "win":{//win相关配置
                    "icon":"./shanqis.ico",//图标,当前图标在根目录下,注意这里有两个坑
                    "target": [
                        {
                            "target": "nsis",//利用nsis制作安装程序
                            "arch": [
                                "x64",//64位
                                "ia32"//32位
                            ]
                        }
                    ]
                }                
                }
            }

    }
}
image.png
准备工作:

下载nsis软件:Nullsoft Install System
链接:https://pan.baidu.com/s/1oLRrnclChU09xcosUa_hTw
提取码:o6iu
解压,安装

安装后,会有两个快捷方式


image.png
1、打开上面一个
image.png
2、点击HW VNISEdit
image.png
3、选择文件》新建脚本:向导
image.png
4、点击下一步,进入应用程序信息,填写对应的信息,下一步
image.png
5、图标需是icon,语言中文,安装程序文件根据实际情况设置,别改后缀
image.png
6、闪屏和背景设置,没必要修改,下一步
image.png
7、默认允许用户更改安装目录;授权文件若有就写,如果没有就清空!清空!清空!否则后面编译会出问题
image.png
8、把默认的两个文件删除掉,然后点击添加
image.png
image.png
9、添加源文件(注意我选择的是64位的,如果是32位的到win-ia32-unpacked文件中找),选好后点击确定,先不要下一步
image.png
10、添加文件树
image.png
11、选择源文件对应的文件夹
image.png
12、勾选包含子目录,确定,下一步
image.png
13、修改开始菜单
image.png
14、设置安装成功后启动的程序,默认就是我们打包后的启动程序,不用改,下一步
image.png
15、设置卸载程序,下一步
image.png
16、勾选保存脚本和转换文件路径到相对路径,点击完成
image.png
17、保存一个位置
image.png
18、保存后通常会自行打开脚本,如果没有打开,请自行到刚才保存的位置打开,打开后界面如下
image.png
19、编译并运行
image.png
20、如果刚才没有清空许可协议,会报错。解决:删除报错的这一行,重新编译并运行
image.png
21、正在编译,需要一段时间
image.png
22、编译成功会自动弹出安装页面
image.png
23、安装后并运行,发现正常
image.png
24、安装程序应该跟保存的编译文件同一个目录
image.png
25、开始菜单
image.png
26、第三方管理软件可以查看,出品公司
image.png

附上碰到的坑:

坑1:vue.config.js中配置参数不能有空格

"appId ": "com.example.app",有空格会报错,不能识别的参数
"appId": "com.example.app",正确无空格的

报错部分样式,如下:

Error: Configuration is invalid.
 - configuration has an unknown property 'appId '. These properties are valid:
   object { $schema?, afterAllArtifactBuild?, afterPack?, afterSign?, apk?, appId?, appImage?, appx?, artifactBuildCompleted?, artifactBuildStarted?, artifactName?, asar?, asarUnpack?, beforeBuild?, buildDependenciesFromSource?, buildV
ersion?, compression?, copyright?, cscKeyPassword?, cscLink?, deb?, detectUpdateChannel?, directories?, dmg?, electronCompile?, electronDist?, electronDownload?, electronUpdaterCompatibility?, electronVersion?, extends?, extraFiles?, e
xtraMetadata?, extraResources?, fileAssociations?, files?, forceCodeSigning?, framework?, freebsd?, generateUpdatesFilesForAllChannels?, icon?, includePdb?, launchUiVersion?, linux?, mac?, mas?, msi?, muonVersion?, nodeGypRebuild?, nod
eVersion?, npmArgs?, npmRebuild?, npmSkipBuildFromSource?, nsis?, nsisWeb?, onNodeModuleFile?, p5p?, pacman?, pkg?, portable?, productName?, protocols?, protonNodeVersion?, publish?, readonly?, releaseInfo?, remoteBuild?, removePackage
Scripts?, rpm?, snap?, squirrelWindows?, target?, win? }

坑2:配置图标时,图标的大小最小为256*256

"icon":"./shanqis.ico"就是这个图标
报错是XXX at least 256*256

坑3:不要直接把.jpg或其他格式改后缀为.ico?解决:http://ico.duduxuexi.com/到这个网址或其他方式自己转换,记住是256*256的

 ERROR  Error: Exit code: 1. Command failed: C:\Users\Administrator\AppData\Local\electron-builder\Cache\winCodeSign\winCodeSign-2.4.0\rcedit-ia32.exe D:\dist\win-unpacked\aDemo.exe --set-version-string FileDescription aDemo --set-vers
ion-string ProductName aDemo --set-version-string LegalCopyright Copyright © 2019 --set-file-version 0.1.0 --set-product-version 0.1.0.0 --set-version-string InternalName aDemo --set-version-string OriginalFilename  --set-icon D:\Elect
ron\demo\shanqis.ico
Reserved header is not 0 or image type is not icon for 'D'
Fatal error: Unable to set icon

坑4:连接超时403错误,由于我们要安装ia32,所以就要下载对应的electron,解决办法看我之前的一篇文章https://www.jianshu.com/p/ced7f0c2bd40(注意,下载下来后直接放到对应的文件夹下就可以了,不用npm安装了)

报错样式:

D:\Electron\demo>npm run electron:build

> demo@0.1.0 electron:build D:\Electron\demo
> vue-cli-service electron:build

 INFO  Bundling render process:

|  Building modern bundle for production...

 DONE  Compiled successfully in 5375ms                                                                                                                                                                                           3:32:53 PM


  File                                      Size             Gzipped

  dist_electron\bundled\js\chunk-vendors    65.14 KiB        23.43 KiB
  .2026470a.js
  dist_electron\bundled\js\app.4aea6141.    4.53 KiB         1.61 KiB
  js
  dist_electron\bundled\css\app.e2713bb0    0.33 KiB         0.23 KiB
  .css

  Images and other types of assets omitted.

 DONE  Build complete. The dist_electron\bundled directory is ready to be deployed.
 INFO  Check out deployment instructions at https://cli.vuejs.org/guide/deployment.html

|  Bundling main process...

 DONE  Compiled successfully in 5578ms                                                                                                                                                                                           3:32:59 PM


  File                                   Size              Gzipped

  dist_electron\bundled\background.js    160.44 KiB        49.67 KiB

  Images and other types of assets omitted.

 INFO  Building app with electron-builder:
  • electron-builder version=20.44.4
  • description is missed in the package.json appPackageFile=D:\Electron\demo\dist_electron\bundled\package.json
  • author is missed in the package.json appPackageFile=D:\Electron\demo\dist_electron\bundled\package.json
  • writing effective config file=D:\dist\builder-effective-config.yaml
  • no native production dependencies
  • packaging       platform=win32 arch=x64 electron=5.0.0 appOutDir=D:\dist\win-unpacked
  • no native production dependencies
  • packaging       platform=win32 arch=ia32 electron=5.0.0 appOutDir=D:\dist\win-ia32-unpacked
?[34m  • ?[0mdownloading     ?[34mparts?[0m=8 ?[34msize?[0m=61 MB ?[34murl?[0m=https://github.com/electron/electron/releases/download/v5.0.0/electron-v5.0.0-win32-ia32.zip
?[34m  • ?[0mretrying (1)
?[34m  • ?[0mretrying (2)
?[34m  • ?[0mretrying (3)
?[31m  ⨯ ?[0mpart download request failed with status code 403


结束语:

好多坑需要爬,多看文档,多揣摩

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,324评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,303评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,192评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,555评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,569评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,566评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,927评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,583评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,827评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,365评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,941评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2 342