说在前面
在我日常开发以及娱乐生活中,浏览器是我使用频率较高的一个应用,当我大学拥有第一部电脑开始,之后不论电脑换成什么,以及使用的是什么系统,我的首选浏览器都是Chrome,不仅仅是因为其速度快,更多是它丰富的扩展在吸引我,那么大家有没有想过如何自己来开发一个Chrome浏览器插件呢?是不是有的同学会觉得Chrome浏览器插件的制作难度会很大呢?今天就让我来带你们看看一个简单的Chrome浏览器插件的编写过程,并给大家制作一个简单的插件模板,大家可以通过模板来进行快速开发。
一、项目结构
一个完整的插件目录结构如下:
(一)html + js
1、manifest.json
简单配置,具体配置说明已在配置项后标出。
{ "manifest_version": 2, //版本号,由google指定为2 "name": "helloWorld", //插件名称 "version": "1.0", //插件版本 "description": "hello world 插件", //插件描述 "icons": { //插件图标 "128": "img/logo.jpg", "48": "img/logo.jpg", "16": "img/logo.jpg" }, "browser_action": { "default_icon": "img/logo.jpg", //插件图标 "default_popup": "default_popup" //点击图标后弹出的html互动文件 }, "content_scripts": [ { "matches": ["<all_urls>"], //匹配url "js": ["bg.js"], //执行脚本 "run_at": "document_start" //脚本运行时机 } ], "permissions": ["tabs", "activeTab"] //权限申请 }
使用"content_scripts"你可以修改你当前访问的页面的dom,主要是靠js实现的,里面的"matches"是一个数组,里面装的是一些匹配的规则,意思就是当你的页面的地址满足数组里面的值的时候就会操作js文件,all_urls表示所有网页都会加载脚本。而"js"里面的是具体的操作,具体操作就是要自己写了。
2、popup.html
插件弹窗页,可以直接编写一个html页面,在manifest.json中的default_popup项进行配置即可。
<!DOCTYPE html> <html lang=""> <head> <title>helloWorld</title> <meta charset="utf-8" /> </head> <body style="width: 200px; height: 200px"> <h1 id="message">你好</h1> <input id="input1" type="text" /> </body> <script src="js/popup.js"></script> </html>
3、popup.js
插件弹窗页的脚本js代码,在popup.html页面中引入即可。
(function () { const input1 = document.getElementById("input1"); const message = document.getElementById("message"); input1.addEventListener("keyup", (e) => { message.innerHTML = "你好" + e.target.value; chrome.tabs.query({ active: true, currentWindow: true }, function (tab) { chrome.tabs.sendMessage( tab[0].id, { action: "hello", data: message.innerHTML, }, function (response) { console.loig("收到回复:", response.state); } ); }); }); })();
4、bg.js
运行在浏览器打开tab窗体的脚本,需要在manifest.json中的content_scripts中进行配置。
chrome.runtime.onMessage.addListener(function (request, sender, sendResponse) { const { action, data } = request; console.log("%c Line:4 🥔 action,data", "color:#b03734", action, data); sendResponse({ state: "已接收到数据" + data }); });
(二)vue + js
1、使用vue来编写插件弹窗页
使用vue来编写插件弹窗页面,我们可以将项目结构简化成这样,只需要修改manifest.json中的default_popup为vue项目打出的dist包即可。
{ "manifest_version": 2, //版本号,由google指定为2 "name": "helloWorld", //插件名称 "version": "1.0", //插件版本 "description": "hello world 插件", //插件描述 "icons": { //插件图标 "128": "img/logo.jpg", "48": "img/logo.jpg", "16": "img/logo.jpg" }, "browser_action": { "default_icon": "img/logo.jpg", //插件图标 "default_popup": "demo/dist/index.html" //点击图标后弹出的html互动文件 }, "content_scripts": [ { "matches": ["<all_urls>"], //匹配url "js": ["bg.js"], //执行脚本 "run_at": "document_start" //脚本运行时机 } ], "permissions": ["tabs", "activeTab"] //权限申请 }
并将popup.js文件移到vue项目中,在index.html中引入即可。
二、浏览器导入插件
(一)进入chrome扩展程序管理页
(二)加载扩展程序
(三)页面使用插件
三、模板源码
(一)gitee源码下载
模板代码已上传到gitee,具体地址如下:
https://gitee.com/zheng_yongtao/chrome-plug-in.git
(二)依赖下载
拉取模板代码之后需要先下载vue模板的依赖(npm install
)。
(三)vue打包
安装好vue模板的依赖之后,就可以对vue项目进行打包(npm run build
)。
(四)命令行快速安装
目前插件模板已集成到脚手架jyeontu
工具中,我们可以通过它来快速生成一个插件目录模板。
- 安装脚手架
npm install -g jyeontu
安装完成后运行创建模板命令
jyeontu create
拉取最新模板文件之后选择创建chrome浏览器模板即可。
说在后面
🎉 这里是 JYeontu,现在是一名前端工程师,有空会刷刷算法题,平时喜欢打羽毛球 🏸 ,平时也喜欢写些东西,既为自己记录 📋,也希望可以对大家有那么一丢丢的帮助,写的不好望多多谅解 🙇,写错的地方望指出,定会认真改进 😊,偶尔也会在自己的公众号『前端也能这么有趣』发一些比较有趣的文章,有兴趣的也可以关注下。在此谢谢大家的支持,我们下文再见 🙌。