打包
在package.json
中,dependencies
会被打进 Electron 应用的包里,而devDependencies
则不会,所以必要的依赖需要放到dependencies
中。files
中定义自己需要被打进 Electron 包里的文件。以下是一个完整的 mac electron-builder
的配置文件。
const base = {
appId: 'com.xxxx.xxxx',
productName: 'Electron 打包模版', // 应用名称,安装后的应用就是名称
icon: './media/images/icon.ico',
files: [ // 除了package.json中dependencies外,另外需要打包的文件添加到此处
'main.js',
'bundles',
'updater/win/index.html',
'updater/build/bootstrap.js',
'updater/mac/Updater.js',
'updater/mac/index.html'
],
publish: { // 需要结合 const { autoUpdater } = require('electron-updater'); 使用
provider: 'generic', // 指定服务器类型,generic 通用服务器,也可以是 github 等
url: '' // 线上服务器地址
},
mac: {
target: [ // 需要打包出的类型
"dmg",
"zip",
"pkg",
"mas"
],
icon: 'media/images/icon.icns',
hardenedRuntime: true,
entitlements: 'electron-builder/entitlements.plist', // 申请可以操作系统权利
entitlementsInherit: 'electron-builder/entitlements.plist',
provisioningProfile: 'electron-builder/comalibabaslobs.provisionprofile'
},
pkg: {
isRelocatable: false,
overwriteAction: "upgrade",
},
mas: {
icon: 'media/images/icon.icns',
hardenedRuntime: true,
entitlements: 'electron-builder/entitlements.mas.plist',
entitlementsInherit: 'electron-builder/entitlements.mas.plist',
},
dmg: {
background: 'media/images/dmg-bg.png',
icon: 'media/images/icon.icns',
iconSize: 100,
sign: false,
contents: [ // mac 会有拖动图标安装的过程,这里配置图标的位置、大小、拖动的文件夹
{
x: 112,
y: 165,
},
{
type: 'link',
path: '/Applications',
x: 396,
y: 165,
},
],
},
extraMetadata: { // 打包线上应用,控制变量为 production,此设置会直接在打包的 package.json 中加入 env这个变量,并且把值设置为 production。可以在文件中引用 const pjson = require('./package.json'); 此时 pjson.env 等于 'production'
env: 'production',
}
};
module.exports = base;
签名
MacOS 10.15 之前,应用如果没有进行签名,首次打开的时候就会出现“恶意软件”提示。
1. 加入开发者
加入 Apple Developer Program(需要缴纳年费)
如果是管理员,会看到可以申请 Developer ID Application,如果不是管理员就会像我这种,看到是灰色的。Electron 打包是需要用这个身份生成证书的。
2. 生成签名证书
如果有管理员权限,点击生成新的证书。
Choose File 里面的文件从哪里来?打开 mac 的钥匙串访问 -> 证书助理 -> 从证书颁发机构请求证书,这里生成了 CertificateSigningRequest.certSigningRequest
的文件,这个文件可以被多次用来生成 mac 证书。
填写必要信息,用户邮箱填写你的 app开发者邮箱,常用名称随便取一个,然后选择保存到本地磁盘。
3. 安装签名证书
上次文件后就生成证书了,下载证书安装。如果出现了次证书不受信任的情况,在列表中双击证书,将使用此证书时更改为始终信任。
如果安装的证书不对,会出现 Command failed: codesign ...
4. 证书导出 p12 给其它人使用
在 mac 的钥匙串访问中,找到证书,然后 右键 -> 导出证书,一般导出 .p12
形式,然后输入证书安装的密码。其它人拿着你的证书,告诉他安装密码即可安装。
5. 不要 Developer ID Application 签名证书,不影响 Electron 应用打包
在打包过程中,找不到 Developer ID Application 签名证书的情况下,会跳过处理。但是应用不签名和公证会影响electron-autoupdater 自动更新能下载无法打开,用户首次打开会提示恶意软件,应用无法上架到appStore。
公证
MacOS 10.14.5 之后,应用如果没有进行公证(将安装包上传到 Apple 审查),首次打开的时候就会出现更严重的“恶意软件”提示。没有进行过公证也无法上传到 Apple Store 中提供给其他人下载。
代码公证
const { notarize } = require('electron-notarize');
notarize({
appPath: '', // 应用的路径 xxx.app 结尾的
appBundleId: '', // appid
appleId: '', // 苹果开发者 id
appleIdPassword: '', // 应用专用密码
ascProvider: '' // 证书提供者
})
appPath
打包后应用的路径,.app 或者 .dmg 结尾。appBundleId
跟 Electron-builder 配置的 appId 一致,这个 appId 要妥善命名。不要发布应用以后再修改,不然会导致应用无法自动更新。比较好的命名一般都是com.xxx(公司名).xxx(应用英文名)
- 苹果开发者的账号
appleId
,填写自己的开发者id 就可以,确保自己是属于开发者。应用专用密码appleIdPassword
,登录 appleid.apple.com/account/man…
这个密码生成后只会出现一次,之后再也没办法看到,所有请保存下来。如果忘记了密码,就重新创建一个,为方便管理不用的密码进行删除后重新创建比较合适。
ascProvider
证书的提供者,通过 mac 钥匙串访问查看。你所有使用的签名证书,括号里面的就是证书提供者。- 公证会把程序压缩包上传到 apple 服务器,保证网络通畅。公证成功后,开发者邮箱会收到邮件。
- notarize {}后面是绝对的json结构,不要出现这些是单引号的情况,不然会报错。
appPath
,appBundleId
,appleIdPassword
,ascProvider
命令行工具公证
需要下载 xcode
。
- 一句话命令公证
xcrun altool --notarize-app --primary-bundle-id "com.xxx.xxx" --username "your developer appleid" --password "appleId-password" --asc-provider "ProviderShortname" -t osx --file xxx.dmg
2.ascProvider
证书的提供者命令行查询
xcrun altool --list-providers -u "apple id" -p "appleIdPassword(应用专用密码)”
3. 公证成功后
No errors uploading 'xxxxxxx-xxxx.dmg'.
RequestUUID = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
上架 AppStore 商店
Electron 应用如果要能发到 appStore,需要 electron-builder 构建 mas(Mac应用商店),经过签名公证后上传到 app store connect,上传之前应用需要支持sandbox。
注册AppId
在 electron-builder 配置的 appId,无论写什么我们都是可以打包配置成功的,因为不涉及到发到 appStore。如果需要发到 appStore,就需要到 apple 开发者官网中去申请一个正式的了。