写一个Chrome浏览器插件(manifest v3)

简介: 写一个Chrome浏览器插件(manifest v3)

1、创建manifest.json 文件

首先需要在项目的根目录下创建manifest.json文件,该文件描述插件的相关信息,如下所示:

  • description:插件的描述字段
  • name:插件的名字
  • manifest_version:chrome插件的版本(目前最新为版本3)
  • version:项目版本
  • author:项目作者
  • default_locale:默认为中文

icon图标,以及下面不同尺寸图标对应的路径信息。

web可访问的资源路径,以及对应的匹配规则。

权限配置列表:

  • storage chrome 存储相关的权限。
  • tabs 浏览器标签页的权限
  • background 后台运行的权限
  • scripting 脚本执行的权限
  • contextMenus 右键菜单的权限
  • 其他一些权限......

本机权限:匹配所有

action 包括默认标题名,默认的icon,默认的popup对应的路径。

后台运行,service_worker对应的js文件路径。

content脚本包括:

  • matches 匹配的规则
  • js content 脚本的路径
  • all_frames 是否支持 iframe 修改。

以上对应manifest.json 文件内容如下所示:

{    
      "description": "这是一个解密的工具",
      "name": "my_chrome_plug",
      "manifest_version": 3,
      "version": "1.0.0",
      "author": "yixuan",
      "default_locale": "zh_CN",
      "icons": {
        "16": "static/img/icon.png",
        "48": "static/img/icon.png",
        "128": "static/img/icon.png"
      },
      "web_accessible_resources": [{
        "resources": [
          "static/js/*",
          "static/css/*",
          "static/img/*"
        ],
        "matches": [
          "<all_urls>"
        ]
      }],
      "permissions": [
        "storage",
        "tabs",
        "background",
        "scripting",
        "contextMenus"
      ],
      "host_permissions": [
        "<all_urls>"
      ],
      "action": {
        "default_title": "my_chrome_plug",
        "default_icon": "static/img/icon.png",
        "default_popup": "index.html"
      },
      "background": {
        "service_worker": "static/js/background.js"
      },
      "content_scripts": [{
        "matches": [
          "<all_urls>"
        ],
        "js": [
          "static/js/content.js"
        ],
        "all_frames": true,
        "run_at": "document_idle"
      }]
    }

2、开始写popup页面以及对应的逻辑。

首先,列一下项目目录结构:

2.1 popup 页面

写一个解码的小工具,2个文本域输入框,和一个解码的按钮,对应页面html如下所示:

<body>
    <div class="_content">
        <form class="form-inline">
            <div class="form-group">
                <textarea type="text" class="from-control" id="_input" rows="6" placeholder="请输入......"></textarea>
            </div>
        </form>
        <div>
            <button id="_button" type="button" class="btn btn-primary"> 解码 </button>
        </div>
        <div class="form-group">
            <textarea type="text" class="from-control" id="_output" rows="16"></textarea>
        </div>
    </div>
</body>

2.2 后台运行 background.js

本项目中写了2个功能:

  • 创建右键菜单,以及菜单点击事件逻辑
  • 监听对应消息事件

所对应的代码如下所示:

// 创建右键菜单
chrome.contextMenus.create({
    id: "parent",
    title: 'DECODE 解码',
    contexts: ['page']
})
// 监听右键菜单单击事件,创建的tab标签页,指向的页面为index.html
chrome.contextMenus.onClicked.addListener((info, tab) => {
    if(info.menuItemId == 'parent') {
        console.log('menu......');
        chrome.tabs.create({
            url: "index.html" 
        })
    }
})
// 消息监听
chrome.runtime.onMessage.addListener((message) => {
    let keyArrys = Object.keys(message);
    let valueArrays = Object.keys(message);
    keyArrys && keyArrys.map((res, index) => chrom.storage.local.set({[res] : valueArrays[index]}))
})

2.3 content.js

content.js 和目标网页共享DOM节点,但是和目标的JS部分是隔离的,不能互相调用。

可以通过chrome api 对background.js 和 popup 页面的js部分进行通信,background.js 可以一直接受content.js发送过来的消息,因为background.js 一直在后台运行,而content.js 只有在popup页面打开的时候才能接收到对应的消息。

下面我们在content.js 中开始发送消息,如下所示:

async function sendMessage () {
    console.log("开始发送消息.............");
    await chrome.runtime.sendMessage(sessionStorage, function (res) {
        console.log("收到回复...............");
    })
}

2.4 popup页面的js文件

在当前js文件开始写对应的解码逻辑。首先,整个dom加载完毕之后,对解码按钮添加对应的点击事件,然后开始进行解码处理,包括对空格,单双引号等处理。

代码如下所示:

function decode () {
    try {
        var inputValue = $("#_input").val().trim();
        var reg = /^['|"](.*)['|"]/;
        var responseParams = true;
        if (inputValue.includes("helloword")) {
            inputValue = inputValue.replaceAll("helloworld", "");
            responseParams = false;
        }
        inputValue = inputValue.replace(reg, "$1");
        var output = DECODE(inputValue);
        responseParams && output.res && (output.res = JSON.parse(output.res))
        $("#_output").val(JSON.stringify(output))
    } catch (error) {
        console.log(error)
    }
}
document.addEventListener('DOMContentLoaded', () => {
    $("#_button").click(() => {
        decode()
    })
})

3、chrome 浏览器加载本项目

1、点击浏览器右上角->扩展程序->管理扩展程序,如下图所示:

2、点击右上角打开开发模式,然后单击“加载已解压的扩展程序”按钮,选择自己的项目目录即可。如下图所示:

3、点击浏览器右上角的本项目插件图标,弹出popup页面,在上面输入框中输入需要解码的内容,然后单击“解码”按钮,把对应解码的内容的输出到下面的输入框中,如下图所示:

4、插件右键菜单,鼠标在网页空白处,右键弹出菜单,可以看到自己创建的菜单以及icon,然后单击对应的菜单,浏览器将新建一个标签页面,指向自己配置的popup页面。如下如所示:

4、参考文档

其他一些配置或者示例可以参考以下文档:

chrome官方文档(英文版)

360中文开发文档

最好参考chrome 官方文档,360的文档,里面的内容并不是最新的,是manifest v2 版本,v3 和 v2 还是有一些差异的,在开发的时候注意以下manifest对应的版本。


相关文章
|
3月前
|
Web App开发 数据采集 存储
WebDriver与Chrome DevTools Protocol:如何在浏览器自动化中提升效率
本文探讨了如何利用Chrome DevTools Protocol (CDP) 与 Selenium WebDriver 提升浏览器自动化效率,结合代理IP技术高效采集微博数据。通过CDP,开发者可直接操作浏览器底层功能,如网络拦截、性能分析等,增强控制精度。示例代码展示了如何设置代理IP、cookie及user-agent来模拟真实用户行为,提高数据抓取成功率与稳定性。适用于需要频繁抓取互联网数据的应用场景。
557 3
WebDriver与Chrome DevTools Protocol:如何在浏览器自动化中提升效率
|
3月前
|
数据可视化 Java Windows
Elasticsearch入门-环境安装ES和Kibana以及ES-Head可视化插件和浏览器插件es-client
本文介绍了如何在Windows环境下安装Elasticsearch(ES)、Elasticsearch Head可视化插件和Kibana,以及如何配置ES的跨域问题,确保Kibana能够连接到ES集群,并提供了安装过程中可能遇到的问题及其解决方案。
Elasticsearch入门-环境安装ES和Kibana以及ES-Head可视化插件和浏览器插件es-client
|
1月前
|
Web App开发 缓存 安全
WIN11 Chrome 双击打不开闪退及Chrome浏览器不能拖拽文件crx
【11月更文挑战第6天】本文介绍了 WIN11 系统中 Chrome 浏览器双击打不开闪退及不能拖拽文件 crx 的原因和解决方法。包括浏览器版本过旧、扩展程序冲突、硬件加速问题、缓存过多、安全软件冲突、系统文件损坏、用户配置文件损坏等问题的解决方案,以及 crx 文件的屏蔽、权限问题和文件格式问题的处理方法。
128 2
|
1月前
|
Web App开发 Linux iOS开发
Chrome浏览器如何导出所有书签并导入书签
【11月更文挑战第4天】本文介绍了如何在 Chrome 浏览器中导出和导入书签。导出时,打开书签管理器,点击“整理”按钮选择“导出书签”,保存为 HTML 文件。导入时,同样打开书签管理器,点击“整理”按钮选择“导入书签”,选择之前导出的 HTML 文件即可。其他主流浏览器也支持导入这种格式的书签文件。
361 2
|
1月前
|
Web App开发 JavaScript 前端开发
使用 Chrome 浏览器的内存分析工具来检测 JavaScript 中的内存泄漏
【10月更文挑战第25天】利用 Chrome 浏览器的内存分析工具,可以较为准确地检测 JavaScript 中的内存泄漏问题,并帮助我们找出潜在的泄漏点,以便采取相应的解决措施。
300 9
|
2月前
|
Web App开发 开发者
|
2月前
|
Web App开发 JSON 安全
Chrome浏览器的跨域问题
【10月更文挑战第6天】
|
2月前
|
Web App开发 JSON JavaScript
vue学习:chrome 中 vuetools 开发插件 的下载、安装
这篇文章介绍了如何在Chrome浏览器中下载、安装并测试Vue.js开发插件——vue-devtools。
393 0
vue学习:chrome 中 vuetools 开发插件 的下载、安装
|
3月前
|
安全 Oracle Java
edge浏览器加载java插件
edge浏览器加载java插件
253 1
|
2月前
|
Web App开发 缓存 安全
Chrome浏览器启动参数大全
这是一组用于定制浏览器行为的命令行参数,包括但不限于:不停用过期插件、放行非安全内容、允许应用中心脚本、停用GPU加速视频、禁用桌面通知、禁用拓展及各类API、调整缓存设置、启用打印预览、隐身模式启动、设定语言、使用代理服务器、无头模式运行等。通过这些参数,用户可以根据需求灵活调整浏览器功能与性能。