讀Zepto原始碼之神奇的$

對角發表於2017-05-14
原始碼

經過前面三章的鋪墊，這篇終於寫到了戲肉。在用 zepto 時，肯定離不開這個神奇的 $ 符號，這篇文章將會看看 zepto 是如何實現 $ 的。

讀Zepto原始碼系列文章已經放到了github上，歡迎star: reading-zepto

原始碼版本

本文閱讀的原始碼為 zepto1.2.0

zepto的css選擇器 zepto.qsa

我們都知道，很多時候，我們都用$ 來獲取DOM物件，這跟 zepto.qsa 有很大的關係。

原始碼

zepto.qsa = function(element, selector) {
        var found,  // 已經找的到DOM
            maybeID = selector[0] == '#',  // 是否為ID
            maybeClass = !maybeID && selector[0] == '.', // 是否為class
            nameOnly = maybeID || maybeClass ? selector.slice(1) : selector,  // 將id或class前面的符號去掉
            isSimple = simpleSelectorRE.test(nameOnly)  // 是否為單個選擇器
        return (element.getElementById && isSimple && maybeID) ? 
            ((found = element.getElementById(nameOnly)) ? [found] : []) :
            (element.nodeType !== 1 && element.nodeType !== 9 && element.nodeType !== 11) ? [] :
            slice.call(
                isSimple && !maybeID && element.getElementsByClassName ? 
                maybeClass ? element.getElementsByClassName(nameOnly) : 
                element.getElementsByTagName(selector) : 
                element.querySelectorAll(selector) 
            )
    }
複製程式碼

以上是 qsa 的所有程式碼，裡面有用到一個正規表示式 simpleSelectorRE，先將這個正則消化下。

simpleSelectorRE = /^[\w-]*$/,
複製程式碼

看到這個正則其實是匹配 a-z、A-Z、0-9、下劃線、連詞符 組合起來的單詞，這其實就是單個 id 和 class 的命名規則。

從 return 中可以看出，qsa 其實是根據不同情況分別呼叫了原生的 getElementById、getElementsByClassName 、getElementsByTagName 和 querySelectorAll 的方法。

為什麼要這麼麻煩，不直接呼叫 querySelectorAll 方法呢？這是出於效能的考慮。這裡有個簡單的測試。這個測試裡，頁面上只有一個元素，如果比較複雜的時候，差距更加明顯。

好了，開始逐行分析程式碼。

引數

  • element 開始查詢的元素
  • selector 選擇器

變數

  • found： 已經找到的元素
  • maybeID = selector[0] == '#'： 判斷選擇器的第一個字元是否為 #， 如果是 # ，則可能是 id 選擇器
  • maybeClass = !maybeID && selector[0] == '.' 如果不是 id 選擇器，並且選擇器的第一個字元為 . ，則可能是 class 選擇器
  • nameOnly = maybeID || maybeClass ? selector.slice(1) : selector ，如果為 id 選擇器或者 class 選擇器，則將第一個字元去掉
  • isSimple = simpleSelectorRE.test(nameOnly) 是否為單選擇器，即 .single 的形式，不是 .first .secend 等形式

element.getElementById

(element.getElementById && isSimple && maybeID) 這是採用 element.getElementById 的條件。

首先要確保 element 具有 getElementById 的方法。getElementById 的方法是在 document 上的，Chrome等瀏覽器上，element 可能並不具有 geElementById 的方法，具體可以看看這篇文章：各瀏覽器對document.getElementById等方法的實現差異解析

然後要確保選擇器為單選擇器，並且為 id 選擇器。

返回值為 ((found = element.getElementById(nameOnly)) ? [found] : [])， 如果能查詢到元素，則將元素以陣列的形式返回，否則返回空陣列

排除不合法的element

element.nodeType !== 1 && element.nodeType !== 9 && element.nodeType !== 11 。1 對應的是 Node.ELEMENT_NODE ，9 對應的是 Node.DOCUMENT_NODE ， 11 對應的是 Node.DOCUMENT_FRAGMENT_NODE ，如果不為以上三種型別，直接返回 []。

終極三元表示式

slice.call(
  isSimple && !maybeID && element.getElementsByClassName ?  // 如果為單選擇器並且不為id選擇器並且存在getElementsByClassName方法，進入下一個三元表示式判斷
  maybeClass ? element.getElementsByClassName(nameOnly) :   // 如果為class選擇器，則採用getElementsByClassName
  element.getElementsByTagName(selector) :  // 否則採用getElementsByTagName方法
  element.querySelectorAll(selector)   // 以上情況都不是，則用querySelectorAll
)
複製程式碼

這裡用了 slice.call 處理所獲取到的集合，這樣，獲取到的DOM集合就可以直接使用陣列的方法了。

zepto.Z 函式

從第一篇程式碼結構中我們已經知道，其實實現 $ 函式的核心是 zepto.init ，而 zepto.init 最終返回的是 zepto.Z 的結果。那就先來看看 zepto.Z

zepto.Z = function(dom, selector) {
  return new Z(dom, selector)
}
複製程式碼

zepto.Z 的程式碼很簡單，返回的是 Z 函式的例項。那接下來再看看 Z 函式：

function Z(dom, selector) {
  var i, len = dom ? dom.length : 0
  for (i = 0; i < len; i++) this[i] = dom[i]
  this.length = len
  this.selector = selector || ''
}
複製程式碼

Z 函式做的事情也很簡單，就是將 dom 陣列轉化為類陣列的形式，並設定對應的 length 屬性和 selector 屬性。

zepto.isZ

zepto.isZ = function(object) {
  return object instanceof zepto.Z
}
複製程式碼

既然看了 Z 函式，就順便也將 isZ 也一起看了吧。isZ 函式用來判斷引數 object 是否為 Z 的例項，這在 init 中會用到。

$的實現 zepto.init 函式

$的實現

$ = function(selector, context) {
  return zepto.init(selector, context)
}
複製程式碼

可以看到，其實 $ 呼叫的就是 zepto.init 這個內部方法。

zepto.init

zepto.init = function(selector, context) {
  var dom  // dom 集合
  if (!selector) return zepto.Z() // 分支1
  else if (typeof selector == 'string') { // 分支2
    selector = selector.trim()
    if (selector[0] == '<' && fragmentRE.test(selector))
      dom = zepto.fragment(selector, RegExp.$1, context), selector = null
      else if (context !== undefined) return $(context).find(selector)
      else dom = zepto.qsa(document, selector)
        }
  else if (isFunction(selector)) return $(document).ready(selector) // 分支3
  else if (zepto.isZ(selector)) return selector  // 分支4
  else { // 分支5
    if (isArray(selector)) dom = compact(selector)
    else if (isObject(selector))
      dom = [selector], selector = null
      else if (fragmentRE.test(selector))
        dom = zepto.fragment(selector.trim(), RegExp.$1, context), selector = null
        else if (context !== undefined) return $(context).find(selector)
        else dom = zepto.qsa(document, selector)
          }
  return zepto.Z(dom, selector)
}
複製程式碼

這個 init 方法程式碼量不多，但是有大量的 if else， 希望我可以說得清楚

$的用法

$(selector, [context])   ⇒ collection  // 用法1
$(<Zepto collection>)   ⇒ same collection // 用法2
$(<DOM nodes>)   ⇒ collection // 用法3
$(htmlString)   ⇒ collection // 用法4
$(htmlString, attributes)   ⇒ collection v1.0+ // 用法5
Zepto(function($){ ... })   // 用法6
複製程式碼

不傳參呼叫

直接呼叫 $() 時，對應的是分支1的情況： if (!selector) return zepto.Z() ，返回的是空的 Z 物件

selector 為 String 時

當 selector 為 string 時，對應的程式碼在分支2，對應的用法是用法1、用法4和用法5

在這個分支裡，又有三個子分支。一一來看一下：

第一個的判斷條件為 selector[0] == '<' && fragmentRE.test(selector) 。selector 的第一個字元為 < ，並且為html標籤 。fragmentRE 的定義如下 fragmentRE = /^\s*<(\w+|!)[^>]*>/ ，這個其實就是用來判斷字串是否為標籤。 我對正則也不太熟，這裡就不再展開。

如果滿足條件，則執行如下程式碼：dom = zepto.fragment(selector, RegExp.$1, context), selector = null。 zepto.fragment 其實是通過 htmlString 返回一個dom集合。這個函式稍後會說到，這裡先不展開。這裡對應的是用法4和用法5。

如果不滿足第一個判斷條件，則再判斷 context !== undefined (上下文是否存在)。如果存在，則查詢 context 下選擇器為 selector 的所有子元素: $(context).find(selector) 。這個分支對應的是用法1

否則，呼叫 zepto.qsa 方法，查詢 document 下的所有 selector ： dom = zepto.qsa(document, selector)。這裡對應的是用法1。

selector 為 Function 時

對應的程式碼在分支3，對應的用法是用法6

這個分支很簡單，在頁面載入完畢後，再執行回撥方法：$(document).ready(selector)

用過 zepto 的應該都熟悉這種用法: $(function() {})。其實走的就是這個分支

selector 為 Z 物件時

對應的程式碼在分支4，對應的用法是用法2

如果引數已經為 Z 物件（zepto.isZ(selector)），則不需要做任何事情，直接原物件返回就可以了。

selector 為其他情況

如果為陣列時（isArray(selector)）, 將陣列展平(dom = compact(selector))

如果為物件時（isObject(selector)），將物件包裹成陣列（dom = [selector]）。

以上兩種情況對應的是用法3，將dom物件或dom集合轉化為 z 物件

如果為標籤（fragmentRE.test(selector)），執行跟分支1一模一樣的程式碼。這裡判斷在上面已經做過了，為什麼要再來一次呢？我也不太明白，有明白的可以跟我說下。

經過一輪又一輪的判斷和 selector 重置，現在終於可以呼叫 z 函式了: zepto.Z(dom, selector) ，init 的最後，將收集到的 dom 集合和對應的 selector 傳入 Z 函式，返回 Z 物件。

zepto.fragment

zepto.fragment = function(html, name, properties) {
  var dom, nodes, container
  if (singleTagRE.test(html)) dom = $(document.createElement(RegExp.$1))
  if (!dom) {
    if (html.replace) html = html.replace(tagExpanderRE, "<$1></$2>")
    if (name === undefined) name = fragmentRE.test(html) && RegExp.$1
    if (!(name in containers)) name = '*'
    container = containers[name]
    container.innerHTML = '' + html
    dom = $.each(slice.call(container.childNodes), function() {
      container.removeChild(this)
    })
  }
  if (isPlainObject(properties)) {
    nodes = $(dom)
    $.each(properties, function(key, value) {
      if (methodAttributes.indexOf(key) > -1) nodes[key](value)
      else nodes.attr(key, value)
        })
  }
  return dom
}
複製程式碼

fragment 的作用的是將html片斷轉換成dom陣列形式。

首先判斷是否為標籤的形式 singleTagRE.test(html) （如<div></div>）, 如果是，則採用該標籤名來建立dom物件 dom = $(document.createElement(RegExp.$1))，不用再作其他處理。singleTagRE = /^<(\w+)\s*\/?>(?:<\/\1>|)$/。

如果尚未獲取到 dom，接著進行：

if (html.replace) html = html.replace(tagExpanderRE, "<$1></$2>")
複製程式碼

這段是對 html 進行修復，如<p class="test" /> 修復成 <p class="test" /></p> 。正規表示式為 tagExpanderRE = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/ig

if (name === undefined) name = fragmentRE.test(html) && RegExp.$1
複製程式碼

如果沒有指定標籤名，則獲取標籤名。如傳入 <div>test</div> ，獲取到的 name 為 div

if (!(name in containers)) name = '*'
    container = containers[name]
    container.innerHTML = '' + html
    dom = $.each(slice.call(container.childNodes), function() {
      container.removeChild(this)
    })
  }
// containers 已經開頭定義，如下
table = document.createElement('table'),
        tableRow = document.createElement('tr'),
containers = {
  'tr': document.createElement('tbody'),
  'tbody': table,
  'thead': table,
  'tfoot': table,
  'td': tableRow,
  'th': tableRow,
  '*': document.createElement('div')
}
複製程式碼

檢測 name 是否為特殊的元素，如 tr 要用 tbody 包裹，其他的元素用 div 包裹。包裹元素的 childNodes 即為所需要獲取的 dom 。

if (isPlainObject(properties)) {
    nodes = $(dom)
    $.each(properties, function(key, value) {
      if (methodAttributes.indexOf(key) > -1) nodes[key](value)
      else nodes.attr(key, value)
        })
  }
// methodAttributes 在上面已經定義，定義如下
methodAttributes = ['val', 'css', 'html', 'text', 'data', 'width', 'height', 'offset']
複製程式碼

如果屬性值為純物件，則給元素設定屬性。

如果所需設定的屬性，zepto已經定義了相應的方法，則呼叫zepto對應的方法，否則統一呼叫zepto的attr 方法設定屬性。

最後將 dom 返回

系列文章

  1. 讀Zepto原始碼之程式碼結構
  2. 讀 Zepto 原始碼之內部方法
  3. 讀Zepto原始碼之工具函式

參考

最後，所有文章都會同步傳送到微信公眾號上，歡迎關注,歡迎提意見：

讀Zepto原始碼之神奇的$

作者：對角另一面

相關文章