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

打靜爵發表於2021-08-27

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

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

至此，我們的一個外掛就開發完成了。