electron-builder打包,NSIS的一些使用总结

本文首发于公众号【一个老码农】

NSIS Windows 系统下专门用来制作安装程序的,可以让我们自定义一些 .exe 文件安装过程中的一些操作。市面上的桌面开发技术基本都可以使用NSIS,如 qt mfc electron

NSIS配置项

electron 中用 electron-builder 打包时,我们可以对 package.json 文件中的 nsis 对象进行配置,以达到我们对安装程序一定程度上的设置。如:

oneClick:值为布尔类型,true时代表一键安装,false代表一步步安装
perMachine:值为布尔类型,代表是否显示辅助安装程序的安装模式安装程序页面(选择按机器还是按用户)。true时代表始终按用户安装。
allowToChangeInstallationDirectory:值为布尔类型,是否允许用户修改安装目录,true为允许,false为不允许
displayLanguageSelector:布尔类型,是否允许选择语言(默认为系统语言),true为允许,false为不允许
language:字符串类型,默认语言
guid:字符串类型,为应用软件指定guid,此guid会存放在注册表中,如果没有指定则系统会自动生成
createDesktopShortcut:布尔类型或"always",是否创建桌面快捷方式,true时表示创建,false表示不创建,"always"代表重新安装时也创建
include:字符串类型,NSIS包含定制安装程序脚本的路径

上面只列举一部分字段进行说明,有需要可参考下面网站:
https://www.electron.build/generated/nsisoptions

NSIS脚本

以上nsis的配置项很强大,但是它并不能满足我们所有的需求,这个时候就需要我们自己写NSIS脚本,并设置NSIS配置项的include字段,如下:

"include": "./build/installer.nsh"

下面我讲一下我工作中用NSIS脚本实现的一个功能:向自定义的安装路径后面追加文件夹

用户在点击exe文件安装时,一般情况下是可以自由修改安装目录的,如果用户随意选择一个目录,可能就会导致安装后的文件比较乱,不利于查找和维护。如:用户选择了D盘根路径,或者选择了桌面为安装目录,那么安装后的文件,就会全部放在根路径下或者桌面。

这个问题就可以通过NSIS脚本的方式来解决,当用户通过浏览按钮修改安装路径后,我们会检测其路径的最后一个文件夹是否为myApp,如果不是则在后面追加一个文件夹myApp。
如用户选择的是D盘根路径 D:\ ,那么追加后的路径就为D:\myApp\

具体做法分为两部,如下:

1.创建一个NSIS脚本文件installer.nsh,并设置package.json中的nsis配置。

"nsis": {
    "oneClick": false,
    "perMachine": true,
    "allowToChangeInstallationDirectory": true,
    "include": "installer.nsh"

2.在installer.nsh文件中编写脚本,脚本代码如下:

!define DIR_NAME "myApp"
Function .onVerifyInstDir
  StrLen $0 "\${DIR_NAME}"
  StrCpy $1 "$INSTDIR" "" -$0
  StrCmp $1 "\${DIR_NAME}" +2 0
  StrCpy $INSTDIR "$INSTDIR\${DIR_NAME}"
FunctionEnd

我们一句一句对以上代码来进行解释

!define DIR_NAME "myApp"代表定义一个DIR_NAME的宏常量,即我们将要追加的文件夹名称。

Function .onVerifyInstDir
其中Function代表一个方法,.onVerifyInstDir是NSIS为我们提供的一个回调方法,用户通过浏览修改安装目录后就会调用。

StrLen $0 "\${DIR_NAME}"表示计算\myApp的字符串长度,并赋值给$0。

StrCpy $1 "$INSTDIR" "" -$0
表示把用户修改后的安装路径,从后往前截取0的长度。并赋值给1。
其中$INSTDIR为用户修改后的安装路径。

StrCmp $1 "\${DIR_NAME}" +2 0
表示比对$1变量与是否等于\myApp,如果相等,则继续往下执行,否则往后跳两行执行

StrCpy $INSTDIR "$INSTDIR\${DIR_NAME}"
表示在用户修改后的路径后再拼接一个\myApp,即拼接一个myApp文件夹。