超詳細(xì)帶你入門開發(fā)一個(gè)超實(shí)用的瀏覽器插件

相信大家平時(shí)在電腦上逛掘金驳概、知乎網(wǎng)站時(shí),肯定有看到過(guò)下面超級(jí)煩人的跳轉(zhuǎn)攔截確認(rèn)頁(yè)面

雖然這種攔截的初衷是好的齐邦,但是我相信大家平時(shí)肯定不會(huì)因?yàn)橛辛诉@個(gè)攔截提醒頁(yè)面炕吸,就會(huì)對(duì)即將打開的網(wǎng)站安全性提高自己的警惕性,而是把它當(dāng)做用戶協(xié)議一樣無(wú)視并點(diǎn)擊“繼續(xù)訪問”背亥。這種體驗(yàn)給人的感覺是十分難受的秒际,特別是有時(shí)候看一些技術(shù)文章,文章里面會(huì)貼一些參考資料鏈接狡汉,有時(shí)我會(huì)習(xí)慣先右鍵新tab中打開娄徊,并且繼續(xù)往下閱讀,等看到剛打開的tab欄沒有加載圈圈時(shí)(說(shuō)明頁(yè)面已經(jīng)加載完畢)盾戴,再切過(guò)去看寄锐,結(jié)果被攔截了?尖啡?橄仆?

上面的痛點(diǎn),其實(shí)很容易解決衅斩,就是通過(guò)開發(fā)一個(gè)瀏覽器插件實(shí)現(xiàn)盆顾。

實(shí)現(xiàn)思路

我們先打開控制臺(tái)看下這些網(wǎng)站跳轉(zhuǎn)鏈接長(zhǎng)啥樣:

掘金:

知乎:

可以看到,a標(biāo)簽的鏈接里面并不是直接放置我們要跳轉(zhuǎn)網(wǎng)站鏈接畏梆,而是把它放在了target參數(shù)里面您宪。我們要做的就是通過(guò)插件,給頁(yè)面添加點(diǎn)擊監(jiān)聽事件奠涌,先攔截a標(biāo)簽的默認(rèn)跳轉(zhuǎn)行為宪巨,然后通過(guò)js提取到我們要跳轉(zhuǎn)的鏈接,通過(guò)window.open或者window.localtion打開即可溜畅。

開始動(dòng)手開發(fā)插件

新建manifest.json配置文件

首先我們新建個(gè)項(xiàng)目文件夾捏卓,命名direct-link,在里面新建manifest.json配置文件达皿,里面存放我們插件的配置信息天吓。內(nèi)容如下:

{
  "name": "direct link", // 插件名字
  "description": "跳過(guò)網(wǎng)站點(diǎn)擊跳轉(zhuǎn)詢問頁(yè)面!", // 插件描述
  "version": "0.0.1", // 版本號(hào)
  "manifest_version": 3, // 插件版本贿肩,目前大多插件還是2, 3是目前最新規(guī)范標(biāo)準(zhǔn)
  "permissions": ["storage", "tabs", "scripting"], // 插件需要用到的權(quán)限
  "background": {
    "service_worker": "./background.js" // 對(duì)應(yīng)background.js文件峦椰,相當(dāng)于程序運(yùn)行入口
  },
  "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文件夾,里面存放插件的圖標(biāo)汰规。我們可以去iconfont網(wǎng)站查找下載圖片即可汤功,尺寸需要下載多個(gè),從上面配置文件可以看到一共放了16,32,48及128四個(gè)分辨率的圖片溜哮。

新建background.js

在根目錄下新建background.js滔金,該文件相當(dāng)于程序運(yùn)行入口色解。創(chuàng)建background.js文件之后,此時(shí)準(zhǔn)備的文件已經(jīng)可以在瀏覽器中運(yùn)行了餐茵。我們按如下圖方式打開瀏覽器插件頁(yè)面

然后將右上角的開發(fā)者模式打開

接著將direct link文件夾直接拖到當(dāng)前頁(yè)面即可看到插件成功安裝

這里值得一提的是科阎,上面manifest.json文件中在兩處地方配置了logo信息,上圖看到的插件圖標(biāo)對(duì)應(yīng)的是icon屬性忿族,而action ->default_icon 對(duì)應(yīng)的是下圖中的圖標(biāo)顯示位置:

編輯background.js

上面有提到锣笨,background.js相當(dāng)于程序主入口,內(nèi)容如下:

// 用戶首次安裝插件時(shí)執(zhí)行一次道批,后面不會(huì)再重新執(zhí)行错英。(除非用戶重新安裝插件)
chrome.runtime.onInstalled.addListener(() => {
  // 插件功能安裝默認(rèn)啟用  
  chrome.storage.sync.set({
    linkOpen: true,
  });
});

// 監(jiān)聽tab頁(yè)面加載狀態(tài),添加處理事件
chrome.tabs.onUpdated.addListener((tabId, changeInfo, tab) => {
  // 設(shè)置判斷條件隆豹,頁(yè)面加載完成才添加事件椭岩,否則會(huì)導(dǎo)致事件重復(fù)添加觸發(fā)多次
  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));
  }
});

上面的代碼邏輯比較簡(jiǎn)單,插件安裝初始化時(shí)璃赡,在本地存儲(chǔ)一個(gè)變量linkOpen設(shè)為true判哥,后面我們會(huì)新增一個(gè)選項(xiàng)切換是否啟用插件,需要用到這個(gè)變量判斷碉考。

接著在頁(yè)面初始化時(shí)姨伟,添加執(zhí)行腳本代碼,這個(gè)腳本代碼叫content-script豆励,里面執(zhí)行我們功能代碼邏輯夺荒。

編輯content-script.js

在根目錄新建content-script.js,編輯內(nèi)容如下:

chrome.storage.sync.get("linkOpen", ({ linkOpen }) => {
  if (linkOpen) {
    document.body.addEventListener("click", function (event) {
      const target = event.target;
      // 判斷點(diǎn)擊的是否a標(biāo)簽
      if (target.nodeName.toLocaleLowerCase() === "a") {
        const href = target.getAttribute("href");
        if (href.indexOf("://link") > -1) {
          // 禁止默認(rèn)的跳轉(zhuǎn)行為
          event.preventDefault();
          const link = href.split("target=")[1];
          const url = decodeURIComponent(link);
          // 處理完 a 標(biāo)簽的內(nèi)容良蒸,重新觸發(fā)跳轉(zhuǎn)技扼,根據(jù)原來(lái) a 標(biāo)簽頁(yè) target 來(lái)判斷是否需要新窗口打開
          if (target.getAttribute("target") === "_blank") {
            // 新窗口打開  
            window.open(url);
          } else {
            // 當(dāng)前窗口打開  
            window.location.href = url;
          }
        }
      }
    });
  }
});

插件主邏輯如上,對(duì)應(yīng)文章開頭提到的實(shí)現(xiàn)思路嫩痰。

添加是否啟用插件的功能開關(guān)

在瀏覽器右上角插件點(diǎn)擊時(shí)剿吻,通常會(huì)顯示一個(gè)功能菜單,如下圖

下面我們也添加一個(gè)類似的功能串纺,用來(lái)是否啟用插件丽旅。

新建popup.js和popup.html

popup.html對(duì)應(yīng)點(diǎn)擊時(shí)顯示的內(nèi)容,popup.js則是相關(guān)執(zhí)行邏輯纺棺。

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 });
  }
  // 獲取當(dāng)前tab窗口
  chrome.tabs.query({ active: true, currentWindow: true }, function (tabs) {
    chrome.scripting.executeScript({
      target: { tabId: tabs[0].id },
      func: refreshPage,
    });
  });
});

// 刷新頁(yè)面
function refreshPage() {
  window.location.reload();
}

上面的邏輯也很簡(jiǎn)單榄笙,就是監(jiān)聽swich按鈕,更新本地存儲(chǔ)變量祷蝌,并且每次修改時(shí)刷新下頁(yè)面觸發(fā)content-script里面的邏輯

至此茅撞,我們的一個(gè)插件就開發(fā)完成了。

值得注意的事

開發(fā)調(diào)試踩坑

  1. 每次修改代碼后,我們需要點(diǎn)擊如下圖的刷新按鈕米丘,并且重新刷新頁(yè)面剑令,否則可能出現(xiàn)代碼沒更新觸發(fā)的情況
  1. 如果出現(xiàn)報(bào)錯(cuò)信息,更新代碼后重新點(diǎn)擊刷新按鈕拄查,錯(cuò)誤可能依然還在

點(diǎn)擊“錯(cuò)誤”按鈕

然后點(diǎn)擊右上角的全部清除吁津,再重新刷新即可

  1. background.js文件代碼中的console.log不會(huì)在控制臺(tái)顯示

我們?cè)赽ackground.js文件中添加的打印代碼是不會(huì)在瀏覽器的控制臺(tái)打印出來(lái)的,因?yàn)樗袀€(gè)單獨(dú)的控制臺(tái)顯示堕扶。入口如下圖:

點(diǎn)擊service worker會(huì)出現(xiàn)一個(gè)單獨(dú)的調(diào)試窗口腺毫,background.js里面添加打印代碼會(huì)在這個(gè)窗口的控制臺(tái)中顯示打印信息。

插件訪問頁(yè)面權(quán)限問題

如果你有按照上面內(nèi)容一步步實(shí)現(xiàn)的話挣柬,將鼠標(biāo)移動(dòng)到瀏覽器右上角插件圖標(biāo)潮酒,你會(huì)發(fā)現(xiàn)如下圖所示:

也就是說(shuō)目前其實(shí)你的插件沒有訪問網(wǎng)站內(nèi)容的權(quán)限,此時(shí)你需要手動(dòng)點(diǎn)擊該插件圖標(biāo)才能成功獲得訪問網(wǎng)站的權(quán)限邪蛔。那要如何配置默認(rèn)獲得訪問所有網(wǎng)站的權(quán)限呢急黎?經(jīng)過(guò)漫長(zhǎng)的查找,發(fā)現(xiàn)是需要在manifest.json文件中添加這么一個(gè)屬性

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

添加該屬性之后侧到,右鍵點(diǎn)擊圖標(biāo)勃教,可以看到默認(rèn)可讀取更改屬性是所有網(wǎng)站上

發(fā)布到chrome應(yīng)用商店

發(fā)布插件到應(yīng)用商店需要注冊(cè)開發(fā)者身份,如下圖所示

額匠抗,需要5美元注冊(cè)費(fèi)故源,本文結(jié)束。(感興趣的可以自己花錢注冊(cè)提交試試汞贸,哈哈)

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末绳军,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子矢腻,更是在濱河造成了極大的恐慌门驾,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,284評(píng)論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件多柑,死亡現(xiàn)場(chǎng)離奇詭異奶是,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)竣灌,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,115評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門聂沙,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人初嘹,你說(shuō)我怎么就攤上這事及汉。” “怎么了削樊?”我有些...
    開封第一講書人閱讀 164,614評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵豁生,是天一觀的道長(zhǎng)兔毒。 經(jīng)常有香客問我漫贞,道長(zhǎng)甸箱,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,671評(píng)論 1 293
  • 正文 為了忘掉前任迅脐,我火速辦了婚禮芍殖,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘谴蔑。我一直安慰自己豌骏,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,699評(píng)論 6 392
  • 文/花漫 我一把揭開白布隐锭。 她就那樣靜靜地躺著窃躲,像睡著了一般。 火紅的嫁衣襯著肌膚如雪钦睡。 梳的紋絲不亂的頭發(fā)上蒂窒,一...
    開封第一講書人閱讀 51,562評(píng)論 1 305
  • 那天,我揣著相機(jī)與錄音荞怒,去河邊找鬼洒琢。 笑死,一個(gè)胖子當(dāng)著我的面吹牛褐桌,可吹牛的內(nèi)容都是我干的衰抑。 我是一名探鬼主播,決...
    沈念sama閱讀 40,309評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼荧嵌,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼呛踊!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起啦撮,我...
    開封第一講書人閱讀 39,223評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤恋技,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后逻族,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體蜻底,經(jīng)...
    沈念sama閱讀 45,668評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,859評(píng)論 3 336
  • 正文 我和宋清朗相戀三年聘鳞,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了薄辅。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,981評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡抠璃,死狀恐怖站楚,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情搏嗡,我是刑警寧澤窿春,帶...
    沈念sama閱讀 35,705評(píng)論 5 347
  • 正文 年R本政府宣布拉一,位于F島的核電站,受9級(jí)特大地震影響旧乞,放射性物質(zhì)發(fā)生泄漏蔚润。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,310評(píng)論 3 330
  • 文/蒙蒙 一尺栖、第九天 我趴在偏房一處隱蔽的房頂上張望嫡纠。 院中可真熱鬧,春花似錦延赌、人聲如沸除盏。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,904評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)者蠕。三九已至,卻和暖如春掐松,著一層夾襖步出監(jiān)牢的瞬間踱侣,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,023評(píng)論 1 270
  • 我被黑心中介騙來(lái)泰國(guó)打工甩栈, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留泻仙,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,146評(píng)論 3 370
  • 正文 我出身青樓量没,卻偏偏與公主長(zhǎng)得像玉转,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子殴蹄,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,933評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容