实现一个 jQuery 的 API

最近学到了 DOM —— Document Object Model(文档对象模型)。它通过映射文档的结构,将 web 页面与脚本或编程语言关联起来。DOM 用逻辑树来表示一个文档,每个分支的末端是一个节点(node),每一个节点(node)包含着对象。使用 DOM 的 API 可以程序化访问这个树,你可以用他们操纵文档的结构,样式或内容。

jQuery 是一个高效简洁的 JavaScript 库,它通过对 DOM 节点进行包装及对一些通用重复的功能进行封装,使得操作 DOM 变得简单高效,而且大大缓解了早期各浏览器之间不兼容的问题。

如何实现 jQuery 的 API

这次的作业内容是:

window.jQuery = ???
window.$ = jQuery

var $div = $('div')
$div.addClass('red') // 可将所有 div 的 class 添加一个 red
$div.setText('hi') // 可将所有 div 的 textContent 变为 hi

需要将 ???的内容补全。
我们先从 addClass() 和 setText() 这两个函数切入。

// addClass()
function addClass(nodeList, className) {
  for(var i = 0; i < nodeList.length; i++) {
    nodeList[i].classList.add(className)
  }
}

// setText()
function setText(nodeList, text) {
  for(var i = 0; i < nodeList.length; i++) {
    nodeList[i].textContent = text
  }
}

以往当我们需要调用这两个函数实现想要的效果时,我们是这样做的:

// 先获取要操作的元素
var divList = document.querySelectorAll('div')
// 再将其带入函数执行
addClass(divList, 'red')
setText(divList, 'hi')

或者用命名空间的方式,将你写的很酷的一些函数打包在一个自己命名的对象里,增加辨识度:

var Yui = {
  addClass: function(nodeList, className) {
    for(var i = 0; i < nodeList.length; i++) {
      nodeList[i].classList.add(className)
    }
  },
  setText: function(nodeList, text) {
    for(var i = 0; i < nodeList.length; i++) {
     nodeList[i].textContent = text
    }
  }
} 

Yui.addClass(divList, 'red')
Yui.setText(divList, 'hi')

但是上面这两种函数调用的方法都有点反直觉...

我们调用函数的方式一般都是 对象.函数名(参数) 这种形式。而上面两个函数之所以不能这么用的原因是:
我们获取到的元素 divList 它的原型是 NodeList ,在他的原型链上是没有 addClass 和 setText 这两个函数的,NodeList 没有提供,我们也并没有把这两个函数添加到它的原型链上。
不仅是 divList ,在开发的过程中我们需要获取各种各样的元素对象,他们的原型链都各不相同。我们如果想对他们执行原型链上没有的方法,就不得不像上面一样先写一些函数,再把他们作为参数传入,然后使用他们现有的 API 组合以达到想要的功能。

有什么办法让我们可以直接对所有获取到的元素统一用 divList.addClass('red') 这种形式来调用函数么?

方案1:扩展现有原型的 API

我们都知道所有的对象原型链的最后一环都是 Object ,那么按理说只要我们在 Object.prototype 上添加 addClass 和 setText 这两个函数,那么获取到的任何元素都可以直接调用它们。

// 在 Object 原型上添加 addClass
Object.prototype.addClass = function(className) {
  for(var i = 0; i < this.length; i++) {
    this[i].classList.add(className)
  }
}
// 在 Object 原型上添加 setText
Object.prototype.setText = function(text) {
  for(var i = 0; i < this.length; i++) {
    this[i].textContent = text
  }
}

// divList 就可以直接调用 addClass 和 setText 了
divList.addClass('red')
divList.setText('hi')

但是这样做有很多缺陷,比如有可能会不小心起了和别的 API 同样的名字,这样就会覆盖原有的 API 或者别人写的方法。

方案2:把获取到的元素包装成一个新的对象

假设我们在 window 上添加一个函数 jQuery,用它来接收我们获取的对象 A,然后返回一个重新包装好的对象 $A。在函数 jQuery 中,我们可以预定义各种常用但是写起来繁琐的功能函数,添加在返回的对象 $A 上,这样 $A 就可以直接使用这些函数。

var divList = document.querySelectorAll('div')
window.jQuery = function(divList) {
  //返回一个重新包装的对象
  return {
    addClass: function(className) {
      for(var i = 0; i < divList.length; i++) {
        divList[i].classList.add(className)
      }
    },
    setText: function(text) {
      for(var i = 0; i < divList.length; i++) {
        divList[i].textContent = text
      }
    },
    xxx: f(),
    xxx: f(),
    ...
  }
}
// 调用 jQuery 返回一个新包装的对象
var $divList = jQuery(divList)
$divList.addClass('red')
$divList.setText('hi')

只要把 jQuery 中的函数扩展得足够多和强大,以后我们就可以直接引入它,然后随心所欲地使用它提供的功能。

再对 jQuery 做些改进

上面这样写有些缺陷,jQuery 接收的参数只能是特定类型的元素,而且每次调用 jQuery 之前还得先获取到元素,十分麻烦。我们希望只需一个元素 id,一个类名,或者标签名就能直接得到 jQuery 返回的包装好的对象 $A。只要在 jQuery 内部做些改进:

window.jQuery = function(nodeOrSelector) {
  // 创建一个新的空对象,作为存放包装后对象的容器
  var nodes = {}
  // 判断传入的元素类型,若是字符串,则表明希望用该字符串作为选择器参数获取相应元素
  if (typeof nodeOrSelector === 'string') {
    var temp = document.querySelectorAll(nodeOrSelector)
    // querySelectorAll() 方法返回的是 NodeList 类型的对象,有一些自带的属性和方法。
    // 我们希望 nodes 保持纯净,里面只有元素列表和我们自己的方法
    for (var i = 0; i < temp.length; i++) {
      nodes[i] = temp[i]
    }
    nodes.length = temp.length
    // 经过上面的重构,nodes 就是一个纯净的类数组对象
    // 里面只有对象列表和 length ,原型链直连 Object,没有多余的属性和方法

    // 如果传入的元素就是一个单一的节点,就直接添加到 nodes 的 0 键上
  } else if (nodeOrSelector instanceof Node) {
    nodes = {0: nodeOrSelector, length: 1}
  }
  
  // 然后就可以在 nodes 上添加 setClass 和 setText 等各种函数了 
  nodes.addClass = function(className) {
    for(var i = 0; i < divList.length; i++) {
      divList[i].classList.add(className)
    }
  }

  nodes.setText = function(text) {
    for(var i = 0; i < divList.length; i++) {
      divList[i].textContent = text
    }
  }

  // 最后返回包装好的 nodes 对象
  return nodes
}

  // 再为 jQuery 添加一个缩写 $
window.$ = jQuery

这样就实现了一个简易版的 jQuery。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,233评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,013评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,030评论 0 241
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,827评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,221评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,542评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,814评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,513评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,225评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,497评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,998评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,342评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,986评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,055评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,812评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,560评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,461评论 2 266

推荐阅读更多精彩内容