[Chrome] DevTools Page与当前页面的Panel通信

1. tab页

Chrome浏览器是由tab页组成的,一个浏览器实例中可以打开多个tab页。

2. DevTools Window

每个tab页,都可以打开自己的开发者工具窗口,称为DevTools Window。

3. DevTools Page

用户可以通过建立DevTools Page的方式,扩展DevTools Window。

{
  "name": "chrome-extension-example",
  "version": "1.0",
  "minimum_chrome_version": "10.0",
  "description": "chrome extension example",
  "devtools_page": "devtools.html",
  "permissions": [
    "http://*/*",
    "https://*/*",
    "tabs"
  ],
  "manifest_version": 2
}

其中,DevTools Page必须是一个html,但它对用户来说是不可见的

DevTools Page它引入的js,具有访问DevTools API的能力,
包括,devtools.panelsdevtools.inspectedWindowdevtools.network

4. DevTools Page的生命周期

每次打开DevTools Window的时候,都会重新创建一个DevTools Page实例,
如果DevTools Window关闭了,DevTools Page实例也将销毁

因此,chrome.devtools.* 这些API,
只有在DevTools Window开启的时候才可以使用。

5. Panel

Panel指的是DevTools Window中的选项卡,
例如,Elements,Console,Network等等。

DevTools Page可以选择是否创建Panel,
每个Panel可以加载自己的html,js和css,且具有和DevTools Page一样的权限

// 创建一个Panel
chrome.devtools.panels.create(

  // title
  'chrome-extension-example',

  // iconPath
  null,

  // pagePath
  'panel.html'
);

6. Panel的生命周期

Panel只有在第一次被激活的时候,才进行实例化,
同一个DevTools Window中的不同Panel切换时,不会重新加载。
当前tab页刷新时,Panel也不会重新加载。

DevTools Window关闭后,Panel将被销毁。

7. 全局事件问题

Panel和DevTools Page之间可以通过建立持久连接进行通信。
例如,在Panel载入的时候,我们可以用以下方法建立一个连接,

const channel = chrome.runtime.connect(null, {
    name: 'channel-name',
});

同时需要在DevTools Page中,监听chrome.runtime.onConnect事件,

chrome.runtime.onConnect.addListener(channel => {
   ...
});

然而,这是有问题的

因为,chrome.runtime.onConnect.addListener将监听所有的连接请求,
除了当前tab页的,还有其他tab页的。

因此,如果多个页面都打开了DevTools Window,且激活了Panel,
chrome.runtime.onConnect事件就会触发多次
而且,由于多个tab页中Panel代码是一样的,因此连接的name也是相同的,
这就很容易产生问题。

例如,如果我们打算在建立连接后,绑定另一个事件,

chrome.runtime.onConnect.addListener(channel => {

   // 注册事件监听器,每一个http请求完成后触发
   chrome.devtools.network.onRequestFinished.addListener((...args) => {
        ...

        // error: 只能向最后一个连接发消息
        channel.postMessage(...);
    });
});

原因分析:
(1)虽然chrome.devtools.network.onRequestFinished只能监听当前tab页的http请求,
但是,由于chrome.runtime.onConnect事件触发了多次,
因此,同一个tab页的chrome.devtools.network.onRequestFinished事件也被绑定了多次监听器。

(2)当chrome.devtools.network.onRequestFinished发生时,
每个事件处理函数,都会从闭包内获取channel变量,
由闭包的特性,我们知道,
它一定是最后一个chrome.runtime.onConnect事件发生时的channel

(3)综合上述两条,我们得知,
当前tab页中每一个http请求结束后,就会向最后一个连接,发送多次消息。

8. 传tabId

chrome.runtime.onConnect全局事件的解决方案是,
让每一个DevTools Page只与当前tab页的Panel建立连接。

首先,Panel在建立连接的时候,要将当前tab页的tabId传给DevTools Page,

const channel = chrome.runtime.connect(null, {
    name: chrome.devtools.inspectedWindow.tabId.toString(),
});

由于chrome.runtime.connect第二个参数的name属性要求必须是一个string,
且无法传递其他参数,所以我们将tabId转为string作为name值传给DevTools Page。

然后,在DevTools Page的chrome.runtime.onConnect事件中增加判断条件,

chrome.runtime.onConnect.addListener(channel => {

    // 如果连接不是来源于当前tab页,就不使用它。
    if (channel.name !== chrome.devtools.inspectedWindow.tabId.toString()) {
      return;
    }
  
    // 作用域中留下了当前tab页的Panel所建立的连接,只有一个
    // 因此,以下事件只绑定了一次
    chrome.devtools.network.onRequestFinished.addListener((...args) => {
        ...

        // 通过当前tab页的连接,向Panel发送消息
        channel.postMessage(...);
    });
  });

所以,当chrome.devtools.network.onRequestFinished事件发生时,
只有一个事件处理函数,而且channel变量,也是当前tab页的Panel传过来的。

因此,channel.postMessage(...);就可以向当前tab页的Panel发送消息了。


后记

以上内容是在做一个Chrome DevTools扩展的时候总结的,
该扩展的目的是要劫持当前页面发生的所有http请求,然后发送给指定的服务器。

由于一开始我们不知道Panel中的js与DevTools Page中的js具有同样权限
所以,只在DevTools Page中监听了chrome.devtools.network.onRequestFinished事件。

然后为了将结果显示在Panel中,我们又不得不研究DevTools Page如何与Panel通信,
最终选择了建立持久连接的方式。

结果就可想而知了,由于chrome.runtime.onConnect可以监听所有tab页的chrome.runtime.connect请求,
我们就踩坑了。

最后想到上面的传tabId的方法。

我们后来知道了,Panel是和DevTools Page具有相同权限的。

就只在DevTools Page中保留了创建Panel的代码,
然后在Panel中监听chrome.devtools.network.onRequestFinished事件,
就完成了这个功能。

参考

Extending DevTools
源码:chrome-extension-example

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

推荐阅读更多精彩内容

  • chrome扩展开发入门教程 最近在开发chrome插件,看到一篇非常适合入门的教程,特记录一下 注:转载 本文首...
    谢大见阅读 6,411评论 1 25
  • 架构 总括:Manifest:程序清单Background:插件运行环境/主程序Pop up:弹出页面Conten...
    程序员小逗逼阅读 10,323评论 2 18
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,368评论 25 707
  • Python内建的filter()函数用于过滤序列。和map()类似,filter()也接收一个函数和一个序列。和...
    bjchenli阅读 322评论 0 0
  • .终于画完啦,今天尝试着用针管笔在卡纸上画,嗯,也算是全新的体验。排线和细节还需要继续好好学习。.
    曾颖阅读 417评论 0 1