devbox
你好赵伟
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

【干货】Chrome插件(扩展)开发全攻略

作者：你好赵伟 | 2024-02-11 17:28:17

赞

踩

only one of 'browser_action', 'page_action', and 'app' can be specified. 无

写在前面

我花了将近一个多月的时间断断续续写下这篇博文，并精心写下完整demo，写博客的辛苦大家懂的，所以转载务必保留出处。本文所有涉及到的大部分代码均在这个demo里面：https://github.com/sxei/chrome-plugin-demo ，大家可以直接下载下来运行。

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

本文目录：

352797-20170711100228759-367621595.png

demo部分截图：

352797-20170711100429118-918303767.png

前言

什么是Chrome插件

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

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

个人猜测crx可能是Chrome Extension如下3个字母的简写：

352797-20170711100448275-555008903.png

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

352797-20170711100549040-348646504.png

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

学习Chrome插件开发有什么意义

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

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

  • 书签控制；
  • 下载控制；
  • 窗口控制；
  • 标签控制；
  • 网络请求控制，各类事件监听；
  • 自定义原生菜单；
  • 完善的通信机制；
  • 等等；

为什么是Chrome插件而不是Firefox插件

  1. Chrome占有率更高，更多人用；
  2. 开发更简单；
  3. 应用场景更广泛，Firefox插件只能运行在Firefox上，而Chrome除了Chrome浏览器之外，还可以运行在所有webkit内核的国产浏览器，比如360极速浏览器、360安全浏览器、搜狗浏览器、QQ浏览器等等；
  4. 除此之外，Firefox浏览器也对Chrome插件的运行提供了一定的支持；

开发与调试

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

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

352797-20170711101025931-1366345527.png

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

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

核心介绍

manifest.json

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

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

  1. {
  2.     // 清单文件的版本，这个必须写，而且必须是2
  3.     "manifest_version": 2,
  4.     // 插件的名称
  5.     "name": "demo",
  6.     // 插件的版本
  7.     "version": "1.0.0",
  8.     // 插件描述
  9.     "description": "简单的Chrome扩展demo",
  10.     // 图标，一般偷懒全部用一个尺寸的也没问题
  11.     "icons":
  12.     {
  13.         "16": "img/icon.png",
  14.         "48": "img/icon.png",
  15.         "128": "img/icon.png"
  16.     },
  17.     // 会一直常驻的后台JS或后台页面
  18.     "background":
  19.     {
  20.         // 2种指定方式，如果指定JS，那么会自动生成一个背景页
  21.         "page": "background.html"
  22.         //"scripts": ["js/background.js"]
  23.     },
  24.     // 浏览器右上角图标设置，browser_action、page_action、app必须三选一
  25.     "browser_action": 
  26.     {
  27.         "default_icon": "img/icon.png",
  28.         // 图标悬停时的标题，可选
  29.         "default_title": "这是一个示例Chrome插件",
  30.         "default_popup": "popup.html"
  31.     },
  32.     // 当某些特定页面打开才显示的图标
  33.     /*"page_action":
  34.     {
  35.         "default_icon": "img/icon.png",
  36.         "default_title": "我是pageAction",
  37.         "default_popup": "popup.html"
  38.     },*/
  39.     // 需要直接注入页面的JS
  40.     "content_scripts": 
  41.     [
  42.         {
  43.             //"matches": ["http://*/*", "https://*/*"],
  44.             // "<all_urls>" 表示匹配所有地址
  45.             "matches": ["<all_urls>"],
  46.             // 多个JS按顺序注入
  47.             "js": ["js/jquery-1.8.3.js", "js/content-script.js"],
  48.             // JS的注入可以随便一点，但是CSS的注意就要千万小心了，因为一不小心就可能影响全局样式
  49.             "css": ["css/custom.css"],
  50.             // 代码注入的时间，可选值： "document_start", "document_end", or "document_idle"，最后一个表示页面空闲时，默认document_idle
  51.             "run_at": "document_start"
  52.         },
  53.         // 这里仅仅是为了演示content-script可以配置多个规则
  54.         {
  55.             "matches": ["*://*/*.png", "*://*/*.jpg", "*://*/*.gif", "*://*/*.bmp"],
  56.             "js": ["js/show-image-content-size.js"]
  57.         }
  58.     ],
  59.     // 权限申请
  60.     "permissions":
  61.     [
  62.         "contextMenus", // 右键菜单
  63.         "tabs", // 标签
  64.         "notifications", // 通知
  65.         "webRequest", // web请求
  66.         "webRequestBlocking",
  67.         "storage", // 插件本地存储
  68.         "http://*/*", // 可以通过executeScript或者insertCSS访问的网站
  69.         "https://*/*" // 可以通过executeScript或者insertCSS访问的网站
  70.     ],
  71.     // 普通页面能够直接访问的插件资源列表，如果不设置是无法直接访问的
  72.     "web_accessible_resources": ["js/inject.js"],
  73.     // 插件主页，这个很重要，不要浪费了这个免费广告位
  74.     "homepage_url": "https://www.baidu.com",
  75.     // 覆盖浏览器默认页面
  76.     "chrome_url_overrides":
  77.     {
  78.         // 覆盖浏览器默认的新标签页
  79.         "newtab": "newtab.html"
  80.     },
  81.     // Chrome40以前的插件配置页写法
  82.     "options_page": "options.html",
  83.     // Chrome40以后的插件配置页写法，如果2个都写，新版Chrome只认后面这一个
  84.     "options_ui":
  85.     {
  86.         "page": "options.html",
  87.         // 添加一些默认的样式，推荐使用
  88.         "chrome_style": true
  89.     },
  90.     // 向地址栏注册一个关键字以提供搜索建议，只能设置一个关键字
  91.     "omnibox": { "keyword" : "go" },
  92.     // 默认语言
  93.     "default_locale": "zh_CN",
  94.     // devtools页面入口，注意只能指向一个HTML文件，不能是JS文件
  95.     "devtools_page": "devtools.html"
  96. }

content-scripts

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

示例配置：

  1. {
  2.     // 需要直接注入页面的JS
  3.     "content_scripts": 
  4.     [
  5.         {
  6.             //"matches": ["http://*/*", "https://*/*"],
  7.             // "<all_urls>" 表示匹配所有地址
  8.             "matches": ["<all_urls>"],
  9.             // 多个JS按顺序注入
  10.             "js": ["js/jquery-1.8.3.js", "js/content-script.js"],
  11.             // JS的注入可以随便一点，但是CSS的注意就要千万小心了，因为一不小心就可能影响全局样式
  12.             "css": ["css/custom.css"],
  13.             // 代码注入的时间，可选值： "document_start", "document_end", or "document_idle"，最后一个表示页面空闲时，默认document_idle
  14.             "run_at": "document_start"
  15.         }
  16.     ],
  17. }

特别注意，如果没有主动指定run_at为document_start（默认为document_idle），下面这种代码是不会生效的：

  1. document.addEventListener('DOMContentLoaded', function()
  2. {
  3.     console.log('我被执行了！');
  4. });

content-scripts和原始页面共享DOM，但是不共享JS，如要访问页面JS（例如某个JS变量），只能通过injected js来实现。content-scripts不能访问绝大部分chrome.xxx.api，除了下面这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里面。

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

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

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

  1. {
  2.     // 会一直常驻的后台JS或后台页面
  3.     "background":
  4.     {
  5.         // 2种指定方式，如果指定JS，那么会自动生成一个背景页
  6.         "page": "background.html"
  7.         //"scripts": ["js/background.js"]
  8.     },
  9. }

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

event-pages

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

  1. {
  2.     "background":
  3.     {
声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/你好赵伟/article/detail/76213
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号