讀Zepto原始碼之屬性操作

weixin_34232744發表於2017-06-25

這篇依然是跟 dom 相關的方法,側重點是操作屬性的方法。

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

原始碼版本

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

內部方法

setAttribute

function setAttribute(node, name, value) {
  value == null ? node.removeAttribute(name) : node.setAttribute(name, value)
}複製程式碼

如果屬性值 value 存在,則呼叫元素的原生方法 setAttribute 設定對應元素的指定屬性值,否則呼叫 removeAttribute 刪除指定的屬性。

deserializeValue

// "true"  => true
// "false" => false
// "null"  => null
// "42"    => 42
// "42.5"  => 42.5
// "08"    => "08"
// JSON    => parse if valid
// String  => self
function deserializeValue(value) {
  try {
    return value ?
      value == "true" ||
      (value == "false" ? false :
       value == "null" ? null :
       +value + "" == value ? +value :
       /^[\[\{]/.test(value) ? $.parseJSON(value) :
       value) :
    value
  } catch (e) {
    return value
  }
}複製程式碼

函式的主體又是個很複雜的三元表示式,但是函式要做什麼事情,註釋已經寫得很明白了。

try catch 保證出錯的情況下依然可以將原值返回。

先將這個複雜的三元表示式拆解下:

value ? 相當複雜的表示式返回的值 : value複製程式碼

值存在時,就進行相當複雜的三元表示式運算,否則返回原值。

再來看看 value === "true" 時的運算

value == "true" || (複雜表示式求出的值)複製程式碼

這其實是一個或操作,當 value === "true" 時就不執行後面的表示式,直接將 value === "true" 的值返回,也就是返回 true

再來看 value === false 時的求值

value == "false" ? false : (其他表示式求出來的值)複製程式碼

很明顯,value === "false" 時,返回的值為 false

value == "null" ? null : (其他表示式求出來的值)複製程式碼

value == "null" 時, 返回值為 null

再來看看數字字串的判斷:

 +value + "" == value ? +value : (其他表示式求出來的值)複製程式碼

這個判斷相當有意思。

+valuevalue 隱式轉換成數字型別,"42" 轉換成 42"08" 轉換成 8abc 會轉換成 NaN+ "" 是將轉換成數字後的值再轉換成字串。然後再用 == 和原值比較。這裡要注意,用的是 == ,不是 === 。左邊表示式不用說,肯定是字串型別,右邊的如果為字串型別,並且和左邊的值相等,那表示 value 為數字字串,可以用 +value 直接轉換成數字。 但是以 0 開頭的數字字串如 "08" ,經過左邊的轉換後變成 "8",兩個字串不相等,繼續執行後面的邏輯。

如果 value 為數字,則左邊的字串會再次轉換成數字後再和 value 進行比較,左邊轉換成數字後肯定為 value 本身,因此表示式成立,返回一樣的數字。

/^[\[\{]/.test(value) ? $.parseJSON(value) : value複製程式碼

這長長的三元表示式終於被剝得只剩下內衣了。

/^[\[\{]/ 這個正則是檢測 value 是否以 [ 或者 { 開頭,如果是,則將其作為物件或者陣列,執行 $.parseJSON 方法反序列化,否則按原值返回。

其實,這個正則不太嚴謹的,以這兩個符號開頭的字串,可能根本不是物件或者陣列格式的,序列化可能會出錯,這就是一開始提到的 try catch 所負責的事了。

.html()

html: function(html) {
  return 0 in arguments ?
    this.each(function(idx) {
    var originHtml = this.innerHTML
    $(this).empty().append(funcArg(this, html, idx, originHtml))
  }) :
  (0 in this ? this[0].innerHTML : null)
},複製程式碼

html 方法既可以設定值,也可以獲取值,引數 html 既可以是固定值,也可以是函式。

html 方法的主體是一個三元表示式, 0 in arguments 用來判斷方法是否帶引數,如果不帶引數,則獲取值,否則,設定值。

(0 in this ? this[0].innerHTML : null)複製程式碼

先來看看獲取值,0 in this 是判斷集合是否為空,如果為空,則返回 null ,否則,返回的是集合第一個元素的 innerHTML 屬性值。

this.each(function(idx) {
  var originHtml = this.innerHTML
  $(this).empty().append(funcArg(this, html, idx, originHtml))
})複製程式碼

知道值怎樣獲取後,設定也就簡單了,要注意一點的是,設定值的時候,集合中每個元素的 innerHTML 值都被設定為給定的值。

由於引數 html 可以是固定值或者函式,所以先呼叫內部函式 funcArg 來對引數進行處理,funcArg 的分析請看 《讀Zepto原始碼之樣式操作》 。

設定的邏輯也很簡單,先將當前元素的內容清空,呼叫的是 empty 方法,然後再呼叫 append 方法,插入給定的值到當前元素中。append 方法的分析請看《讀Zepto原始碼之操作DOM

.text()

text: function(text) {
  return 0 in arguments ?
    this.each(function(idx) {
    var newText = funcArg(this, text, idx, this.textContent)
    this.textContent = newText == null ? '' : '' + newText
  }) :
  (0 in this ? this.pluck('textContent').join("") : null)
},複製程式碼

text 方法用於獲取或設定元素的 textContent 屬性。

先看不傳參的情況:

(0 in this ? this.pluck('textContent').join("") : null)複製程式碼

呼叫 pluck 方法獲取每個元素的 textContent 屬性,並且將結果集合併成字串。關於 textContentinnerText 的區別,MDN上說得很清楚:

  • textContent 會獲取所有元素的文字,包括 scriptstyle 的元素
  • innerText 不會將隱藏元素的文字返回
  • innerText 元素遇到 style 時,會重繪

具體參考 MDN:Node.textContent

設定值的邏輯中 html 方法差不多,但是在 newText == null 時,賦值為 '' ,否則,轉換成字串。這個轉換我有點不太明白, 賦值給 textContent 時,會自動轉換成字串,為什麼要自己轉換一次呢?還有,textContent 直接賦值為 null 或者 undefined ,也會自動轉換為 '' ,為什麼還要自己轉換一次呢?

.attr()

attr: function(name, value) {
  var result
  return (typeof name == 'string' && !(1 in arguments)) ?
    (0 in this && this[0].nodeType == 1 && (result = this[0].getAttribute(name)) != null ? result : undefined) :
  this.each(function(idx) {
    if (this.nodeType !== 1) return
    if (isObject(name))
    for (key in name) setAttribute(this, key, name[key])
    else setAttribute(this, name, funcArg(this, value, idx, this.getAttribute(name)))
      })
},複製程式碼

attr 用於獲取或設定元素的屬性值。name 引數可以為 object ,用於設定多組屬性值。

判斷條件:

typeof name == 'string' && !(1 in arguments)複製程式碼

引數 name 為字串,排除掉 nameobject 的情況,並且第二個引數不存在,在這種情況下,為獲取值。

(0 in this && this[0].nodeType == 1 && (result = this[0].getAttribute(name)) != null ? result : undefined)複製程式碼

獲取屬性時,要滿足幾個條件:

  1. 集合不為空
  2. 集合的第一個元素的 nodeTypeELEMENT_NODE

然後呼叫元素的原生方法 getAttribute 方法來獲取第一個元素對應的屬性值,如果屬性值 !=null ,則返回獲取到的屬性值,否則返回 undefined

再來看設定值的情況:

this.each(function(idx) {
  if (this.nodeType !== 1) return
  if (isObject(name))
      for (key in name) setAttribute(this, key, name[key])
  else setAttribute(this, name, funcArg(this, value, idx, this.getAttribute(name)))
    })複製程式碼

如果元素的 nodeType 不為 ELEMENT_NODE 時,直接 return

nameobject 時,遍歷物件,設定對應的屬性

否則,設定給定屬性的值。

.removeAttr()

removeAttr: function(name) {
  return this.each(function() {
    this.nodeType === 1 && name.split(' ').forEach(function(attribute) {
      setAttribute(this, attribute)
    }, this)
  })
},複製程式碼

刪除給定的屬性。可以用空格分隔多個屬性。

呼叫的其實是 setAttribute 方法,只將元素和需要刪除的屬性傳遞進去, setAttribute 就會將對應的元素屬性刪除。

.prop()

propMap = {
  'tabindex': 'tabIndex',
  'readonly': 'readOnly',
  'for': 'htmlFor',
  'class': 'className',
  'maxlength': 'maxLength',
  'cellspacing': 'cellSpacing',
  'cellpadding': 'cellPadding',
  'rowspan': 'rowSpan',
  'colspan': 'colSpan',
  'usemap': 'useMap',
  'frameborder': 'frameBorder',
  'contenteditable': 'contentEditable'
}
prop: function(name, value) {
  name = propMap[name] || name
  return (1 in arguments) ?
    this.each(function(idx) {
    this[name] = funcArg(this, value, idx, this[name])
  }) :
  (this[0] && this[0][name])
},複製程式碼

prop 也是給元素設定或獲取屬性,但是跟 attr 不同的是, prop 設定的是元素本身固有的屬性,attr 用來設定自定義的屬性(也可以設定固有的屬性)。

propMap 是將一些特殊的屬性做一次對映。

prop 取值和設定值的時候,都是直接操作元素物件上的屬性,不需要呼叫如 setAttribute 的方法。

.removeProp()

removeProp: function(name) {
  name = propMap[name] || name
  return this.each(function() { delete this[name] })
},複製程式碼

刪除元素固定屬性,呼叫物件的 delete 方法就可以了。

.data()

capitalRE = /([A-Z])/g
data: function(name, value) {
  var attrName = 'data-' + name.replace(capitalRE, '-$1').toLowerCase()

  var data = (1 in arguments) ?
      this.attr(attrName, value) :
  this.attr(attrName)

  return data !== null ? deserializeValue(data) : undefined
},複製程式碼

data 內部呼叫的是 attr 方法,但是給屬性名加上了 data- 字首,這也是向規範靠攏。

name.replace(capitalRE, '-$1').toLowerCase()複製程式碼

稍微解釋下這個正則,capitalRE 匹配的是大寫字母,replace(capitalRE, '-$1') 是在大寫字母前面加上 - 連字元。這整個表示式其實就是將 name 轉換成 data-camel-case 的形式。

return data !== null ? deserializeValue(data) : undefined複製程式碼

如果 data 不嚴格為 null 時,呼叫 deserializeValue 序列化後返回,否則返回 undefined 。為什麼要用嚴格等 null 來作為判斷呢?這個我也不太明白,因為在獲取值時,attr 方法對不存在的屬性返回值為 undefined ,用 !== undefined 判斷會不會更好點呢?這樣 undefined 根本不需要再走 deserializeValue 方法。

.val()

val: function(value) {
  if (0 in arguments) {
    if (value == null) value = ""
    return this.each(function(idx) {
      this.value = funcArg(this, value, idx, this.value)
    })
  } else {
    return this[0] && (this[0].multiple ?
                       $(this[0]).find('option').filter(function() { return this.selected }).pluck('value') :
                       this[0].value)
  }
},複製程式碼

獲取或設定表單元素的 value 值。

如果傳參,還是慣常的套路,設定的是元素的 value 屬性。

否則,獲取值,看看獲取值的邏輯:

return this[0] && (this[0].multiple ? 
                   $(this[0]).find('option').filter(function() { return this.selected }).pluck('value') : 
                   this[0].value)複製程式碼

this[0].multiple 判斷是否為下拉選單多選,如果是,則找出所有選中的 option ,獲取選中的 optionvalue 值返回。這裡用到 pluck 方法來獲取屬性,具體的分析見:《讀Zepto原始碼之集合元素查詢

否則,直接返回第一個元素的 value 值。

.offsetParent()

ootNodeRE = /^(?:body|html)$/i
offsetParent: function() {
  return this.map(function() {
    var parent = this.offsetParent || document.body
    while (parent && !rootNodeRE.test(parent.nodeName) && $(parent).css("position") == "static")
      parent = parent.offsetParent
    return parent
  })
}複製程式碼

查詢最近的祖先定位元素,即最近的屬性 position 被設定為 relativeabsolutefixed 的祖先元素。

var parent = this.offsetParent || document.body複製程式碼

獲取元素的 offsetParent 屬性,如果不存在,則預設賦值為 body 元素。

parent && !rootNodeRE.test(parent.nodeName) && $(parent).css("position") == "static"複製程式碼

判斷父級定位元素是否存在,並且不為根元素(即 body 元素或 html 元素),並且為相對定位元素,才進入迴圈,迴圈內是獲取下一個 offsetParent 元素。

這個應該做瀏覽器相容的吧,因為 offsetParent 本來返回的就是最近的定位元素。

.offset()

offset: function(coordinates) {
  if (coordinates) return this.each(function(index) {
    var $this = $(this),
        coords = funcArg(this, coordinates, index, $this.offset()),
        parentOffset = $this.offsetParent().offset(),
        props = {
          top: coords.top - parentOffset.top,
          left: coords.left - parentOffset.left
        }

    if ($this.css('position') == 'static') props['position'] = 'relative'
    $this.css(props)
  })
  if (!this.length) return null
  if (document.documentElement !== this[0] && !$.contains(document.documentElement, this[0]))
    return { top: 0, left: 0 }
    var obj = this[0].getBoundingClientRect()
    return {
      left: obj.left + window.pageXOffset,
      top: obj.top + window.pageYOffset,
      width: Math.round(obj.width),
      height: Math.round(obj.height)
    }
},複製程式碼

獲取或設定元素相對 document 的偏移量。

先來看獲取值:

if (!this.length) return null
if (document.documentElement !== this[0] && !$.contains(document.documentElement, this[0]))
  return { top: 0, left: 0 }
var obj = this[0].getBoundingClientRect()
return {
  left: obj.left + window.pageXOffset,
  top: obj.top + window.pageYOffset,
  width: Math.round(obj.width),
  height: Math.round(obj.height)
}複製程式碼

如果集合不存在,則返回 null

if (document.documentElement !== this[0] && !$.contains(document.documentElement, this[0]))
  return { top: 0, left: 0 }複製程式碼

如果集合中第一個元素不為 html 元素物件(document.documentElement !== this[0]) ,並且不為 html 元素的子元素,則返回 { top: 0, left: 0 }

接下來,呼叫 getBoundingClientRect ,獲取元素的 widthheight 值,以及相對視窗左上角的 lefttop 值。具體參見文件: Element.getBoundingClientRect()

因為 getBoundingClientRect 獲取到的位置是相對視窗的,因此需要將視窗外偏移量加上,即加上 window.pageXOffsetwindow.pageYOffset

再來看設定值:

if (coordinates) return this.each(function(index) {
  var $this = $(this),
      coords = funcArg(this, coordinates, index, $this.offset()),
      parentOffset = $this.offsetParent().offset(),
      props = {
        top: coords.top - parentOffset.top,
        left: coords.left - parentOffset.left
      }

  if ($this.css('position') == 'static') props['position'] = 'relative'
  $this.css(props)
})複製程式碼

前面幾行都是固有的模式,不再展開,看看這段:

parentOffset = $this.offsetParent().offset()複製程式碼

獲取最近定位元素的 offset 值,這個值有什麼用呢?

props = {
  top: coords.top - parentOffset.top,
  left: coords.left - parentOffset.left
}
if ($this.css('position') == 'static') props['position'] = 'relative'
  $this.css(props)複製程式碼

我們可以看到,設定偏移的時候,其實是設定元素的 lefttop 值。如果父級元素有定位元素,那這個 lefttop 值是相對於第一個父級定位元素的。

因此需要將傳入的 coords.topcoords.left 對應減掉第一個父級定位元素的 offsettopleft 值。

如果當前元素的 position 值為 static ,則將值設定為 relative ,相對自身偏移計算出來相差的 lefttop 值。

.position()

position: function() {
  if (!this.length) return

  var elem = this[0],
    offsetParent = this.offsetParent(),
    offset = this.offset(),
    parentOffset = rootNodeRE.test(offsetParent[0].nodeName) ? { top: 0, left: 0 } : offsetParent.offset()
  offset.top -= parseFloat($(elem).css('margin-top')) || 0
  offset.left -= parseFloat($(elem).css('margin-left')) || 0
  parentOffset.top += parseFloat($(offsetParent[0]).css('border-top-width')) || 0
  parentOffset.left += parseFloat($(offsetParent[0]).css('border-left-width')) || 0
  return {
    top: offset.top - parentOffset.top,
    left: offset.left - parentOffset.left
  }
},複製程式碼

返回相對父元素的偏移量。

offsetParent = this.offsetParent(),
offset = this.offset(),
parentOffset = rootNodeRE.test(offsetParent[0].nodeName) ? { top: 0, left: 0 } : offsetParent.offset()複製程式碼

分別獲取到第一個定位父元素 offsetParent 及相對文件偏移量 parentOffset ,和自身的相對文件偏移量 offset 。在獲取每一個定位父元素偏移量時,先判斷父元素是否為根元素,如果是,則 lefttop 都返回 0

offset.top -= parseFloat($(elem).css('margin-top')) || 0
offset.left -= parseFloat($(elem).css('margin-left')) || 0複製程式碼

兩個元素之間的距離應該不包含元素的外邊距,因此將外邊距減去。

parentOffset.top += parseFloat($(offsetParent[0]).css('border-top-width')) || 0
parentOffset.left += parseFloat($(offsetParent[0]).css('border-left-width')) || 0複製程式碼

因為 position 返回的是距離第一個定位元素的 context box 的距離,因此父元素的 offsetlefttop 值需要將 border 值加上(offset 算是的外邊距距離文件的距離)。

return {
  top: offset.top - parentOffset.top,
  left: offset.left - parentOffset.left
}複製程式碼

最後,將他們距離文件的偏移量相減就得到兩者間的偏移量了。

.scrollTop()

scrollTop: function(value) {
  if (!this.length) return
  var hasScrollTop = 'scrollTop' in this[0]
  if (value === undefined) return hasScrollTop ? this[0].scrollTop : this[0].pageYOffset
  return this.each(hasScrollTop ?
                   function() { this.scrollTop = value } :
                   function() { this.scrollTo(this.scrollX, value) })
},複製程式碼

獲取或設定元素在縱軸上的滾動距離。

先看獲取值:

var hasScrollTop = 'scrollTop' in this[0]
if (value === undefined) return hasScrollTop ? this[0].scrollTop : this[0].pageYOffset複製程式碼

如果存在 scrollTop 屬性,則直接用 scrollTop 獲取屬性,否則用 pageYOffset 獲取元素Y軸在螢幕外的距離,也即滾動高度了。

return this.each(hasScrollTop ?
                   function() { this.scrollTop = value } :
                   function() { this.scrollTo(this.scrollX, value) })複製程式碼

知道了獲取值後,設定值也簡單了,如果有 scrollTop 屬性,則直接設定這個屬性的值,否則呼叫 scrollTo 方法,用 scrollX 獲取到 x 軸的滾動距離,將 y 軸滾動到指定的距離 value

.scrollLeft()

scrollLeft: function(value) {
  if (!this.length) return
  var hasScrollLeft = 'scrollLeft' in this[0]
  if (value === undefined) return hasScrollLeft ? this[0].scrollLeft : this[0].pageXOffset
  return this.each(hasScrollLeft ?
                   function() { this.scrollLeft = value } :
                   function() { this.scrollTo(value, this.scrollY) })
},複製程式碼

scrollLeft 原理同 scrollTop ,不再展開敘述。

系列文章

  1. 讀Zepto原始碼之程式碼結構
  2. 讀 Zepto 原始碼之內部方法
  3. 讀Zepto原始碼之工具函式
  4. 讀Zepto原始碼之神奇的$
  5. 讀Zepto原始碼之集合操作
  6. 讀Zepto原始碼之集合元素查詢
  7. 讀Zepto原始碼之操作DOM
  8. 讀Zepto原始碼之樣式操作

參考

License

License: CC BY-NC-ND 4.0

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

作者:對角另一面

相關文章