Chrome插件(扩展)开发全攻略

   日期:2024-11-02     作者:caijiyuan       评论:0    移动:http://3jjewl.riyuangf.com/mobile/news/230.html
核心提示:转载出处。本文所有涉及到的大部分代码均在这个demo里面:https://github.com/sxei/chrome-plugin-demo ,大家可以

转载出处。本文所有涉及到的大部分代码均在这个demo里面:https://github.com/sxei/chrome-plugin-demo ,大家可以直接下载下来运行。

Chrome插件(扩展)开发全攻略

另外,本文图片较多,且图片服务器带宽有限,右下角的目录滚动监听必须等到图片全部加载完毕之后才会触发,所以请耐心等待加载完毕。

本文目录

demo部分截图

 

严格来讲,我们正在说的东西应该叫Chrome扩展(),真正意义上的Chrome插件是更底层的浏览器功能扩展,可能需要对浏览器源码有一定掌握才有能力去开发。鉴于Chrome插件的叫法已经习惯,本文也全部采用这种叫法,但读者需深知本文所描述的Chrome插件实际上指的是Chrome扩展。

Chrome插件是一个用Web技术开发、用来增强浏览器功能的软件,它其实就是一个由HTML、CSS、JS、图片等资源组成的一个.crx后缀的压缩包.

个人猜测可能是如下3个字母的简写

另外,其实不只是前端技术,Chrome插件还可以配合C++编写的dll动态链接库实现一些更底层的功能(NPAPI),比如全屏幕截图。

由于安全原因,Chrome浏览器42以上版本已经陆续不再支持NPAPI插件,取而代之的是更安全的PPAPI。

增强浏览器功能,轻松实现属于自己的“定制版”浏览器,等等。

Chrome插件提供了很多实用API供我们使用,包括但不限于

  • 书签控制
  • 下载控制
  • 窗口控制
  • 标签控制
  • 网络请求控制,各类事件监听
  • 自定义原生菜单
  • 完善的通信机制
  • 等等
  1. Chrome占有率更高,更多人用
  2. 开发更简单
  3. 应用场景更广泛,Firefox插件只能运行在Firefox上,而Chrome除了Chrome浏览器之外,还可以运行在所有webkit内核的国产浏览器,比如360极速浏览器、360安全浏览器、搜狗浏览器、QQ浏览器等等
  4. 除此之外,Firefox浏览器也对Chrome插件的运行提供了一定的支持

Chrome插件没有严格的项目结构要求,只要保证本目录有一个即可,也不需要专门的IDE,普通的web开发工具即可。

从右上角菜单->更多工具->扩展程序可以进入 插件管理页面,也可以直接在地址栏输入 chrome://extensions 访问。

勾选即可以文件夹的形式直接加载插件,否则只能安装格式的文件。Chrome要求插件必须从它的Chrome应用商店安装,其它任何网站下载的都无法直接安装,所以,其实我们可以把文件解压,然后通过开发者模式直接加载。

开发中,代码有任何改动都必须重新加载插件,只需要在插件管理页按下即可,以防万一最好还把页面刷新一下。

这是一个Chrome插件最重要也是必不可少的文件,用来配置所有和插件相关的配置,必须放在根目录。其中,、、3个是必不可少的,和是推荐的。

下面给出的是一些常见的配置项,均有中文注释,完整的配置文档请戳这里。

所谓content-scripts,其实就是Chrome插件中向页面注入脚本的一种形式(虽然名为script,其实还可以包括css的,借助我们可以实现通过配置的方式轻松向指定页面注入JS和CSS(如果需要动态注入,可以参考下文,最常见的比如:广告屏蔽、页面CSS定制,等等。

特别注意,如果没有主动指定为(默认为,下面这种代码是不会生效的

和原始页面共享DOM,但是不共享JS,如要访问页面JS(例如某个JS变量,只能通过来实现。不能访问绝大部分,除了下面这4种

  • chrome.extension(getURL , inIncognitoContext , lastError , onRequest , sendRequest)
  • chrome.i18n
  • chrome.runtime(connect , getManifest , getURL , id , onConnect , onMessage , sendMessage)
  • chrome.storage

其实看到这里不要悲观,这些API绝大部分时候都够用了,非要调用其它API的话,你还可以通过通信来实现让background来帮你调用(关于通信,后文有详细介绍)。

好了,Chrome插件给我们提供了这么强大的JS注入功能,剩下的就是发挥你的想象力去玩弄浏览器了。

后台(姑且这么翻译吧,是一个常驻的页面,它的生命周期是插件中所有类型页面中最长的,它随着浏览器的打开而打开,随着浏览器的关闭而关闭,所以通常把需要一直运行的、启动就运行的、全局的代码放在background里面。

background的权限非常高,几乎可以调用所有的Chrome扩展API(除了devtools,而且它可以无限制跨域,也就是可以跨域访问任何网站而无需要求对方设置。

经过测试,其实不止是background,所有的直接通过这种方式打开的网页都可以无限制跨域。

配置中,可以通过指定一张网页,也可以通过直接指定一个JS,Chrome会自动为这个JS生成一个默认的网页

需要特别说明的是,虽然你可以通过直接打开后台页,但是你打开的后台页和真正一直在后台运行的那个页面不是同一个,换句话说,你可以打开无数个,但是真正在后台常驻的只有一个,而且这个你永远看不到它的界面,只能调试它的代码。

这里顺带介绍一下event-pages,它是一个什么东西呢?鉴于background生命周期太长,长时间挂载后台可能会影响性能,所以Google又弄一个,在配置文件上,它与background的唯一区别就是多了一个参数

它的生命周期是:在被需要时加载,在空闲时被关闭,什么叫被需要时呢?比如第一次安装、插件更新、有content-script向它发送消息,等等。

除了配置文件的变化,代码上也有一些细微变化,个人这个简单了解一下就行了,一般情况下background也不会很消耗性能的。

是点击或者图标时打开的一个小窗口网页,焦点离开网页就立即关闭,一般用来做一些临时性的交互。

可以包含任意你想要的HTML内容,并且会自适应大小。可以通过字段来指定popup页面,也可以调用方法。

配置方式

需要特别注意的是,由于单击图标打开popup,焦点离开又立即关闭,所以popup页面的生命周期一般很短,需要长时间运行的代码千万不要写在popup里面。

在权限上,它和background非常类似,它们之间最大的不同是生命周期的不同,popup中可以直接通过获取background的window对象。

这里的是我给它取的,指的是通过DOM操作的方式向页面注入的一种JS。为什么要把这种JS单独拿出来讨论呢?又或者说为什么需要通过这种方式注入JS呢

这是因为有一个很大的“缺陷”,也就是无法访问页面中的JS,虽然它可以操作DOM,但是DOM却不能调用它,也就是无法在DOM中通过绑定事件的方式调用中的代码(包括直接写和2种方式都不行,但是,“在页面上添加一个按钮并调用插件的扩展API”是一个很常见的需求,那该怎么办呢?其实这就是本小节要讲的。

在中通过DOM方式向页面注入代码示例

你以为这样就行了?执行一下你会看到如下报错

意思就是你想要在web中直接访问插件中的资源的话必须显示声明才行,配置文件中增加如下

至于如何调用中的代码,后面我会在专门的一个消息通信章节详细介绍。

开发者或者插件主页设置,一般会在如下2个地方显示

通过配置可以在浏览器的右上角增加一个图标,一个可以拥有一个图标,一个,一个和一个。

示例配置如下

5.1.1. 图标

图标推荐使用宽高都为19像素的图片,更大的图标会被缩小,格式随意,一般推荐png,可以通过manifest中字段配置,也可以调用setIcon()方法。

5.1.2. tooltip

修改的manifest中字段,或者调用方法。

5.1.3. badge

所谓就是在图标上显示一些文本,可以用来更新一些小的扩展状态提示信息。因为badge空间有限,所以只支持4个以下的字符(英文4个,中文2个)。badge无法通过配置文件来指定,必须通过代码实现,设置badge文字和颜色可以分别使用和。

所谓,指的是只有当某些特定页面打开才显示的图标,它和最大的区别是一个始终都显示,一个只在特定情况才显示。

需要特别说明的是早些版本的Chrome是将pageAction放在地址栏的最右边,左键单击弹出popup,右键单击则弹出相关默认的选项菜单

而新版的Chrome更改了这一策略,pageAction和普通的browserAction一样也是放在浏览器右上角,只不过没有点亮时是灰色的,点亮了才是彩色的,灰色时无论左键还是右键单击都是弹出选项

具体是从哪一版本开始改的没去仔细考究,反正知道v50.0的时候还是前者,v58.0的时候已改为后者。

调整之后的我们可以简单地把它看成是可以置灰的。

  • chrome.pageAction.show(tabId) 显示图标
  • chrome.pageAction.hide(tabId) 隐藏图标

示例(只有打开百度才显示图标)

效果图

通过开发Chrome插件可以自定义浏览器的右键菜单,主要是通过API实现,右键菜单可以出现在不同的上下文,比如普通页面、选中的文字、图片、链接,等等,如果有同一个插件里面定义了多个菜单,Chrome会自动组合放到以插件名字命名的二级菜单里,如下

5.3.1. 最简单的右键菜单示例

5.3.2. 添加右键百度搜索

效果如下

5.3.3. 语法说明

这里只是简单列举一些常用的,完整API参见:https://developer.chrome.com/extensions/contextMenus

使用页可以将Chrome默认的一些特定页面替换掉,改为使用扩展提供的页面。

扩展可以替代如下页面

  • 历史记录:从工具菜单上点击历史记录时访问的页面,或者从地址栏直接输入 chrome://history
  • 新标签页:当创建新标签的时候访问的页面,或者从地址栏直接输入 chrome://newtab
  • 书签:浏览器的书签,或者直接输入 chrome://bookmarks

注意

  • 一个扩展只能替代一个页面
  • 不能替代隐身窗口的新标签页
  • 网页必须设置title,否则用户可能会看到网页的URL,造成困扰

下面的截图是默认的新标签页和被扩展替换掉的新标签页。

代码(注意,一个插件只能替代一个默认页,以下仅为演示

5.5.1. 预热

使用过vue的应该见过这种类型的插件

是的,Chrome允许插件在开发者工具(devtools)上动手脚,主要表现在

  • 自定义一个和多个和、、等同级别的面板
  • 自定义侧边栏(sidebar),目前只能自定义面板的侧边栏

先来看2张简单的demo截图,自定义面板(判断当前页面是否使用了jQuery

自定义侧边栏(获取当前页面所有图片

5.5.2. devtools扩展介绍

主页:https://developer.chrome.com/extensions/devtools

来一张官方图片

每打开一个开发者工具窗口,都会创建devtools页面的实例,F12窗口关闭,页面也随着关闭,所以devtools页面的生命周期和devtools窗口是一致的。devtools页面可以访问一组特有的以及有限的扩展API,这组特有的只有devtools页面才可以访问,background都无权访问,这些API包括

  • :面板相关
  • :获取被审查窗口的有关信息
  • :获取有关网络请求的信息

大部分扩展API都无法直接被页面调用,但它可以像一样直接调用和API,同时它也可以像一样使用Message交互的方式与background页面进行通信。

5.5.3. 实例:创建一个devtools扩展

首先,要针对开发者工具开发插件,需要在清单文件声明如下

这个里面一般什么都没有,就引入一个js

可以看出来,其实真正代码是,html文件是“多余”的,所以这里觉得有点坑,干嘛不允许直接指定JS呢

再来看devtools.js的代码

setPage时的效果

以下截图示例的代码

5.5.4. 调试技巧

修改了devtools页面的代码时,需要先在 chrome://extensions 页面按下重新加载插件,然后关闭再打开开发者工具即可,无需刷新页面(而且只刷新页面不刷新开发者工具的话是不会生效的)。

由于devtools本身就是开发者工具页面,所以几乎没有方法可以直接调试它,直接用 的方式打开页面肯定报错,因为不支持相关特殊API,只能先自己写一些方法屏蔽这些错误,调试通了再放开。

所谓页,就是插件的设置页面,有2个入口,一个是右键图标有一个“选项”菜单,还有一个在插件管理页面

在Chrome40以前,options页面和其它普通页面没什么区别,Chrome40以后则有了一些变化。

我们先看老版的options

这个页面里面的内容就随你自己发挥了,配置之后在插件管理页就会看到一个按钮入口,点进去就是打开一个网页,没啥好讲的。

效果:

再来看新版的optionsV2

的代码我们没有任何改动,只是配置文件改了,之后效果如下

看起来是不是高大上了

几点注意

  • 为了兼容,建议2种都写,如果都写了,Chrome40以后会默认读取新版的方式
  • 新版options中不能使用alert
  • 数据存储建议用chrome.storage,因为会随用户自动同步

是向用户提供搜索建议的一种方式。先来看个图以便了解一下这东西到底是个什么鬼

注册某个关键字以触发插件自己的搜索建议界面,然后可以任意发挥了。

首先,配置文件如下

然后中注册监听事件

Chrome提供了一个API以便插件推送桌面通知,暂未找到和HTML5自带的的显著区别及优势。

在后台JS中,无论是使用还是都不需要申请权限(HTML5方式需要申请权限,直接使用即可。

最简单的通知

代码

通知的样式可以很丰富

这个没有深入研究,有需要的可以去看官方文档。

前面我们介绍了Chrome插件中存在的5种JS,那么它们之间如何互相通信呢?下面先来系统概况一下,然后再分类细说。需要知道的是,popup和background其实几乎可以视为一种东西,因为它们可访问的API都一样、通信机制一样、都可以跨域。

:表示不存在或者无意义,或者待验证。

 injected-scriptcontent-scriptpopup-jsbackground-jsinjected-script-window.postMessage--content-scriptwindow.postMessage-chrome.runtime.sendMessage chrome.runtime.connectchrome.runtime.sendMessage chrome.runtime.connectpopup-js-chrome.tabs.sendMessage chrome.tabs.connect-chrome.extension. getBackgroundPage()background-js-chrome.tabs.sendMessage chrome.tabs.connectchrome.extension.getViews-devtools-jschrome.devtools. inspectedWindow.eval-chrome.runtime.sendMessagechrome.runtime.sendMessage

7.2.1. popup和background

popup可以直接调用background中的JS方法,也可以直接访问background的DOM

小插曲,今天碰到一个情况,发现popup无法获取background的任何方法,找了半天才发现是因为background的js报错了,而你如果不主动查看background的js的话,是看不到错误信息的,特此提醒。

至于访问如下(前提是已经打开

7.2.2. popup或者bg向content主动发送消息

background.js或者popup.js

接收

双方通信直接发送的都是JSON对象,不是JSON字符串,所以无需解析,很方便(当然也可以直接发送字符串)。

网上有些老代码中用的是,没有完全查清二者的区别(貌似是别名),但是建议统一使用。

7.2.3. content-script主动发消息给后台

background.js 或者 popup.js

注意事项

  • content_scripts向主动发消息的前提是popup必须打开!否则需要利用background作中转
  • 如果background和popup同时监听,那么它们都可以同时收到消息,但是只有一个可以sendResponse,一个先发送了,那么另外一个再发送就无效

7.2.4. injected script和content-script

和页面内的脚本(自然也属于页面内的脚本)之间唯一共享的东西就是页面的DOM元素,有2种方法可以实现二者通讯

  1. 可以通过和来实现二者消息通讯
  2. 通过自定义DOM事件来实现

第一种方法(推荐

content script中

第二种方法

其实上面已经涉及到了,这里再单独说明一下。Chrome插件中有2种通信方式,一个是短连接(和,一个是长连接(和)。

短连接的话就是挤牙膏一样,我发送一下,你收到了再回复一下,如果对方不回复,你只能重新发,而长连接类似会一直建立连接,双方可以随时互发消息。

短连接上面已经有代码示例了,这里只讲一下长连接。

popup.js

虽然在和中无法直接访问页面DOM,但是可以通过来执行脚本,从而实现访问web页面的DOM(注意,这种方式也不能直接访问页面JS)。

JS

JS代码

一般有2种方法

获取当前选项卡id的另一种方法,大部分时候都类似,只有少部分时候会不一样(例如当窗口最小化时

本地存储建议用而不是普通的,区别有好几点,个人认为最重要的2点区别是

  • 是针对插件全局的,即使你在中保存的数据,在也能获取到
  • 可以跟随当前登录用户自动同步,这台电脑修改的设置会自动同步到其它电脑,很方便,如果没有登录或者未联网则先保存到本地,等登录了再同步至网络

需要声明权限,有和2种方式可供选择,使用示例如下

通过webRequest系列API可以对HTTP请求进行任性地修改、定制,这里通过来简单演示一下它的冰山一角

插件根目录新建一个名为的文件夹,再在下面新建一些语言的文件夹,如、、,然后再在每个文件夹放入一个,同时必须在清单文件中设置。

在和文件中通过引入,如

JS中则直接。

测试时,通过给chrome建立一个不同的快捷方式来切换语言,如

英文效果

中文效果

比较常用用的一些API系列

  • chrome.tabs
  • chrome.runtime
  • chrome.webRequest
  • chrome.window
  • chrome.storage
  • chrome.contextMenus
  • chrome.devtools
  • chrome.extension

已安装的插件源码路径,每一个插件被放在以插件ID为名的文件夹里面,想要学习某个插件的某个功能是如何实现的,看人家的源码是最好的方法了

如何查看某个插件的ID?进入 chrome://extensions ,然后勾线开发者模式即可看到了。

很多时候你发现你的代码会莫名其妙的失效,找来找去又找不到原因,这时打开background的控制台才发现原来某个地方写错了导致代码没生效,正式由于background报错的隐蔽性(需要主动打开对应的控制台才能看到错误),所以特别注意这点。

在对popup页面审查元素的时候popup会被强制打开无法关闭,只有控制台关闭了才可以关闭popup,原因很简单:如果popup关闭了控制台就没用了。这种方法在某些情况下很实用

也就是不支持将js直接写在html中,比如

解决方法就是用JS绑定事件

另外,对于A标签,这样写然后用JS绑定事件虽然控制台会报错,但是不受影响,当然强迫症患者受不了的话只能写成了。

如果这样写

由于通过注入的CSS优先级非常高,几乎仅次于浏览器默认样式,稍不注意可能就会影响一些网站的展示效果,所以尽量不要写一些影响全局的样式。

之所以强调这个,是因为这个带来的问题非常隐蔽,不太容易找到,可能你正在写某个网页,昨天样式还是好好的,怎么今天就突然不行了?然后你辛辛苦苦找来找去,找了半天才发现竟然是因为插件里面的一个样式影响的

打包的话直接在插件管理页有一个打包按钮

然后会生成一个文件,要发布到Google应用商店的话需要先登录你的Google账号,然后花5个$注册为开发者,本人太穷,就懒得亲自验证了,有发布需求的自己去整吧。

 
特别提示:本信息由相关用户自行提供,真实性未证实,仅供参考。请谨慎采用,风险自负。

举报收藏 0打赏 0评论 0
 
更多>同类最新资讯
0相关评论

相关文章
最新文章
推荐文章
推荐图文
最新资讯
点击排行
{
网站首页  |  关于我们  |  联系方式  |  使用协议  |  隐私政策  |  版权隐私  |  网站地图  |  排名推广  |  广告服务  |  积分换礼  |  网站留言  |  RSS订阅  |  违规举报  |  鄂ICP备2020018471号