Electron 爬坑记

Electron

最近想给上次鼓捣出的 搜索 App 加个搜索当前页面文字的功能。

开工前,觉得这应该是个有现成解的问题,很快找到了一个 Electron 组件 electron-in-page-search。看了一遍项目的 READEME,觉得是个认真的项目,文档也算丰富,提供了示例代码,心想应该不用花太多时间便能收工了。

但开始动手后,便很快发现了问题。因为对 Electron 不够熟悉,不知道示例代码该“贴”到哪里!


急切地看了下 Electron 的入门文档,了解到可以利用 BrowserWindow 的 preload 属性,注入一个脚本文件。又看了下之前由 Nativefier 生成的代码,它已经写好了一个 preload.js 实现,其中预留了一个扩展点,../../inject/inject.js,如果这个文件存在,preload.js 就会加载它。

var needToInject = _fs2.default.existsSync(INJECT_JS_PATH);
if (needToInject)
  require(INJECT_JS_PATH);

Nativefier 真是贴心,不要辜负它,在 ../../inject/ 目录下创建出 inject.js,填入 electron-in-page-search 的示例代码

Paste_Image.png
const searchInPage = require("electron-in-page-search").default;
const remote = require("electron").remote;

const searchInWindow = searchInPage(remote.getCurrentWebContents());
searchInWindow.openSearchWindow();

重新打开 App,可以看到页面右上角,出现了预期的搜素框。

示例效果

接下来,为了更符合平时的软件使用习惯,想在 App 的菜单栏中,添加一个菜单项,Find In Page,并绑定一个快捷键,⌘F。页面显示时,不显示搜索框,菜单项被触发时才显示出来。

main.js 中找到定义菜单的地方,仿照其他已存在的菜单项,添加新菜单项的配置

function createMenu(_ref) {
 ...
 var template = [{...
 },{
   label: 'Find In Page',
   accelerator: 'CmdOrCtrl+F',
   click: function click() {
     // showSearchInWindow();
   }
 }, ...];
 var menu = _electron.Menu.buildFromTemplate(template);
 _electron.Menu.setApplicationMenu(menu);
}

运行程序,看下效果

添加菜单

这里预留了一个未实现的 showSearchInWindow 方法 ,作用是显示搜索框。那么问题来了,main.js 中如何执行 searchInWindow.openSearchWindow() 这行代码呢?

这里要补充下前文跳过的 Electron 中主进程渲染进程两个概念。

main.js 运行在主进程中,而 preload 引入的脚本文件,运行在渲染进程中。
另外一方面,一个浏览器实例,可以有多个浏览窗口,但只会有一个菜单栏, 共享给所有浏览窗口。菜单栏定义在主进程,每个浏览窗口都是一个独立的渲染进程,而像搜索框这样的与浏览窗口相关的对象,也需要是产生和运行在对应的渲染进程上,这也是前面将示例代码放在 inject.js 中的原因。

搞明白这些,就能想到,并不能将 searchInWindow 对象定义在主进程上,来让菜单被点击时,调用该对象的方法。可行的方式是,当菜单被点击时,让主进程通知渲染进程,间接地达到目的。

于是我们需要了解,在 Electron 中,主进程如何和渲染进程通信

In Electron, we have several ways to communicate between the main process and renderer processes. Like ipcRenderer
and ipcMain
modules for sending messages, and the remote module for RPC style communication.

这里提到了两种方式,第一种方式提到了 ipcMainipcRendererIPC,有些读者看到这个词应该不陌生,Inter-Process Communication,进程间通信,看名字就觉得,这种方式就够用了。再参考下链接中的示例代码,编写如下实现

main.js

var showSearchInWindow = function () {
 mainWindow.webContents.send('find-in-page');
};

inject.js

ipcRenderer.on('find-in-page', (event, arg) => {
    console.log(' ipcRenderer find-in-page');
    search.openSearchWindow();
});

可以看到,主进程发出了 find-in-page 这个事件,在渲染进程中我们监听着这个事件,当事件发生时,执行相应的操作。


回顾一下,主进程和渲染进程,是 Electron 中最基础的两个概念,并不复杂,但要明确区分。preload 是 Electron 为浏览窗口预置的一个扩展点,执行时机是在页面的其他脚本执行之前。

此次分享,实际上省略了一些爬坑的过程,比如调试,比如 nodeIntegration,后面希望有机会再作些探索,写一些这些方面的内容。

参考资料

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

推荐阅读更多精彩内容