摘要： 技術債清理流程指南。

• 原文：Removing jQuery from GitHub.com frontend
• 譯文：GitHub：我們為什麼會棄用jQuery？
• 作者：GitHub 前端工程團隊
• 譯者：無明
• 編輯：覃雲

最近，我們將jQuery 完全從 GitHub.com 的前端程式碼中移除了，這標誌著我們數年來逐步移除 jQuery這個漸進式的過程終於結束了，這對我們來說是一件里程碑式的事件。這篇文章將介紹過去我們是如何依賴上jQuery的，隨著時間地推移，我們意識到不再需要它，但到最後我們並沒有使用另一個庫或框架取代它，而是使用標準的瀏覽器API實現了我們所需要的一切。

早期，jQuery對我們意義重大

GitHub.com在2007年底開始使用jQuery 1.2.1，那是谷歌釋出 Chrome 瀏覽器的前一年。當時還沒有通過CSS選擇器來查詢DOM元素的標準方法，也沒有動態渲染元素的樣式的標準方法，而Internet Explorer的XMLHttpRequest介面與其他很多API一樣，在瀏覽器之間存在不一致性問題。

jQuery讓DOM操作、建立動畫和“AJAX”請求變得相當簡單，基本上，它讓Web開發人員能夠建立更加現代化的動態Web體驗。最重要的是，使用jQuery為一個瀏覽器開發的程式碼也適用於其他瀏覽器。在GitHub的早期階段，jQuery讓小型的開發團隊能夠快速進行原型設計並開發出新功能，而無需專門針對每個Web瀏覽器調整程式碼。

基於jQuery簡單的介面所構建的擴充套件庫也成為GitHub.com前端的基礎構建塊：pjax和facebox。

我們將永遠不會忘記John Resig和jQuery貢獻者建立和維護的這樣一個有用的基本庫。

後來的Web標準

多年來，GitHub成長為一家擁有數百名工程師的公司，並逐漸成立了一個專門的團隊，負責 JavaScript程式碼的規模和質量。我們一直在排除技術債務，有時技術債務會隨著依賴項的增多而增長，這些依賴項在一開始會為我們帶來一定的價值，但這些價值也隨著時間的推移而下降。

我們可以將jQuery與現代瀏覽器支援的Web標準的快速演化進行比較：

• $(selector)模式可以使用querySelectorAll()來替換；
• 現在可以使用Element.classList來實現CSS類名切換；
• CSS現在支援在樣式表中而不是在JavaScript中定義可視動畫；
• 現在可以使用Fetch Standard執行$.ajax請求；
• addEventListener()介面已經足夠穩定，可以跨平臺使用；
• 我們可以使用輕量級的庫來封裝事件委託模式；
• 隨著JavaScript語言的發展，jQuery提供的一些語法糖已經變得多餘。

另外，鏈式語法不能滿足我們想要的編寫程式碼的方式。例如：

$('.js-widget')
  .addClass('is-loading')
  .show()

這種語法寫起來很簡單，但是根據我們的標準，它並不能很好地傳達我們的意圖。作者是否期望在當前頁面上有一個或多個js-widget元素？另外，如果我們更新頁面標記並意外遺漏了js-widget類名，瀏覽器是否會丟擲異常會告訴我們出了什麼問題？預設情況下，當沒有任何內容與選擇器匹配時，jQuery會跳過整個表示式，但對我們來說，這是一個bug。

最後，我們開始使用Flow來註解型別，以便在構建時執行靜態型別檢查，並且我們發現，鏈式語法不適合做靜態分析，因為幾乎所有jQuery方法返回的結果都是相同的型別。我們當時之所以選擇Flow，是因為@flow weak模式等功能可以讓我們逐步將型別應用於無型別的程式碼庫上。

總而言之，移除jQuery意味著我們可以更多地依賴Web標準，讓MDN Web文件成為前端開發人員事實上的預設文件，在將來可以維護更具彈性的程式碼，並且可以將30KB的依賴從我們的捆綁包中移除，加快頁面的載入速度和JavaScript的執行速度。

逐步解耦

雖然定下了最終目標，但我們也知道，分配所有資源一次性移除 jQuery 是不可行的。這種匆匆忙忙的做法可能會導致網站功能出現迴歸。相反，我們採取了以下的策略：

• 設定指標，跟蹤整一行程式碼呼叫jQuery的比率，並監控指標走勢隨時間變化的情況，確保它保持不變或下降，而不是上升。

• 我們不鼓勵在任何新程式碼中匯入jQuery。為了方便自動化，我們建立了eslint-plugin-jquery，如果有人試圖使用jQuery功能，例如 $.ajax，CI檢查將會失敗。

• 舊程式碼中存在大量違反eslint規則的情況，我們在程式碼註釋中使用特定的eslint-disable 規則進行了註解。看到這些程式碼的讀者，他們都該知道，這些程式碼不符合我們當前的編碼實踐。

• 我們建立了一個拉請求機器人，當有人試圖新增新的eslint-disable規則時，會對拉取請求留下評論。這樣我們就可以儘早參與程式碼評審，並提出替代方案。

• 很多舊程式碼使用了pjax和facebox外掛，所以我們在保持它們的介面幾乎不變的同時，在內部使用JS重新實現它們的邏輯。靜態型別檢查有助於提升我們進行重構的信心。

• 很多舊程式碼與rails-behavior發生互動，我們的Ruby on Rails介面卡幾乎是“不顯眼的”JS，它們將 AJAX 生命週期處理器附加到某些表單上：

// 舊方法
  $(document).on('ajaxSuccess', 'form.js-widget', function(event, xhr, settings, data) {
    // 將響應資料插入到 DOM 中
  })

• 我們選擇觸發假的ajax*生命週期事件，並保持這些表單像以前一樣非同步提交內容，而不是立即重寫所有呼叫，只是會在內部使用fetch()。

• 我們自己維護了jQuery的一個版本，每當發現我們不再需要jQuery的某個模組的時候，就會將它從自定義版本中刪除，併發布更輕量的版本。例如，在移除了jQuery的CSS偽選擇器之後（如:visible 或:checkbox）我們就可以移除Sizzle模組了，當所有的$.ajax呼叫都被 fetch()替換時，就可以移除AJAX模組。這樣做有兩個目的：加快JavaScript執行速度，同時確保不會有新程式碼試圖使用已移除的功能。

• 我們根據網站的分析結果儘快放棄對舊版本Internet Explorer的支援。每當某個 IE 版本的使用率低於某個閾值時，我們就會停止向它提供JavaScript支援，並專注支援更現代的瀏覽器。儘早放棄對IE 8和IE 9的支援對於我們來說意味著可以採用很多原生的瀏覽器功能，否則的話有些功能很難通過polyfill來實現。

• 作為GitHub.com前端功能開發新方法的一部分，我們專注於盡可能多地使用常規HTML，並且逐步新增JavaScript行為作為漸進式增強。因此，那些使用JS增強的Web表單和其他UI元素通常也可以在禁用JavaScript的瀏覽器上正常執行。在某些情況下，我們可以完全刪除某些遺留的程式碼，而不需要使用JS重寫它們。

經過多年的努力，我們逐漸減少對jQuery的依賴，直到沒有一行程式碼引用它為止。

自定義元素

近年來一直在炒作一項新技術，即自定義元素——瀏覽器原生的元件庫，這意味著使用者無需下載、解析和編譯額外的位元組。

從 2014 年開始，我們已經基於 v0 規範建立了一些自定義元素。然而，由於標準仍然在不斷變化，我們並沒有投入太多精力。直到 2017 年，Web Components v1 規範釋出，並且 Chrome 和 Safari 實現了這一規範，我們才開始更廣泛地採用自定義元素。

在移除 jQuery 期間，我們也在尋找用於提取自定義元素的模式。例如，我們將用於顯示模態對話方塊的 facebox 轉換為<details-dialog>元素（https://github.com/github/details-dialog-element）。

我們的漸進式增強理念也延伸到了自定義元素上。這意味著我們將盡可能多地保留標記內容，然後再標記上新增行為。例如，<local-time>預設顯示原始時間戳，它被升級成可以將時間轉換為本地時區，而對於<details-dialog>，當它被嵌在 \<details\>元素中時，可以在不使用 JavaScript 的情況下具備互動性，它被升級成具有輔助增強功能。

以下是實現<local-time>自定義元素的示例：

// local-time 根據使用者的當前時區顯示時間。
//
// 例如:
//   <local-time datetime="2018-09-06T08:22:49Z">Sep 6, 2018</local-time>
//
class LocalTimeElement extends HTMLElement {
  static get observedAttributes() {
    return ['datetime']
  }

  attributeChangedCallback(attrName, oldValue, newValue) {
    if (attrName === 'datetime') {
      const date = new Date(newValue)
      this.textContent = date.toLocaleString()
    }
  }
}

if (!window.customElements.get('local-time')) {
  window.LocalTimeElement = LocalTimeElement
  window.customElements.define('local-time', LocalTimeElement)
}

我們很期待 Web 元件的 Shadow DOM。Shadow DOM 的強大功能為 Web 帶來了很多可能性，但也讓 polyfill 變得更加困難。因為使用 polyfill 會導致效能損失，因此在生產環境中使用它們是不可行的。

參考

• 為啥jQuery被淘汰了？

關於Fundebug

Fundebug專注於JavaScript、微信小程式、微信小遊戲、支付寶小程式、React Native、Node.js和Java實時BUG監控。 自從2016年雙十一正式上線，Fundebug累計處理了7億+錯誤事件，得到了Google、360、金山軟體、百姓網等眾多知名使用者的認可。歡迎免費試用！

版權宣告

轉載時請註明作者Fundebug以及本文地址：
https://blog.fundebug.com/2018/11/23/removing-jquery-from-github-frontend/