超詳細帶你入門開發一個超實用的瀏覽器插件

本文轉載自查看原文 2021-08-27 18:24 555

相信大家平時在電腦上逛掘金、知乎網站時，肯定有看到過下面超級煩人的跳轉攔截確認頁面

雖然這種攔截的初衷是好的，但是我相信大家平時肯定不會因為有了這個攔截提醒頁面，就會對即將打開的網站安全性提高自己的警惕性，而是把它當做用戶協議一樣無視並點擊“繼續訪問”。這種體驗給人的感覺是十分難受的，特別是有時候看一些技術文章，文章里面會貼一些參考資料鏈接，有時我會習慣先右鍵新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里面的邏輯

至此，我們的一個插件就開發完成了。