DIV CSS 佈局教程網

Firefox Jetpack 擴充實作:打造 Gmail 郵件提醒
編輯:關於JavaScript     

Gtalk 最下方有個很實用的小功能:定時檢查 Gmail 未讀郵件數量並顯示出來。如果我們把這個功能移植到 Firefox 上會怎樣?Jetpack 讓這件事變得意外簡單——不必走完整的擴充套件開發流程,寫幾十行 JavaScript 就能做出來。

Firefox 的 Jetpack 擴充案例分析:Gmail 郵件提醒

第一步:在狀態列顯示圖示與數字

用 jetpack.statusBar.append() 就能往狀態列插入一段 HTML:

jetpack.statusBar.append({
  html: '<img src="https://mail.google.com/mail/images/favicon.ico"/><span id="count"></span>',
  width: 55,
  onReady: function(widget) {
    $("#count", widget).css({
      cursor: "pointer",
      paddingLeft: "4px",
      fontFamily: "Tahoma, Arial, sans-serif",
      verticalAlign: "top",
      fontSize: "10px",
      lineHeight: "18px"
    });
  }
});

這裡有個值得注意的細節:$("#count", widget) 的第二個參數把查詢範圍限定在這個 widget 裡,而不是整個文件。Jetpack 允許你掛多個 status bar 元件,若不限定範圍,id 選擇器就會撞在一起。

第二步:取得 Gmail 資料

Gmail 提供了一個需登入才能存取的 Atom feed:

https://mail.google.com/mail/feed/atom

feed 原始碼中的 fullcount 標籤,就是目前的未讀郵件數。資料來源有了,接著用最熟悉的 Ajax 把它抓回來:

function update(widget) {
  $.get("https://mail.google.com/mail/feed/atom", function(xml) {
    var el = $(xml).find("fullcount");   // 記錄未讀郵件數的節點
    if (el.length) {
      var newcount = parseInt(el.get(0).textContent);
      widget.find("#count").text(newcount);
    } else {
      // 未登入時顯示 Login
      widget.find("#count").text("Login");
    }
  });
}

加上通知提示

可以再進一步:當未讀數增加時,跳出一則通知並告知寄件者。這裡用 jetpack.notifications.show(),它接受 title、icon、body 三個屬性。

function update(widget) {
  var widget = $(widget),
      notify = function(msg) {
        jetpack.notifications.show({
          title: "Gmail",
          body: msg,
          icon: "https://mail.google.com/mail/images/favicon.ico"
        });
      };

  $.get("https://mail.google.com/mail/feed/atom", function(xml) {
    var el = $(xml).find("fullcount");

    if (el.length) {
      var newcount = parseInt(el.get(0).textContent);

      if (newcount > count) {
        // 未讀數增加,提示來自誰
        var sender = $(xml).find("name").get(0).textContent;
        notify("New message from " + sender);
      }

      count = newcount;
      widget.find("#count").text(count);
    } else {
      widget.find("#count").text("Login");
      notify("Please login to Gmail");
    }
  });
}

第三步:定時更新

每分鐘抓一次,夠即時又不會太囂張:

setInterval(function() { update(widget) }, 60 * 1000);

第四步:點擊後開啟 Gmail

$(widget).click(function() {
  jetpack.tabs.open("https://mail.google.com");
  jetpack.tabs[ jetpack.tabs.length - 1 ].focus();
});

jetpack.tabs 是瀏覽器分頁的集合,open(url) 開啟新分頁,focus() 把它切為當前分頁。

完整程式碼

var count = 0;

function update(widget) {
  var widget = $(widget),
      notify = function(msg) {
        jetpack.notifications.show({
          title: "Gmail",
          body: msg,
          icon: "https://mail.google.com/mail/images/favicon.ico"
        });
      };

  $.get("https://mail.google.com/mail/feed/atom", function(xml) {
    var el = $(xml).find("fullcount");

    if (el.length) {
      var newcount = parseInt(el.get(0).textContent);

      if (newcount > count) {
        var sender = $(xml).find("name").get(0).textContent;
        notify("New message from " + sender);
      }

      count = newcount;
      widget.find("#count").text(count);
    } else {
      widget.find("#count").text("Login");
      notify("Please login to Gmail");
    }
  });
}

jetpack.statusBar.append({
  html: '<img src="https://mail.google.com/mail/images/favicon.ico"/><span id="count"></span>',
  width: 40,   // 預留三位數的寬度
  onReady: function(widget) {
    $("#count", widget).css({
      cursor: "pointer",
      paddingLeft: "4px",
      fontFamily: "Tahoma, Arial, sans-serif",
      verticalAlign: "top",
      fontSize: "10px",
      lineHeight: "18px"
    });

    $(widget).click(function() {
      jetpack.tabs.open("https://mail.google.com");
      jetpack.tabs[ jetpack.tabs.length - 1 ].focus();
    });

    update(widget);
    setInterval(function() { update(widget) }, 60 * 1000);
  }
});

幾個可以再加強的地方

這個範例能跑,但仍有明顯的改進空間:

  • 輪詢間隔:一分鐘一次對 Gmail 伺服器來說偏頻繁。可改為只在視窗重新聚焦時才抓一次,並加上指數退避。
  • 錯誤處理:$.get 沒有失敗回呼。網路斷線時,使用者只會看到數字停在舊值,不會知道出了問題。
  • 安全性:以 GET 抓取需要登入的 feed,本質上依賴瀏覽器既有的 session cookie。這個做法能用,但並非官方支援的介面,Google 隨時可能調整。

後記

Jetpack 是 Mozilla Labs 在 2009 年前後推出的實驗性專案,目標是讓擴充套件的開發門檻降到「會寫網頁就能做」。這個構想後來演化為 Add-on SDK,最終在 WebExtensions 標準中落地——今日的 Firefox、Chrome、Edge 擴充套件都採用同一套 API(background script、content script、permissions 宣告)。

所以如果你今天想實作同樣的功能,路徑是:用 manifest.json 宣告權限與 popup,在 background service worker 中定時 fetch,再用 alarms API 取代 setInterval。核心邏輯幾乎不變,只是 API 換了名字。

測試 Demo:
https://www.planabc.net/lab/jetpack/gmail/

Jetpack 的詳細 API 可參考 about:jetpack 頁面的 API Reference 章節。
案例原始碼:
https://jetpack.mozillalabs.com/demos/gmail-checker.js

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved