两种方式的mac/win注册协议唤起Electron应用

方式一：使用app.setAsDefaultProtocolClient(protocol[, path, args])

需要打开应用一次，协议才能写入电脑中。才能实现点击链接去唤起。

"electron": "^4.1.4"

逻辑分析

1. 在应用主进程启动后， 需要对当前主机进行注册/写入协议
2. 监听用户打开携带应用协议的URL，并获取其中的参数
3. 使用其中的参数来根据个人需求来进行不同使用

完整代码

protocol.js

// 唤起协议
const path = require('path')
const { app, ipcMain } = require('electron')

const PROTOCOL = 'your-protocol-name' // 协议名
const OPENVIEW = 'open-view' // 与渲染进程通讯事件名
let awakeUrlInfo = { // 唤起应用的url信息
  urlStr: '',
  urlSearch: '',
}

// 对当前主机进行注册/写入协议
app.setAsDefaultProtocolClient(PROTOCOL)

// 如果唤起的时候，没有其他实例，则以当前实例作为主实例，处理唤起url中的参数
handleArgv(process.argv)

// 当第二个实例被执行时，这个事件将在你的应用程序的首个实例中触发
app.on('second-instance', (event, argv) => {
  if (process.platform === 'win32') {
    handleArgv(argv)
  }
})

// 当用户想要在应用中打开一个 URL 时发出（仅用于macOS）
app.on('open-url', (event, urlStr) => {
  handleUrl(urlStr)
})

// 主进程通讯监听渲染进程派发的OPENVIEW事件
ipcMain.on(OPENVIEW, (event)=> {
    // 并发送当前唤起应用的数据
  event.sender.send(OPENVIEW, awakeUrlInfo)
})

// 对当前启动参数进行判断处理（app.isPackaged用来区分开发阶段及包阶段）
function handleArgv(argv) {
  const offset = app.isPackaged ? 1 : 2
  const url = argv.find((arg, i) => i >= offset && arg.startsWith(PROTOCOL))
  if (url) handleUrl(url)
}

// 对当前启动url进行解析处理
function handleUrl(awakeUrlStr) {
  const {search} = new URL(awakeUrlStr)
  awakeUrlInfo = {
    urlStr: awakeUrlStr,
    urlSearch: search && search.slice(1)
  }
}

注意！！

经过测试，在极少部分的win机中则会存在注册表写入不完整，则导致根本无法进行唤起的情况（注册表中缺少URL Protocol此条信息）

解决方法：使用方式二

参考资料

app.setAsDefaultProtocolClient()

通过协议唤起Electron应用

Electron安全考古

方式二：通过electron-builder

只要下载了应用，协议就会自动写入到电脑中。点击链接即可直接唤起。

"electron-builder": "^20.38.5"

逻辑分析

1. 安装应用时将协议注册/写入进主机中
2. 监听用户打开携带应用协议的URL，并获取其中的参数
3. 使用其中的参数来根据个人需求来进行不同使用

完整代码

package.json

"build": {
    "win": {
      "target": [
        "nsis" // 打包成一个独立的 exe 安装程序
      ],
      "signingHashAlgorithms": [
        "sha1",
        "sha256"
      ],
    },
    "nsis": {
      "oneClick": false, // 是否一键安装
      "perMachine": true, // 安装的时候是否为所有用户安装
      "allowToChangeInstallationDirectory": true, // 是否允许用户改变安装目录， 默认为false
      "deleteAppDataOnUninstall": true, // 是否在卸载时删除应用程序数据
      // 指定要包含 nsis 的脚本，基于内置的nsis脚本进一步扩展
      // for win - 将协议写入主机的脚本
      "include": "script/urlProtoco.nsh" 
    },
    "protocols": [ // for macOS - 用于在主机注册指定协议
      {
        "name": "your-protocol-name",
        "schemes": [
          "your-protocol-name"
        ]
      }
    ]
  },

for win - 将协议写入主机的脚本

urlProtoco.nsh

!macro customInstall
  DetailPrint "Register your-protocol-name URI Handler"
  DeleteRegKey HKCR "your-protocol-name"
  WriteRegStr HKCR "your-protocol-name" "" "URL:your-protocol-name"
  WriteRegStr HKCR "your-protocol-name" "URL Protocol" ""
  WriteRegStr HKCR "your-protocol-name\shell" "" ""
  WriteRegStr HKCR "your-protocol-name\shell\Open" "" ""
  WriteRegStr HKCR "your-protocol-name\shell\Open\command" "" "$INSTDIR\${APP_EXECUTABLE_FILENAME} %1"
!macroend

• !macro 定义宏
• customInstall 会在文件安装后自动调用
• DetailPrint 执行打印
• DeleteRegKey 删除原有的注册表
• WriteRegStr 写入注册表
• $INSTDIR 所选的文件安装路径

参考资料

Protocol (scheme) for windows

Electron-Builder nsis

附加

Windows查看注册表

1. 首先win + r打开运行的对话框
2. 然后输入regedit
3. 在界面中寻找编辑， 然后点击查找
4. 输入你需要找寻的表的字段