百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 编程网 > 正文

超详细带你从入门开始,开发一个超实用的浏览器插件

yuyutoo 2024-12-22 21:45 1 浏览 0 评论

相信大家平时在电脑上逛掘金、知乎网站时,肯定有看到过下面超级烦人的跳转拦截确认页面

虽然这种拦截的初衷是好的,但是我相信大家平时肯定不会因为有了这个拦截提醒页面,就会对即将打开的网站安全性提高自己的警惕性,而是把它当做用户协议一样无视并点击“继续访问”。这种体验给人的感觉是十分难受的,特别是有时候看一些技术文章,文章里面会贴一些参考资料链接,有时我会习惯先右键新tab中打开,并且继续往下阅读,等看到刚打开的tab栏没有加载圈圈时(说明页面已经加载完毕),再切过去看,结果被拦截了???

上面的痛点,其实很容易解决,就是通过开发一个浏览器插件实现。

实现思路

我们先打开控制台看下这些网站跳转链接长啥样:

掘金:

知乎:

可以看到,a标签的链接里面并不是直接放置我们要跳转网站链接,而是把它放在了target参数里面。我们要做的就是通过插件,给页面添加点击监听事件,先拦截a标签的默认跳转行为,然后通过js提取到我们要跳转的链接,通过window.open或者window.localtion打开即可。

开始动手开发插件

新建manifest.json配置文件

首先我们新建个项目文件夹,命名direct-link,在里面新建manifest.json配置文件,里面存放我们插件的配置信息。内容如下:

{
  "name": "direct link", // 插件名字
  "description": "跳过网站点击跳转询问页面!", // 插件描述
  "version": "0.0.1", // 版本号
  "manifest_version": 3, // 插件版本,目前大多插件还是2, 3是目前最新规范标准
  "permissions": ["storage", "tabs", "scripting"], // 插件需要用到的权限
  "background": {
    "service_worker": "./background.js" // 对应background.js文件,相当于程序运行入口
  },
  "action": {
    "default_popup": "popup.html",
    "default_icon": {
      "16": "/images/logo16.png",
      "32": "/images/logo32.png",
      "48": "/images/logo48.png",
      "128": "/images/logo128.png"
    }
  },
  "icons": {
    "16": "/images/logo16.png",
    "32": "/images/logo32.png",
    "48": "/images/logo48.png",
    "128": "/images/logo128.png"
  }
}

新建images文件夹

新建images文件夹,里面存放插件的图标。我们可以去iconfont网站查找下载图片即可,尺寸需要下载多个,从上面配置文件可以看到一共放了16,32,48及128四个分辨率的图片。

新建background.js

在根目录下新建background.js,该文件相当于程序运行入口。创建background.js文件之后,此时准备的文件已经可以在浏览器中运行了。我们按如下图方式打开浏览器插件页面

然后将右上角的开发者模式打开

接着将direct link文件夹直接拖到当前页面即可看到插件成功安装

这里值得一提的是,上面manifest.json文件中在两处地方配置了logo信息,上图看到的插件图标对应的是icon属性,而action ->default_icon 对应的是下图中的图标显示位置:

编辑background.js

上面有提到,background.js相当于程序主入口,内容如下:

// 用户首次安装插件时执行一次,后面不会再重新执行。(除非用户重新安装插件)
chrome.runtime.onInstalled.addListener(() => {
  // 插件功能安装默认启用  
  chrome.storage.sync.set({
    linkOpen: true,
  });
});

// 监听tab页面加载状态,添加处理事件
chrome.tabs.onUpdated.addListener((tabId, changeInfo, tab) => {
  // 设置判断条件,页面加载完成才添加事件,否则会导致事件重复添加触发多次
  if (changeInfo.status === "complete" && /^http/.test(tab.url)) {
    chrome.scripting
      .executeScript({
        target: { tabId: tabId },
        files: ["./content-script.js"],
      })
      .then(() => {
        console.log("INJECTED SCRIPT SUCC.");
      })
      .catch((err) => console.log(err));
  }
});

上面的代码逻辑比较简单,插件安装初始化时,在本地存储一个变量linkOpen设为true,后面我们会新增一个选项切换是否启用插件,需要用到这个变量判断。

接着在页面初始化时,添加执行脚本代码,这个脚本代码叫content-script,里面执行我们功能代码逻辑。

编辑content-script.js

在根目录新建content-script.js,编辑内容如下:

chrome.storage.sync.get("linkOpen", ({ linkOpen }) => {
  if (linkOpen) {
    document.body.addEventListener("click", function (event) {
      const target = event.target;
      // 判断点击的是否a标签
      if (target.nodeName.toLocaleLowerCase() === "a") {
        const href = target.getAttribute("href");
        if (href.indexOf("://link") > -1) {
          // 禁止默认的跳转行为
          event.preventDefault();
          const link = href.split("target=")[1];
          const url = decodeURIComponent(link);
          // 处理完 a 标签的内容,重新触发跳转,根据原来 a 标签页 target 来判断是否需要新窗口打开
          if (target.getAttribute("target") === "_blank") {
            // 新窗口打开  
            window.open(url);
          } else {
            // 当前窗口打开  
            window.location.href = url;
          }
        }
      }
    });
  }
});

插件主逻辑如上,对应文章开头提到的实现思路。

添加是否启用插件的功能开关

在浏览器右上角插件点击时,通常会显示一个功能菜单,如下图

下面我们也添加一个类似的功能,用来是否启用插件。

新建popup.js和popup.html

popup.html对应点击时显示的内容,popup.js则是相关执行逻辑。

popup.html:

<!DOCTYPE html>
<html lang="en">
<html>
<meta charset="UTF-8">

<head>
    <style>
        .option{padding:30px 0;display:flex;align-items:center;justify-content:center;min-width:160px}.option .name{color:#333;font-size:18px;font-weight:bold}.switch{position:relative;display:inline-block;width:60px;height:34px}.switch input{opacity:0;width:0;height:0}.slider{position:absolute;cursor:pointer;top:0;left:0;right:0;bottom:0;background-color:#ccc;-webkit-transition:.4s;transition:.4s}.slider:before{position:absolute;content:"";height:26px;width:26px;left:4px;bottom:4px;background-color:white;-webkit-transition:.4s;transition:.4s}input:checked+.slider{background-color:#45c7d8}input:focus+.slider{box-shadow:0 0 1px #45c7d8}input:checked+.slider:before{-webkit-transform:translateX(26px);-ms-transform:translateX(26px);transform:translateX(26px)}.slider.round{border-radius:34px}.slider.round:before{border-radius:50%}
    </style>
</head>

<body>
    <div class="option">
        <span class="name">开启:</span>
        <label class="switch">
            <input type="checkbox" id="switch">
            <span class="slider round"></span>
        </label>
    </div>

    <script src="popup.js"></script>
</body>

</html>

显示效果如下:

popup.js

const btn = document.querySelector("#switch");

chrome.storage.sync.get("linkOpen", ({ linkOpen }) => {
  btn.checked = linkOpen;
});

btn.addEventListener("change", () => {
  if (btn.checked) {
    chrome.storage.sync.set({ linkOpen: true });
  } else {
    chrome.storage.sync.set({ linkOpen: false });
  }
  // 获取当前tab窗口
  chrome.tabs.query({ active: true, currentWindow: true }, function (tabs) {
    chrome.scripting.executeScript({
      target: { tabId: tabs[0].id },
      func: refreshPage,
    });
  });
});

// 刷新页面
function refreshPage() {
  window.location.reload();
}

上面的逻辑也很简单,就是监听swich按钮,更新本地存储变量,并且每次修改时刷新下页面触发content-script里面的逻辑

至此,我们的一个插件就开发完成了。

值得注意的事

开发调试踩坑

  1. 每次修改代码后,我们需要点击如下图的刷新按钮,并且重新刷新页面,否则可能出现代码没更新触发的情况
  1. 如果出现报错信息,更新代码后重新点击刷新按钮,错误可能依然还在

点击“错误”按钮

然后点击右上角的全部清除,再重新刷新即可

  1. background.js文件代码中的console.log不会在控制台显示

我们在background.js文件中添加的打印代码是不会在浏览器的控制台打印出来的,因为它有个单独的控制台显示。入口如下图:

点击service worker会出现一个单独的调试窗口,background.js里面添加打印代码会在这个窗口的控制台中显示打印信息。

插件访问页面权限问题

如果你有按照上面内容一步步实现的话,将鼠标移动到浏览器右上角插件图标,你会发现如下图所示:

也就是说目前其实你的插件没有访问网站内容的权限,此时你需要手动点击该插件图标才能成功获得访问网站的权限。那要如何配置默认获得访问所有网站的权限呢?经过漫长的查找,发现是需要在manifest.json文件中添加这么一个属性

"host_permissions": ["https://*/*"]

添加该属性之后,右键点击图标,可以看到默认可读取更改属性是所有网站上

发布到chrome应用商店

发布插件到应用商店需要注册开发者身份,如下图所示

额,需要5美元注册费,本文结束。(感兴趣的可以自己花钱注册提交试试,哈哈)

相关推荐

GitHub精选 | 基于go开发的定时任务管理系统

《GitHub精选》是我们分享Github中优质项目的栏目,包括技术、学习、实用与各种有趣的内容。本期推荐的是gocron-定时任务管理系统之前有过一期...

linux定时任务,让你更深入的了解系统

cron的软件包cronierpm-qlcronierpm–qlcrontabs最关键的是一个叫做crontab的命令,我们要书写的非系统定时任务就是通过此程序来编写的;要保证crond.se...

linux定时任务详解 linux定时任务执行

配置方式:(记忆口诀:分、时、日、月、星)#Fordetailsseeman4crontabs#Exampleofjobdefinition:#.---------------...

我终于会写 Java 的定时任务了 java定时任务指定时间执行

前言学过定时任务,但是我忘了,忘得一干二净,害怕,一直听别人说:...

如何用Windows计划任务设置:定时关机

定时关机其实是一个小功能,很多时候还真的需要它。你在网上找还真不是那么好找,下面我们用Windows计划任务设置:定时关机,而且,我还在计划任务中看到了几个不该有的计划任务。?打开:计划任务点击Co...

定时任务优化总结(从半个小时优化到秒级)

整体优化思路:1.按需查询、2.分小批次游标查询、3.JED场景下按数据库分片分组更新、4.精准定位要处理的数据、5.负载均衡业务背景:...

信创终端操作系统上定时任务crontab详解 | 统信 | 麒麟 | 中科方德

原文链接:信创终端操作系统上定时任务crontab详解|统信|麒麟|中科方德...

VIVO手机定时任务功能_定时开关机、定时振动模式

手机在生活中是必不可少的,有些功能我们想要他定时切换变更,本文就来分享一下Vivo手机的定时任务功能。Vivo手机如何进入定时任务界面...

下班总是忘记关电脑!添加任务自动定时关机,不用再跑一趟!

我们每个人都有过这样的经历,下班后、或者出差,单位里的电脑总是忘记关机!很是烦恼!经常忘关电脑的话,一是费电,二是不安全,会给网络攻击留有足够的时间,会导致信息泄露,存在安全隐患。其实只要我们在电脑...

为什么定时任务到时间不执行?带你深入源码找答案

前言早上研发经理给我分配了一个开发任务:每5秒统计一次APP在线人数,并问我啥时能上线?我心想这需求用Spring的定时任务完美解决啊!作为一个萌新正好借此机会在经理面前表现一番,于是我拍着胸脯跟经理...

我来总结下 几种定时任务的执行方式

首先带入我们的业务场景:我们买火车票或者叫外卖的时候,下完单之后会跳转到支付页面,页面会有一个计时器,要求在指定时间内完成支付,否则订单自动取消。这是延时任务的一个典型场景,分析这个场景,就是如何在订...

聊聊定时任务的六种模式 定时任务详解

这篇文章,我们聊聊实现定时任务的六种策略。1自定义单线程上图中,我们启动一个线程,该线程无限循环执行,每隔20毫秒执行业务代码。...

windows如何实现定时任务?配合脚本使用结局很满意

序言:作为一名程序员,通过定时任务去实现各种所需的功能是必须要掌握的,本文来讲解一下在windows服务器上如何创建定时任务。有需要的小伙伴赶紧收藏转发吧。第一步:打开控制面板-》系统和安全-》管理工...

电脑(计算机)如何定时执行任务 电脑定时器怎么定时

电脑想定时执行程序,任务计划步骤如下:1,系统服务里,确保"TaskScheduler"服务启动。2,在控制面板->系统和安全里,找到任务计划,并点击:  或在“管理工具”里点...

分布式定时任务最全详解(图文全面总结)

分布式定时任务是非常核心的分布式系统,下面我就全面来详解分布式定时任务以及分布式定时任务框架@mikechen本篇已收于mikechen原创超30万字《阿里架构师进阶专题合集》里面。什么是分布式定时任...

取消回复欢迎 发表评论: