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