常见DOM以及API总结
DOM
DOM 是 JavaScript 操作网页的接口,全称为“文档对象模型”(Document Object Model)。它的作用是将网页转为一个 JavaScript 对象,从而可以用脚本进行各种操作(比如增删内容)。
浏览器会根据 DOM 模型,将结构化文档(比如 HTML 和 XML)解析成一系列的节点,再由这些节点组成一个树状结构(DOM Tree)。所有的节点和最终的树状结构,都有规范的对外接口。
DOM 只是一个接口规范,可以用各种语言实现。所以严格地说,DOM 不是 JavaScript 语法的一部分,但是 DOM 操作是 JavaScript 最常见的任务,离开了 DOM,JavaScript 就无法控制网页。另一方面,JavaScript 也是最常用于 DOM 操作的语言。后面介绍的就是 JavaScript 对 DOM 标准的实现和用法。
Node 接口
Node.prototype.nodeType
nodeType属性返回一个整数值,表示节点的类型。
1 | document.nodeType // 9 |
上面代码中,文档节点的类型值为9。
Node 对象定义了几个常量,对应这些类型值。
1 | document.nodeType === Node.DOCUMENT_NODE // true |
上面代码中,文档节点的nodeType属性等于常量Node.DOCUMENT_NODE。
不同节点的nodeType属性值和对应的常量如下。
- 文档节点(document):9,对应常量Node.DOCUMENT_NODE
- 元素节点(element):1,对应常量Node.ELEMENT_NODE
- 属性节点(attr):2,对应常量Node.ATTRIBUTE_NODE
- 文本节点(text):3,对应常量Node.TEXT_NODE
- 文档片断节点(DocumentFragment):11,对应常量Node.DOCUMENT_FRAGMENT_NODE
- 文档类型节点(DocumentType):10,对应常量Node.DOCUMENT_TYPE_NODE
- 注释节点(Comment):8,对应常量Node.COMMENT_NODE
确定节点类型时,使用nodeType属性是常用方法。
1 | var node = document.documentElement.firstChild; |
Node.prototype.nodeName
nodeName属性返回节点的名称。
1 | // HTML 代码如下 |
上面代码中,元素节点
不同节点的nodeName属性值如下。
- 文档节点(document):#document
- 元素节点(element):大写的标签名
- 属性节点(attr):属性的名称
- 文本节点(text):#text
- 文档片断节点(DocumentFragment):#document-fragment
- 文档类型节点(DocumentType):文档的类型
- 注释节点(Comment):#comment
Node.prototype.nodeValue
nodeValue属性返回一个字符串,表示当前节点本身的文本值,该属性可读写。
只有文本节点(text)、注释节点(comment)和属性节点(attr)有文本值,因此这三类节点的nodeValue可以返回结果,其他类型的节点一律返回null。同样的,也只有这三类节点可以设置nodeValue属性的值,其他类型的节点设置无效。
1 | // HTML 代码如下 |
上面代码中,div是元素节点,nodeValue属性返回null。div.firstChild是文本节点,所以可以返回文本值。
Node.prototype.textContent
textContent属性返回当前节点和它的所有后代节点的文本内容。
1 | // HTML 代码为 |
textContent属性自动忽略当前节点内部的 HTML 标签,返回所有文本内容。
该属性是可读写的,设置该属性的值,会用一个新的文本节点,替换所有原来的子节点。它还有一个好处,就是自动对 HTML 标签转义。这很适合用于用户提供的内容。
1 | document.getElementById('foo').textContent = '<p>GoodBye!</p>'; |
上面代码在插入文本时,会将
标签解释为文本,而不会当作标签处理。
对于文本节点(text)、注释节点(comment)和属性节点(attr),textContent属性的值与nodeValue属性相同。对于其他类型的节点,该属性会将每个子节点(不包括注释节点)的内容连接在一起返回。如果一个节点没有子节点,则返回空字符串。
文档节点(document)和文档类型节点(doctype)的textContent属性为null。如果要读取整个文档的内容,可以使用document.documentElement.textContent。
Node.prototype.baseURI
baseURI属性返回一个字符串,表示当前网页的绝对路径。浏览器根据这个属性,计算网页上的相对路径的 URL。该属性为只读。
1 | // 当前网页的网址为 |
如果无法读到网页的 URL,baseURI属性返回null。
该属性的值一般由当前网址的 URL(即window.location属性)决定,但是可以使用 HTML 的
1 | <base href="http://www.example.com/page.html"> |
设置了以后,baseURI属性就返回
Node.prototype.ownerDocument
Node.ownerDocument属性返回当前节点所在的顶层文档对象,即document对象。
1 | var d = p.ownerDocument; |
document对象本身的ownerDocument属性,返回null。
Node.prototype.nextSibling
Node.nextSibling属性返回紧跟在当前节点后面的第一个同级节点。如果当前节点后面没有同级节点,则返回null。
1 | // HTML 代码如下 |
上面代码中,d1.nextSibling就是紧跟在d1后面的同级节点d2。
注意,该属性还包括文本节点和注释节点()。因此如果当前节点后面有空格,该属性会返回一个文本节点,内容为空格。
nextSibling属性可以用来遍历所有子节点。
1 | var el = document.getElementById('div1').firstChild; |
上面代码遍历div1节点的所有子节点。
NodeList 接口
NodeList实例是一个类似数组的对象,它的成员是节点对象。通过以下方法可以得到NodeList实例。
- Node.childNodes
- document.querySelectorAll()等节点搜索方法NodeList实例很像数组,可以使用length属性和forEach方法。但是,它不是数组,不能使用pop或push之类数组特有的方法。
1
document.body.childNodes instanceof NodeList // true
上面代码中,NodeList 实例children不是数组,但是具有length属性和forEach方法。1
2
3
4
5
6var children = document.body.childNodes;
Array.isArray(children) // false
children.length // 34
children.forEach(console.log)
如果NodeList实例要使用数组方法,可以将其转为真正的数组。
1 | var children = document.body.childNodes; |
除了使用forEach方法遍历 NodeList 实例,还可以使用for循环。
1 | var children = document.body.childNodes; |
注意,NodeList 实例可能是动态集合,也可能是静态集合。所谓动态集合就是一个活的集合,DOM 删除或新增一个相关节点,都会立刻反映在 NodeList 实例。目前,只有Node.childNodes返回的是一个动态集合,其他的 NodeList 都是静态集合。
1 | var children = document.body.childNodes; |
上面代码中,文档增加一个子节点,NodeList 实例children的length属性就增加了1。
NodeList.prototype.length
length属性返回 NodeList 实例包含的节点数量。
1 | document.querySelectorAll('xxx').length |
上面代码中,document.querySelectorAll返回一个 NodeList 集合。对于那些不存在的 HTML 标签,length属性返回0。
NodeList.prototype.forEach()
forEach方法用于遍历 NodeList 的所有成员。它接受一个回调函数作为参数,每一轮遍历就执行一次这个回调函数,用法与数组实例的forEach方法完全一致。
1 | var children = document.body.childNodes; |
上面代码中,回调函数f的三个参数依次是当前成员、位置和当前 NodeList 实例。forEach方法的第二个参数,用于绑定回调函数内部的this,该参数可省略。
NodeList.prototype.item()
item方法接受一个整数值作为参数,表示成员的位置,返回该位置上的成员。
1 | document.body.childNodes.item(0) |
上面代码中,item(0)返回第一个成员。
如果参数值大于实际长度,或者索引不合法(比如负数),item方法返回null。如果省略参数,item方法会报错。
所有类似数组的对象,都可以使用方括号运算符取出成员。一般情况下,都是使用方括号运算符,而不使用item方法。
1 | document.body.childNodes[0] |
NodeList.prototype.keys(),NodeList.prototype.values(),NodeList.prototype.entries()
这三个方法都返回一个 ES6 的遍历器对象,可以通过for…of循环遍历获取每一个成员的信息。区别在于,keys()返回键名的遍历器,values()返回键值的遍历器,entries()返回的遍历器同时包含键名和键值的信息。
1 | var children = document.body.childNodes; |
ParentNode 接口
如果当前节点是父节点,就会继承ParentNode接口。由于只有元素节点(element)、文档节点(document)和文档片段节点(documentFragment)拥有子节点,因此只有这三类节点会继承ParentNode接口。
ParentNode.children
children属性返回一个HTMLCollection实例,成员是当前节点的所有元素子节点。该属性只读。
下面是遍历某个节点的所有元素子节点的示例。
1 | for (var i = 0; i < el.children.length; i++) { |
注意,children属性只包括元素子节点,不包括其他类型的子节点(比如文本子节点)。如果没有元素类型的子节点,返回值HTMLCollection实例的length属性为0。
另外,HTMLCollection是动态集合,会实时反映 DOM 的任何变化。
ParentNode.firstElementChild
firstElementChild属性返回当前节点的第一个元素子节点。如果没有任何元素子节点,则返回null。
1 | document.firstElementChild.nodeName |
上面代码中,document节点的第一个元素子节点是。
ParentNode.lastElementChild
lastElementChild属性返回当前节点的最后一个元素子节点,如果不存在任何元素子节点,则返回null。
1 | document.lastElementChild.nodeName |
上面代码中,document节点的最后一个元素子节点是(因为document只包含这一个元素子节点)。
ParentNode.childElementCount
childElementCount属性返回一个整数,表示当前节点的所有元素子节点的数目。如果不包含任何元素子节点,则返回0。
1 | document.body.childElementCount // 13 |
append方法为当前节点追加一个或多个子节点,位置是最后一个元素子节点的后面。
该方法不仅可以添加元素子节点,还可以添加文本子节点。
1 | var parent = document.body; |
注意,该方法没有返回值。
prepend方法为当前节点追加一个或多个子节点,位置是第一个元素子节点的前面。它的用法与append方法完全一致,也是没有返回值。
ChildNode 接口
remove方法用于从父节点移除当前节点。
1 | el.remove() |
上面代码在 DOM 里面移除了el节点。
ChildNode.before(),ChildNode.after()
before方法用于在当前节点的前面,插入一个或多个同级节点。两者拥有相同的父节点。
注意,该方法不仅可以插入元素节点,还可以插入文本节点。
1 | var p = document.createElement('p'); |
after方法用于在当前节点的后面,插入一个或多个同级节点,两者拥有相同的父节点。用法与before方法完全相同。
ChildNode.replaceWith()
replaceWith方法使用参数节点,替换当前节点。参数可以是元素节点,也可以是文本节点。
1 | var span = document.createElement('span'); |
上面代码中,el节点将被span节点替换。
节点创建型api
在这里,我将常用的DOM操作api进行分类,首先要介绍的是创建型的api。这一类型的api,简而言之就是用来创建节点的。
createElement
createElement通过传入指定的一个标签名来创建一个元素,如果传入的标签名是一个未知的,则会创建一个自定义的标签,注意:IE8以下浏览器不支持自定义标签。
使用如下:
1 | var div = document.createElement("div"); |
使用createElement要注意:通过createElement创建的元素并不属于html文档,它只是创建出来,并未添加到html文档中,要调用appendChild或insertBefore等方法将其添加到HTML文档树中。
createTextNode
createTextNode用来创建一个文本节点,用法如下:
1 | var textNode = document.createTextNode("一个TextNode"); |
createTextNode接收一个参数,这个参数就是文本节点中的文本,和createElement一样,创建后的文本节点也只是独立的一个节点,同样需要appendChild将其添加到HTML文档树中
cloneNode
cloneNode是用来返回调用方法的节点的一个副本,它接收一个bool参数,用来表示是否复制子元素,使用如下:
1 | var parent = document.getElementById("parentElement"); |
这段代码通过cloneNode复制了一份parent元素,其中cloneNode的参数为true,表示parent的子节点也被复制,如果传入false,则表示只复制了parent节点。
我们看看这个例子
1 | <div id="parent"> |
这段代码很简单,主要是绑定button事件,事件内容是复制了一个parent,修改其id,然后添加到文档中。
这里有几点要注意:
(1)和createElement一样,cloneNode创建的节点只是游离有html文档外的节点,要调用appendChild方法才能添加到文档树中
(2)如果复制的元素有id,则其副本同样会包含该id,由于id具有唯一性,所以在复制节点后必须要修改其id
(3)调用接收的bool参数最好传入,如果不传入该参数,不同浏览器对其默认值的处理可能不同
除此之外,我们还有一个需要注意的点:
如果被复制的节点绑定了事件,则副本也会跟着绑定该事件吗?这里要分情况讨论:
(1)如果是通过addEventListener或者比如onclick进行绑定事件,则副本节点不会绑定该事件
(2)如果是内联方式绑定比如
1 | <div onclick="showParent()"></div> |
这样的话,副本节点同样会触发事件。
createDocumentFragment
createDocumentFragment方法用来创建一个DocumentFragment。在前面我们说到DocumentFragment表示一种轻量级的文档,它的作用主要是存储临时的节点用来准备添加到文档中。
createDocumentFragment方法主要是用于添加大量节点到文档中时会使用到。假设要循环一组数据,然后创建多个节点添加到文档中,比如示例
1 | <ul id="list"></ul> |
这段代码将按钮绑定了一个事件,这个事件创建了100个li节点,然后依次将其添加HTML文档中。这样做有一个缺点:每次一创建一个新的元素,然后添加到文档树中,这个过程会造成浏览器的回流。所谓回流简单说就是指元素大小和位置会被重新计算,如果添加的元素太多,会造成性能问题。这个时候,就是使用createDocumentFragment了。
DocumentFragment不是文档树的一部分,它是保存在内存中的,所以不会造成回流问题。我们修改上面的代码如下:
1 | document.getElementById("btnAdd").onclick = function(){ |
优化后的代码主要是创建了一个fragment,每次生成的li节点先添加到fragment,最后一次性添加到list,大家可以看示例
创建型API总结
创建型api主要包括createElement,createTextNode,cloneNode和createDocumentFragment四个方法,需要注意下面几点:
- 它们创建的节点只是一个孤立的节点,要通过appendChild添加到文档中
- cloneNode要注意如果被复制的节点是否包含子节点以及事件绑定等问题
- 使用createDocumentFragment来解决添加大量节点时的性能问题
页面修改型API
前面我们提到创建型api,它们只是创建节点,并没有真正修改到页面内容,而是要调用appendChild来将其添加到文档树中。我在这里将这类会修改到页面内容归为一类。
修改页面内容的api主要包括:appendChild,insertBefore,removeChild,replaceChild。
appendChild
appendChild我们在前面已经用到多次,就是将指定的节点添加到调用该方法的节点的子元素的末尾。调用方法如下:
1 | parent.appendChild(child); |
child节点将会作为parent节点的最后一个子节点。
appendChild这个方法很简单,但是还有有一点需要注意:如果被添加的节点是一个页面中存在的节点,则执行后这个节点将会添加到指定位置,其原本所在的位置将移除该节点,也就是说不会同时存在两个该节点在页面上,相当于把这个节点移动到另一个地方。我们来看例子
1 | <div id="child"> |
这段代码主要是获取页面上的child节点,然后添加到指定位置,可以看到原本的child节点被移动到parent中了。
这里还有一个要注意的点:如果child绑定了事件,被移动时,它依然绑定着该事件。
insertBefore
insertBefore用来添加一个节点到一个参照节点之前,用法如下:
1 | parentNode.insertBefore(newNode,refNode); |
parentNode表示新节点被添加后的父节点
newNode表示要添加的节点
refNode表示参照节点,新节点会添加到这个节点之前
我们来看这个例子
1 | <div id="parent"> |
这段代码创建了一个新节点,然后添加到child节点之前。
和appendChild一样,如果插入的节点是页面上的节点,则会移动该节点到指定位置,并且保留其绑定的事件。
关于第二个参数参照节点还有几个注意的地方:
- refNode是必传的,如果不传该参数会报错
- 如果refNode是undefined或null,则insertBefore会将节点添加到子元素的末尾
removeChild
removeChild顾名思义,就是删除指定的子节点并返回,用法如下:
1 | var deletedChild = parent.removeChild(node); |
deletedChild指向被删除节点的引用,它等于node,被删除的节点仍然存在于内存中,可以对其进行下一步操作。
注意:如果被删除的节点不是其子节点,则程序将会报错。我们可以通过下面的方式来确保可以删除:
1 | if(node.parentNode){ |
通过节点自己获取节点的父节点,然后将自身删除。
replaceChild
replaceChild用于使用一个节点替换另一个节点,用法如下
1 | parent.replaceChild(newChild,oldChild); |
newChild是替换的节点,可以是新的节点,也可以是页面上的节点,如果是页面上的节点,则其将被转移到新的位置
oldChild是被替换的节点
页面修改型API总结
页面修改型api主要是这四个接口,要注意几个特点:
- 不管是新增还是替换节点,如果新增或替换的节点是原本存在页面上的,则其原来位置的节点将被移除,也就是说同一个节点不能存在于页面的多个位置
- 节点本身绑定的事件会不会消失,会一直保留着。
节点查询型API
节点查询型API也是非常常用的api,下面我们分别说明一下每一个api的使用。
document.getElementById
这个接口很简单,根据元素id返回元素,返回值是Element类型,如果不存在该元素,则返回null。
使用这个接口有几点要注意:
- 元素的Id是大小写敏感的,一定要写对元素的id
- HTML文档中可能存在多个id相同的元素,则返回第一个元素
- 只从文档中进行搜索元素,如果创建了一个元素并指定id,但并没有添加到文档中,则这个元素是不会被查找到的
document.getElementsByTagName
这个接口根据元素标签名获取元素,返回一个即时的HTMLCollection类型,什么是即时的HTMLCollection类型呢?我们来看看这个示例
1 | <div>div1</div> |
这段代码中有两个按钮,一个按钮是显示HTMLCollection元素的个数,另一个按钮可以新增一个div标签到文档中。前面提到HTMLCollcetion元素是即时的表示该集合是随时变化的,也就是是文档中有几个div,它会随时进行变化,当我们新增一个div后,再访问HTMLCollection时,就会包含这个新增的div。
使用document.getElementsByTagName这个方法有几点要注意:
- 如果要对HTMLCollection集合进行循环操作,最好将其长度缓存起来,因为每次循环都会去计算长度,暂时缓存起来可以提高效率
- 如果没有存在指定的标签,该接口返回的不是null,而是一个空的HTMLCollection
- “*”表示所有标签
document.getElementsByName
getElementsByName主要是通过指定的name属性来获取元素,它返回一个即时的NodeList对象。
使用这个接口主要要注意几点:
- 返回对象是一个即时的NodeList,它是随时变化的
- 在HTML元素中,并不是所有元素都有name属性,比如div是没有name属性的,但是如果强制设置div的name属性,它也是可以被查找到的
- 在IE中,如果id设置成某个值,然后传入getElementsByName的参数值和id值一样,则这个元素是会被找到的,所以最好不好设置同样的值给id和name
document.getElementsByClassName
这个API是根据元素的class返回一个即时的HTMLCollection,用法如下
1 | var elements = document.getElementsByClassName(names); |
这个接口有下面几点要注意:
- 返回结果是一个即时的HTMLCollection,会随时根据文档结构变化
- IE9以下浏览器不支持
- 如果要获取2个以上classname,可传入多个classname,每个用空格相隔,例如
1 | var elements = document.getElementsByClassName("test1 test2"); |
document.querySelector和document.querySelectorAll
这两个api很相似,通过css选择器来查找元素,注意选择器要符合CSS选择器的规则。
首先来介绍一下document.querySelector。
document.querySelector返回第一个匹配的元素,如果没有匹配的元素,则返回null。
注意,由于返回的是第一个匹配的元素,这个api使用的深度优先搜索来获取元素。我们来看这个例子:
1 | <div> |
这个例子很简单,就是两个class都包含“test”的元素,一个在文档树的前面,但是它在第三级,另一个在文档树的后面,但它在第一级,通过querySelector获取元素时,它通过深度优先搜索,拿到文档树前面的第三级的元素。
document.querySelectorAll的不同之处在于它返回的是所有匹配的元素,而且可以匹配多个选择符,我们来看看下面这个例子
1 | <div class="test"> |
这段代码通过querySelectorAll,使用id选择器和class选择器选择了两个元素,并依次输出其内容。要注意两点:
(1)querySelectorAll也是通过深度优先搜索,搜索的元素顺序和选择器的顺序无关
(2)返回的是一个非即时的NodeList,也就是说结果不会随着文档树的变化而变化
兼容性问题:querySelector和querySelectorAll在ie8以下的浏览器不支持。
节点关系型api
在html文档中的每个节点之间的关系都可以看成是家谱关系,包含父子关系,兄弟关系等等,下面我们依次来看看每一种关系。
父关系型api
- parentNode:每个节点都有一个parentNode属性,它表示元素的父节点。Element的父节点可能是Element,Document或DocumentFragment。
- parentElement:返回元素的父元素节点,与parentNode的区别在于,其父节点必须是一个Element,如果不是,则返回null
兄弟关系型api
previousSibling:节点的前一个节点,如果该节点是第一个节点,则为null。注意有可能拿到的节点是文本节点或注释节点,与预期的不符,要进行处理一下。
previousElementSibling:返回前一个元素节点,前一个节点必须是Element,注意IE9以下浏览器不支持。
nextSibling:节点的后一个节点,如果该节点是最后一个节点,则为null。注意有可能拿到的节点是文本节点,与预期的不符,要进行处理一下。
nextElementSibling:返回后一个元素节点,后一个节点必须是Element,注意IE9以下浏览器不支持。
子关系型api
- childNodes:返回一个即时的NodeList,表示元素的子节点列表,子节点可能会包含文本节点,注释节点等。
- children:一个即时的HTMLCollection,子节点都是Element,IE9以下浏览器不支持。
- firstNode:第一个子节点
- lastNode:最后一个子节点
- hasChildNodes方法:可以用来判断是否包含子节点。
元素属性型api
setAttribute
setAttribute:根据名称和值修改元素的特性,用法如下。
1 | element.setAttribute(name, value); |
其中name是特性名,value是特性值。如果元素不包含该特性,则会创建该特性并赋值。
如果元素本身包含指定的特性名为属性,则可以世界访问属性进行赋值,比如下面两条代码是等价的:
1 | element.setAttribute("id","test"); |
getAttribute
getAttribute返回指定的特性名相应的特性值,如果不存在,则返回null或空字符串。用法如下:
1 | var value = element.getAttribute("id"); |
元素样式型api
window.getComputedStyle
window.getComputedStyle是用来获取应用到元素后的样式,假设某个元素并未设置高度而是通过其内容将其高度撑开,这时候要获取它的高度就要用到getComputedStyle,用法如下:
1 | var style = window.getComputedStyle(element[, pseudoElt]); |
element是要获取的元素,pseudoElt指定一个伪元素进行匹配。
返回的style是一个CSSStyleDeclaration对象。
通过style可以访问到元素计算后的样式
getBoundingClientRect
getBoundingClientRect用来返回元素的大小以及相对于浏览器可视窗口的位置,用法如下:
1 | var clientRect = element.getBoundingClientRect(); |
clientRect是一个DOMRect对象,包含left,top,right,bottom,它是相对于可视窗口的距离,滚动位置发生改变时,它们的值是会发生变化的。除了IE9以下浏览器,还包含元素的height和width等数据,具体可查看链接。
参考资料
- 阮一峰:JavaScript教程
- 狼狼的蓝胖子:Javascript操作DOM常用API总结