用js开发chrome扩展插件史上最全详细教程

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

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

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

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

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

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

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

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

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

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

示例配置:

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

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

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

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

经过测试,其实不止是background,所有的直接通过chrome-extension://id/xx.html这种方式打开的网页都可以无限制跨域。

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

{//会一直常驻的后台JS或后台页面"background":{//2种指定方式,如果指定JS,那么会自动生成一个背景页"page":"background.html"//"scripts":["js/background.js"]},}需要特别说明的是,虽然你可以通过chrome-extension://xxx/background.html直接打开后台页,但是你打开的后台页和真正一直在后台运行的那个页面不是同一个,换句话说,你可以打开无数个background.html,但是真正在后台常驻的只有一个,而且这个你永远看不到它的界面,只能调试它的代码。

{"background":{"scripts":["event-page.js"],"persistent":false},}它的生命周期是:在被需要时加载,在空闲时被关闭,什么叫被需要时呢?比如第一次安装、插件更新、有content-script向它发送消息,等等。

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

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

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

配置方式:

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

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

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

在content-script中通过DOM方式向页面注入inject-script代码示例:

{//普通页面能够直接访问的插件资源列表,如果不设置是无法直接访问的"web_accessible_resources":["js/inject.js"],}至于inject-script如何调用content-script中的代码,后面我会在专门的一个消息通信章节详细介绍。

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

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

示例配置如下:

"browser_action":{"default_icon":"img/icon.png","default_title":"这是一个示例Chrome插件","default_popup":"popup.html"}5.1.1.图标browser_action图标推荐使用宽高都为19像素的图片,更大的图标会被缩小,格式随意,一般推荐png,可以通过manifest中default_icon字段配置,也可以调用setIcon()方法。

修改browser_action的manifest中default_title字段,或者调用setTitle()方法。

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

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

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

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

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

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

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

扩展可以替代如下页面:

注意:

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

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

"chrome_url_overrides":{"newtab":"newtab.html","history":"history.html","bookmarks":"bookmarks.html"}5.5.devtools(开发者工具)5.5.1.预热使用过vue的应该见过这种类型的插件:

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

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

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

来一张官方图片:

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

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

{//只能指向一个HTML文件,不能是JS文件"devtools_page":"devtools.html"}这个devtools.html里面一般什么都没有,就引入一个js:

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

再来看devtools.js的代码:

以下截图示例的代码:

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

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

{//Chrome40以前的插件配置页写法"options_page":"options.html",}这个页面里面的内容就随你自己发挥了,配置之后在插件管理页就会看到一个选项按钮入口,点进去就是打开一个网页,没啥好讲的。

效果:

{"options_ui":{"page":"options.html",//添加一些默认的样式,推荐使用"chrome_style":true},}options.html的代码我们没有任何改动,只是配置文件改了,之后效果如下:

看起来是不是高大上了?

几点注意:

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

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

首先,配置文件如下:

{//向地址栏注册一个关键字以提供搜索建议,只能设置一个关键字"omnibox":{"keyword":"go"},}然后background.js中注册监听事件:

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

最简单的通知:

代码:

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

Chrome插件的JS主要可以分为这5类:injectedscript、content-script、popupjs、backgroundjs和devtoolsjs,

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

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

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

至于background访问popup如下(前提是popup已经打开):

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

content-script.js:

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

第一种方法(推荐):

injected-script中:

window.addEventListener("message",function(e){console.log(e.data);},false);第二种方法:

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

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

popup.js:

示例manifest.json配置:

//获取当前选项卡IDfunctiongetCurrentTabId(callback){chrome.tabs.query({active:true,currentWindow:true},function(tabs){if(callback)callback(tabs.lengthtabs[0].id:null);});}获取当前选项卡id的另一种方法,大部分时候都类似,只有少部分时候会不一样(例如当窗口最小化时)

//获取当前选项卡IDfunctiongetCurrentTabId2(){chrome.windows.getCurrent(function(currentWindow){chrome.tabs.query({active:true,windowId:currentWindow.id},function(tabs){if(callback)callback(tabs.lengthtabs[0].id:null);});});}8.5.本地存储本地存储建议用chrome.storage而不是普通的localStorage,区别有好几点,个人认为最重要的2点区别是:

_locales\en\messages.json内容:

{"pluginDesc":{"message":"Asimplechromeextensiondemo"},"helloWorld":{"message":"HelloWorld!"}}_locales\zh_CN\messages.json内容:

{"pluginDesc":{"message":"一个简单的Chrome插件demo"},"helloWorld":{"message":"你好啊,世界!"}}在manifest.json和CSS文件中通过__MSG_messagename__引入,如:

{"description":"__MSG_pluginDesc__",//默认语言"default_locale":"zh_CN",}JS中则直接chrome.i18n.getMessage("helloWorld")。

测试时,通过给chrome建立一个不同的快捷方式chrome.exe--lang=en来切换语言,如:

英文效果:

中文效果:

比较常用用的一些API系列:

已安装的插件源码路径:C:\Users\用户名\AppData\Local\Google\Chrome\UserData\Default\Extensions,每一个插件被放在以插件ID为名的文件夹里面,想要学习某个插件的某个功能是如何实现的,看人家的源码是最好的方法了:

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

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

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

报错如下:

如果这样写:

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

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

推荐查看官方文档,虽然是英文,但是全且新,国内的中文资料都比较旧(注意以下全部需要FQ):

THE END
1.浏览器如何把打开各个网页都单独一个窗口设置成打开多个网页却2.3万 浏览 4 回答 免费韩国漫画在线观看的地址有么? 8047 浏览 4 回答 手机在哪里登录192.168.1.1设定页面? 9448 浏览 7 回答 肿么找回QQ浏览器历史记录 7297 浏览 6 回答 制作一个AE视频大概有多少酬劳? 2704 浏览 6 回答 最新问答 无线路由器设定后受限,不能上网 2002 浏览 4 回答 联想r61笔记本https://wap.zol.com.cn/ask/details_3033397_190279_3.html
2.C#使用process打开IE网页,总是打开的是新窗口,怎样打开一个标签如题 Process process = new Process();process.StartInfo.FileName = browFilePath; //浏览器文件目录https://bbs.csdn.net/topics/603510067
3.HTML+CSS入门篇(上)在这一章节我们要开始把网页中常用到的标签一 一向大家介绍,学习这一章节的时候要记住学习html标签过程中,主要注意两个方面的学习:标签的用途、标签在浏览器中的默认样式。 标签的用途:我们学习网页制作时,常常会听到一个词,语义化。那么什么叫做语义化呢,说的通俗点就是:明白每个标签的用途(在什么情况下使用此标https://www.jianshu.com/p/7aa0b5274181
4.在Mac上的Safari浏览器中使用网页标签页在Mac 上的 Safari 浏览器中,您可以在单个窗口中整理多个网页,方法是在标签页中打开网页。也可以重新排列标签页。https://support.apple.com/zh-cn/guide/safari/sfri11576/11.0/mac/10.13
5.常见问题·国产操作系统麒麟操作系统——麒麟软件官方网站如果一打开这个界面就有激活二维码就不需要进行这步操作。 ③ 然后使用绑定了“激活管理员”的微信号,扫描机器上的“激活二维码”,并且将正式授权书上的验证码填写进去即可获取到对应的激活码。 ④ 将获取到的激活码填写进系统里面,点击“激活/延长服务”即可2) 第三方软件怎么激活(永中office、wps、360浏览器https://www.kylinos.cn/support/problem.html
6.搜狗搜索引擎搜狗输入法浏览器网址导航企业推广 - 免责声明 - 意见反馈及投诉 - 隐私政策药品医疗器械网络信息服务备案:(京)网药械信息备字(2021)第00047号? 2004-2024 Sogou.com / 网上有害信息举报专区 / 京网文(2019)6117-724号 / 京ICP证050897号 / 京ICP备11001839号-1 / 京公网安备11000002000025号https://www.sogou.com/
7.如何在谷歌浏览器中设置每次打开都以新窗口形式出现?谷歌浏览器以其强大的功能和流畅的用户体验而广受好评,特别是其高度的可定制性,让用户可以根据自己的需求调整浏览器的行为,设置浏览器每次启动时都打开一个新窗口,是许多用户常见的需求之一,这项设置不仅能帮助用户保持工作区的组织性,还能有效避免重复或混乱的浏览历史记录。 https://www.kdun.com/ask/941235.html
8.360安全浏览器如果IE可以访问,360浏览器无法访问,请您清理下浏览记录,再进入qq空间。 ·为什么我访问两个账号的qq空间会串号? 由于架构上的一些问题,开两个普通浏览窗口访问两个账号的空间会导致qq空间串号。 解决方法是:请您开一个普通的浏览器打开一个账号的qq空间,再开一个无痕浏览访问另一个账号的qq空间,这样就可以访问两http://se.360.cn/v3/help_m11.htm
9.DeskreenDeskreen 是一款桌面应用程序,可以通过 WiFi 将任何带有网络浏览器的设备变成电脑的辅助屏幕。Deskreen 可用于将整个计算机显示镜像到任何具有 Web 浏览器的设备屏幕上。您还可以限制 Deskreen 只选择一个要共享的应用程序窗口视图-这对于演示非常有用。Deskreen 的最大特点是可以使用任何设备作为辅助屏幕。要获得真正的扩https://deskreen.com/
10.360导航淘宝?特卖58 同 城天 猫阿里1688携程旅行小视频?短剧唯 品 会网易?邮箱新浪?微博凤凰?军事AI浏览器 理财?东财爱 淘宝9377新页游51 页 游安 居客37 游戏360游戏传奇?传世360娱乐AI 办 公纳米搜索 游戏?小游戏360影视京东?秒杀复古传奇602?传奇百度教育斗鱼直播小 红 书工商银行马 蜂 https://hao.360.com/
11.同一台电脑/手机怎么双开Steam?如何共享Steam游戏库?(最新Steam多请记住,当关闭隐身窗口时,浏览器将销毁该会话中的所有内容哦。 Steam可以实现双开吗? 一般情况下不可以,可以用沙箱或者虚拟机之类的软件模拟一个新系统来运行两个桌面环境,从而实现双开。 此外,如果网页版登录一个steam,客户端也登录一个steam,这样也被认为是1台电脑上同时登录2个账号,从而实现双开。 https://www.extrabux.cn/chs/guide/7359990
12.吉林大学继续教育学院(培训学院)7、学习过程中点击课件、在线作业、语音答疑等,如果出现屏幕闪一下就没有反应,或一直显示“正在下载”怎么办? 答:这是由于您的电脑拦截了网页的弹出窗口。包括以下几种情况: 软件拦截,例如上网助手、Google、新浪点点通等,解决方法是将“屏蔽弹出窗口”此项功能关闭:查找 IE 浏览器工具栏中的关键字 “ 拦截 ”或http://dec.jlu.edu.cn/cms/wyjszcbwbd/442.htm
13.携程旅行网:酒店预订,机票预订查询,旅游度假,商旅管理携程酒店官网为您提供全球200多个国家和地区、9万多个城市的酒店预订及价格查询服务,覆盖酒店数超过170万家。提供各种住宿类型,包括:酒店、宾馆、旅社、客栈、民宿、经济连锁、酒店公寓、青年旅舍、农家乐、别墅、特色住宿等。同时提供酒店图片、房间照片、酒店电话、酒店地址以及真实用户的酒店点评等各类信息,方便用户选择https://www.ctrip.com/
14.XiaomiSU7Xiaomi15系列,搭载小米澎湃OS,共筑「人车家全生态」让全球每个人都能享受科技带来的美好生活https://www.mi.com/
15.Edge浏览器每次启动都是小窗口怎么办电脑软件edge浏览器是现在大伙最常使用的网页浏览工具之一,但是有些用户在反馈说,软件打开都是小窗口模式,需要在手动进行调整,那么要怎么设置才能够让edge浏览器打开为最大化,关于这个问题,本期的软件教程就来为广大用户们进行解答,接下来就让我们一起来看看具体的操作步骤吧。 https://www.php.cn/faq/892697.html
16.网易云音乐网易云音乐是一款专注于发现与分享的音乐产品,依托专业音乐人、DJ、好友推荐及社交功能,为用户打造全新的音乐生活。https://music.163.com/
17.爱彼迎度假屋小木屋海滨住宅等每趟行程都有合适的爱彼迎房源 → 700 万个度假屋 → 200 万个「房客推荐」房源 → 遍布全球逾 220 个国家和地区https://www.airbnb.cn/