JAVASCRIPT中使用DOM操做XML文档

时间 2019-11-24

标签 javascript 使用 dom xml 文档栏目 JavaScript 繁體版

原文原文链接

<script language="JavaScript">

</script>

    在DOM眼中，HTML跟XML同样是一种树形结构的文档，<html>是根（root）节点，<head>、<title>、<body>是<html>的子（children）节点，互相之间是兄弟（sibling）节点；<body>下面才是子节点<table>、<span>、<p>等等。以下图：

    这个是否是跟XML的结构有点类似呢。不一样的是，HTML文档的树形主要包含表示元素、标记的节点和表示文本串的节点。

HTML 文档的节点

DOM下，HTML文档各个节点被视为各类类型的Node对象。每一个Node对象都有本身的属性和方法，利用这些属性和方法能够遍历整个文档树。因为HTML文档的复杂性，DOM定义了nodeType来表示节点的类型。这里列出Node经常使用的几种节点类型：

接口	nodeType常量	nodeType值	备注
Element	Node.ELEMENT_NODE	1	元素节点
Text	Node.TEXT_NODE	3	文本节点
Document	Node.DOCUMENT_NODE	9	document
Comment	Node.COMMENT_NODE	8	注释的文本
DocumentFragment	Node.DOCUMENT_FRAGMENT_NODE	11	document片段
Attr	Node.ATTRIBUTE_NODE	2	节点属性

DOM树的根节点是个Document对象，该对象的documentElement属性引用表示文档根元素的Element对象（对于HTML文档，这个就是<html>标记）。Javascript操做HTML文档的时候，document即指向整个文档，<body>、<table>等节点类型即为Element。Comment类型的节点则是指文档的注释。具体节点类型的含义，请参考《Javascript权威指南》，在此不赘述。

Document定义的方法大多数是生产型方法，主要用于建立能够插入文档中的各类类型的节点。经常使用的Document方法有：

方法	描述
createAttribute()	用指定的名字建立新的Attr节点。
createComment()	用指定的字符串建立新的Comment节点。
createElement()	用指定的标记名建立新的Element节点。
createTextNode()	用指定的文本建立新的TextNode节点。
getElementById()	返回文档中具备指定id属性的Element节点。
getElementsByTagName()	返回文档中具备指定标记名的全部Element节点。

对于Element节点，能够经过调用getAttribute()、setAttribute()、removeAttribute()方法来查询、设置或者删除一个Element节点的性质，好比<table>标记的border属性。下面列出Element经常使用的属性：

属性	描述
tagName	元素的标记名称，好比<p>元素为P。HTML文档返回的tabName均为大写。

Element经常使用的方法：

方法	描述
getAttribute()	以字符串形式返回指定属性的值。
getAttributeNode()	以Attr节点的形式返回指定属性的值。
getElementsByTabName()	返回一个Node数组，包含具备指定标记名的全部Element节点的子孙节点，其顺序为在文档中出现的顺序。
hasAttribute()	若是该元素具备指定名字的属性，则返回true。
removeAttribute()	从元素中删除指定的属性。
removeAttributeNode()	从元素的属性列表中删除指定的Attr节点。
setAttribute()	把指定的属性设置为指定的字符串值，若是该属性不存在则添加一个新属性。
setAttributeNode()	把指定的Attr节点添加到该元素的属性列表中。

Attr对象表明文档元素的属性，有name、value等属性，能够经过Node接口的attributes属性或者调用Element接口的getAttributeNode()方法来获取。不过，在大多数状况下，使用Element元素属性的最简单方法是getAttribute()和setAttribute()两个方法，而不是Attr对象。

使用 DOM操做HTML 文档

Node对象定义了一系列属性和方法，来方便遍历整个文档。用parentNode属性和childNodes[]数组能够在文档树中上下移动；经过遍历childNodes[]数组或者使用firstChild和nextSibling属性进行循环操做，也可使用lastChild和previousSibling进行逆向循环操做，也能够枚举指定节点的子节点。而调用appendChild()、insertBefore()、removeChild()、replaceChild()方法能够改变一个节点的子节点从而改变文档树。

须要指出的是，childNodes[]的值其实是一个NodeList对象。所以，能够经过遍历childNodes[]数组的每一个元素，来枚举一个给定节点的全部子节点；经过递归，能够枚举树中的全部节点。下表列出了Node对象的一些经常使用属性和方法：

Node对象经常使用属性：

属性	描述
attributes	若是该节点是一个Element，则以NamedNodeMap形式返回该元素的属性。
childNodes	以Node[]的形式存放当前节点的子节点。若是没有子节点，则返回空数组。
firstChild	以Node的形式返回当前节点的第一个子节点。若是没有子节点，则为null。
lastChild	以Node的形式返回当前节点的最后一个子节点。若是没有子节点，则为null。
nextSibling	以Node的形式返回当前节点的兄弟下一个节点。若是没有这样的节点，则返回null。
nodeName	节点的名字，Element节点则表明Element的标记名称。
nodeType	表明节点的类型。
parentNode	以Node的形式返回当前节点的父节点。若是没有父节点，则为null。
previousSibling	以Node的形式返回紧挨当前节点、位于它以前的兄弟节点。若是没有这样的节点，则返回null。

Node对象经常使用方法：

方法	描述
appendChild()	经过把一个节点增长到当前节点的childNodes[]组，给文档树增长节点。
cloneNode()	复制当前节点，或者复制当前节点以及它的全部子孙节点。
hasChildNodes()	若是当前节点拥有子节点，则将返回true。
insertBefore()	给文档树插入一个节点，位置在当前节点的指定子节点以前。若是该节点已经存在，则删除之再插入到它的位置。
removeChild()	从文档树中删除并返回指定的子节点。
replaceChild()	从文档树中删除并返回指定的子节点，用另外一个节点替换它。

接下来，让咱们使用上述的DOM应用编程接口，来试着操做HTML 文档。

A、遍历文档的节点

DOM把一个HTML文档视为树，所以，遍历整个树是应该是屡见不鲜。跟以前说过的同样，这里咱们提供两个遍历树的例子。经过它，咱们可以学会如何使用childNodes[]和firstChile、lastChild、nextSibling、previousSibling遍历整棵树。

例子1-- sample3_1.htm：

这个例子使用了childNodes[]和递归方式来遍历整个文档，统计文档中出现的Element元素总数，并把Element标记名所有打印出来。须要特别注意的是，在使用DOM时，必须等文档被装载完毕再执行遍历等行为操做文档。sample3_1.htm具体代码以下：

<html>

<head>

<title>无标题文档</title>

var elementName = ""; //全局变量，保存Element标记名，使用完毕要清空

function countTotalElement(node) { //参数node是一个Node对象

var total = 0;

if(node.nodeType == 1) { //检查node是否为Element对象

total++; //若是是，计数器加1

elementName = elementName + node.tagName + "\r\n"; //保存标记名

}

var childrens = node.childNodes; //获取node的所有子节点

for(var i=0;i<childrens.length;i++) {

total += countTotalElement(childrens[i]); //在每一个子节点上进行递归操做

}

return total;

}

</script>

</head>

<body>

<a href="javascript:void(0)"

onClick="alert('标记总数：' + countTotalElement(document) + '\r\n所有标记以下：\r\n' + elementName);elementName='';">开始统计</a>

</body>

</html>

运行效果以下：

例子2 – sample3_2.htm：

接下来使用firstChile、lastChild、nextSibling、previousSibling遍历整个文档树。修改一下countTotalElement函数，其余跟sample3_1.htm同样：

function countTotalElement(node) { //参数node是一个Node对象

var total = 0;

if(node.nodeType == 1) { //检查node是否为Element对象

total++; //若是是，计数器加1

elementName = elementName + node.tagName + "\r\n"; //保存标记名

}

var childrens = node.childNodes; //获取node的所有子节点

for(var m=node.firstChild; m!=null;m=m.nextSibling) {

total += countTotalElement(m); //在每一个子节点上进行递归操做

}

return total;

}

B、搜索文档中特定的元素

在使用DOM的过程当中，有时候须要定位到文档中的某个特定节点，或者具备特定类型的节点列表。这种状况下，能够调用Document对象的getElementsByTagName()和getElementById()方法来实现。

document.getElementsByTagName()返回文档中具备指定标记名的所有Element节点数组（也是NodeList类型）。Element出如今数组中的顺序就是他们在文档中出现的顺序。传递给getElementsByTagName()的参数忽略大小写。好比，想定位到第一个<table>标记，能够这样写：document.getElementsByTagName(“table”)[0]。例外的，可使用document.body定位到<body>标记，由于它是惟一的。

getElementsByTagName()返回的数组取决于文档。一旦文档改变，返回结果也当即改变。相比，getElementById()则比较灵活，能够随时定位到目标，只是要实现给目标元素一个惟一的id属性值。这个咱们在《AJAX开发简略》的“级联菜单”例子中已经使用过了。

Element对象也支持getElementsByTagName()和getElementById()。不一样的是，搜索领域只针对调用者的子节点。

C、修改文档内容

遍历整棵文档树、搜索特定的节点，咱们最终目的之一是要修改文档内容。接下来的三个例子将使用Node的几个经常使用方法，来演示如何修改文档内容。

例子3 -- sample4_1.htm：

这个例子包含三个文本节点和一个按钮。点击按钮后，三个文本节点和按钮的顺序将被颠倒。程序使用了Node的appendChild()和removeChild()方法。

<html>

<head>

<title>无标题文档</title>

function reverseNode(node) { // 颠倒节点node的顺序

var kids = node.childNodes; //获取子节点列表

var kidsNum = kids.length; //统计子节点总数

for(var i=kidsNum-1;i>=0;i--) { //逆向遍历子节点列表

var c = node.removeChild(kids[i]); //删除指定子节点，保存在c中

node.appendChild(c); //将c放在新位置上

}

</script>

</head>

<body>

<p><input type="button" name="reverseGo" value="颠倒"

onClick="reverseNode(document.body)"></p>

</body>

</html>

例子4-- sample4_2.htm：

例子1经过直接操做body的子节点来修改文档。在HTML文档中，布局和定位经常经过表格<table>来实现。所以，例子4将演示操做表格内容，将表格的四个单元行顺序颠倒。若是没有使用<tbody>标签，则<table>把所有的<tr>当作是属于一个子节点<tbody>，因此咱们采用数组缓存的方式，把行数据颠倒一下。这个例子同时也演示了如何使用DOM建立表格单元行。

<html>

<head>

<title>无标题文档</title>

function reverseTable() {

var node = document.getElementsByTagName("table")[0]; //第一个表格

var child = node.getElementsByTagName("tr"); //取得表格内的全部行

var newChild = new Array(); //定义缓存数组，保存行内容

for(var i=0;i<child.length;i++) {

newChild[i] = child[i].firstChild.innerHTML;

}

node.removeChild(node.childNodes[0]); //删除所有单元行

var header = node.createTHead(); //新建表格行头

for(var i=0;i<newChild.length;i++) {

var headerrow = header.insertRow(i); //插入一个单元行

var cell = headerrow.insertCell(0); //在单元行中插入一个单元格

//在单元格中建立TextNode节点

cell.appendChild(document.createTextNode(newChild[newChild.length-i-1]));

}

</script>

</head>

<body>

<tr>

</tr>

<tr>

</tr>

<tr>

</tr>

<tr>

</tr>

</table>

<br>

</body>

</html>

例子5 -- sample4_3.htm：

正如咱们在Node节点介绍部分所指出的那样，appendChild()、replaceChild()、removeChild()、insertBefore()方法会当即改变文档的结构。下面的例子包含两个表格，咱们试着把表格二的内容替换表格一的内容。

<html>

<head>

<title>无标题文档</title>

function replaceContent() {

var table1 = document.getElementsByTagName("table")[0];

var table2 = document.getElementsByTagName("table")[1];

var kid1 = table1.firstChild.firstChild.firstChild; //定位到<td>节点

var kid2 = table2.firstChild.firstChild.firstChild; //定位到<td>节点

var repKid = kid2.firstChild; //定位到表格二<td>内含的TextNode节点

try {

//用表格二的单元格内容替换表格一的单元格内容，表格二变成没有单元格内容

kid1.replaceChild(repKid,kid1.firstChild);

//下面注释若是开放，将出现object error，由于表格二已经被改变

//kid2.replaceChild(kid1.firstChild,kid2.firstChild);

}catch(e){

alert(e);

}

</script>

</head>

<body>

<tbody>

<tr>

</tr>

</tbody>

</table>

<br>

<tbody>

<tr>

</tr>

</tbody>

</table>

<br>

</body>

</html>

注意，当执行kid1.replaceChild(repKid,kid1.firstChild);的时候，table2的子节点已经被转移到table1了，table2已经没有子节点，不能再调用table2的子节点。看看代码的注释，试着运行一下，应该就知道文档是怎么改变的了。

D、往文档添加新内容

在学会遍历、搜索、修改文档以后，咱们如今试着网文档添加新的内容。其实没有什么新意，只是利用咱们上述提到的Node的属性和方法而已，仍是操做<table>标记的内容。有新意的是，咱们要实现一个留言簿。是的，留言簿，你能够往里面留言，只是不能刷新噢。

例子6 – sample5_1.htm：

<html>

<head>

<title>无标题文档</title>

function insertStr() {

var f = document.form1;

var value = f.str.value;

if(value!="") {

// 从最终的TextNode节点开始，慢慢造成<tbody>结构

var text = document.createTextNode(value); //新建一个TextNode节点

var td = document.createElement("td"); //新建一个td类型的Element节点

var tr = document.createElement("tr"); //新建一个tr类型的Element节点

var tbody = document.createElement("tbody"); //新建一个tbody类型的Element节点

td.appendChild(text); //将节点text加入td中

tr.appendChild(td); //将节点td加入tr中

tbody.appendChild(tr); //将节点tr加入tbody中

var parNode = document.getElementById("table1"); //定位到table上

parNode.insertBefore(tbody,parNode.firstChild); //将节点tbody插入到节点顶部

//parNode.appendChild(tbody); //将节点tbody加入节点尾部

}

</script>

</head>

<body>

</form>

<tbody>

<tr>

<td height="25">网友留言列表：</td>

</tr>

</tbody>

</table>

</body>

</html>

咱们以前说过，<table>的子节点是<tbody>，<tbody>的子节点才是<tr>，<tr>是<td>的父节点，最后<td>内部的TextNode节点。因此，往<table>增长单元格行要逐级造成，就像往树里面添加一个枝桠同样，要有叶子有径。看看，这个留言簿是否是很简单啊。这个例子同时也演示了往<table>表格标记里面增长内容的另外一种方法。

E使用DOM操做XML文档

在数据表示方面，XML文档更加结构化。DOM在支持HTML的基础上提供了一系列的API，支持针对XML的访问和操做。利用这些API，咱们能够从XML中提取信息，动态的建立这些信息的HTML呈现文档。处理XML文档，一般遵循“加载XML文档à提取信息à加工信息à建立HTML文档”的过程。下面的例子演示了如何加载并处理XML文档。

这个例子包含两个JS函数。loadXML()负责加载XML文档，其中既包含加载XML文档的2级DOM代码，又有实现一样操做的Microsoft专有API代码。须要提醒注意的是，文档加载过程不是瞬间完成的，因此对loadXML()的调用将在加载文档完成以前返回。所以，须要传递给loadXML()一个引用，以便文档加载完成后调用。

例子中的另一个函数makeTable()，则在XML文档加载完毕以后，使用最后前介绍过的DOM应用编程接口读取XML文档信息，并利用这些信息造成一个新的table表格。

例子7 -- sample6_1.htm：

<html>

<head>

<title>无标题文档</title>

function loadXML(handler) {

var url = "employees.xml";

if(document.implementation&&document.implementation.createDocument) {

var xmldoc = document.implementation.createDocument("", "", null);

xmldoc.onload = handler(xmldoc, url);

xmldoc.load(url);

}

else if(window.ActiveXObject) {

var xmldoc = new ActiveXObject("Microsoft.XMLDOM");

xmldoc.onreadystatechange = function() {

if(xmldoc.readyState == 4) handler(xmldoc, url);

}

xmldoc.load(url);

}

function makeTable(xmldoc, url) {

var table = document.createElement("table");

table.setAttribute("border","1");

table.setAttribute("width","600");

table.setAttribute("class","tab-content");

document.body.appendChild(table);

var caption = "Employee Data from " + url;

table.createCaption().appendChild(document.createTextNode(caption));

var header = table.createTHead();

var headerrow = header.insertRow(0);

headerrow.insertCell(0).appendChild(document.createTextNode("姓名"));

headerrow.insertCell(1).appendChild(document.createTextNode("职业"));

headerrow.insertCell(2).appendChild(document.createTextNode("工资"));

var employees = xmldoc.getElementsByTagName("employee");

for(var i=0;i<employees.length;i++) {

var e = employees[i];

var name = e.getAttribute("name");

var job = e.getElementsByTagName("job")[0].firstChild.data;

var salary = e.getElementsByTagName("salary")[0].firstChild.data;

var row = table.insertRow(i+1);

row.insertCell(0).appendChild(document.createTextNode(name));

row.insertCell(1).appendChild(document.createTextNode(job));

row.insertCell(2).appendChild(document.createTextNode(salary));

}

</script>

</head>

</body>

</html>

供读取调用的XML文档 – employees.xml：

<?xml version="1.0" encoding="gb2312"?>

<job>Programmer</job>

</employee>

<job>Sales</job>

</employee>

</employee>

</employees>

处理 XML文档

脱离XML文档的AJAX是不完整的。在本部分未完成以前，有读者说AJAX更名叫AJAH（H应该表明HTML吧）比较合适。应该认可，XML文档在数据的结构化表示以及接口对接上有先天的优点，但也不是全部的数据都应该用XML表示。有些时候单纯的文本表示可能会更合适。下面先举个AJAX处理返回XML文档的例子再讨论何时使用XML。

7.5.1 、处理返回的XML

例子8 -- sample7_1.htm：

在这个例子中，咱们采用以前肯定的AJAX开发框架，稍微修改一下body内容和proce***equest的相应方式，将先前的employees.xml的内容读取出来并显示。

body的内容以下：

<input type="button" name="read"

value="读取XML" onClick="send_request('employees.xml')">

proce***equest()方法修改以下：

// 处理返回信息的函数

function proce***equest() {

if (http_request.readyState == 4) { // 判断对象状态

if (http_request.status == 200) { // 信息已经成功返回，开始处理信息

var returnObj = http_request.responseXML;

var xmlobj = http_request.responseXML;

var employees = xmlobj.getElementsByTagName("employee");

var feedbackStr = "";

for(var i=0;i<employees.length;i++) { // 循环读取employees.xml的内容

var employee = employees[i];

feedbackStr += "员工：" + employee.getAttribute("name");

feedbackStr +=

" 职位：" + employee.getElementsByTagName("job")[0].firstChild.data;

feedbackStr +=

" 工资：" + employee.getElementsByTagName("salary")[0].firstChild.data;

feedbackStr += "\r\n";

}

alert(feedbackStr);

} else { //页面不正常

alert("您所请求的页面有异常。");

}

运行一下，看来效果还不错：

7.5.2 、选择合适的XML生成方式

如今的web应用程序每每采用了MVC三层剥离的设计方式。XML做为一种数据保存、呈现、交互的文档，其数据每每是动态生成的，一般由JavaBean转换过来。由JavaBean转换成XML文档的方式有好几种，选择合适的转换方式每每能达到事半功倍的效果。下面介绍两种经常使用的方式，以便须要的时候根据状况取舍。

A、类自行序列化成XML

类自行序列化成XML即每一个类都实现本身的toXML()方法，选择合适的API、适当的XML结构、尽可能便捷的生成逻辑快速生成相应的XML文档。显然，这种方式必需要求每一个类编写专门的XML生成代码，每一个类只能调用本身的toXML()方法。应用诸如JDOM等一些现成的API，能够减小很多开发投入。例子9是一个利用JDOM的API造成的toXML()方法。

例子9 -- toXml() 的 JDOM 实现 -- Employ类的toXml()方法：

public Element toXml() {

Element employee = new Element(“employee”);

Employee.setAttribute(“name”,name);

Element jobE = new Element(“job”).addContent(job);

employee.setContent(jobE);

Element salaryE = new Element(“salary”).addContent(salary);

employee.setContent(salaryE);

return employee;

}

JDOM提供了现成的API，使得序列化成XML的工做更加简单，咱们只须要把toXML()外面包装一个Document，而后使用XMLOutputter把文档写入servlet就能够了。toXml()容许递归调用其子类的toXML()方法，以便生成包含子图的XML文档。

使用类自行序列化成XML的方式，要每一个类都实现本身的toXML()方法，并且存在数据模型与视图耦合的问题，即要么为每一个可能的视图编写独立的toXML()方法，要么心甘情愿接收冗余的数据，一旦数据结构或者文档发生改变，toXML()就要作必要的修改。

B、页面模板生成XML方式

通常的，能够采用通用的页面模板技术来生成XML文档，这个XML文档能够符合任何须要的数据模型，供AJAX灵活的调用。另外，模板能够采用任何标记语言编写，提升工做效率。下面是一个采用Struts标签库编写的XML文档，输出以前提到的employees.xml：

Sample8_2.jsp：

<%@ page contentType="application/xml; charset=gb2312" import="Employee"%>

<%@ page import="java.util.Collection,java.util.ArrayList"%>

<?xml version="1.0"?>

<%@ taglib uri="/WEB-INF/struts-logic.tld" prefix="logic" %>

<%@ taglib uri="/WEB-INF/struts-bean.tld" prefix="bean"%>

Employee em1 = new Employee();

em1.setName("J.Doe");

em1.setJob("Programmer");

em1.setSalary("32768");

Employee em2 = new Employee();

em2.setName("A.Baker");

em2.setJob("Sales");

em2.setSalary("70000");

Employee em3 = new Employee();

em3.setName("Big Cheese");

em3.setJob("CEO");

em3.setSalary("100000");

Collection employees = new ArrayList();

employees.add(em1);

employees.add(em2);

employees.add(em3);

pageContext.setAttribute("employees",employees);

<logic:iterate name="employees" id="employee">

</employee>

</logic:iterate>

</employees>

采用页面模板生成XML方式，须要为每一个须要的的数据模型创建一个对立的JSP文件，用来生成符合规范的XML文档，而不能仅仅在类的toXML()方法中组织对象图来实现。不过，却是能够更加方便的确保标记匹配、元素和属性的顺序正确以及XML实体正确转义。

参考资料中Philip McCarthy的文章还描述了一种Javascript对象标注的生成方式，本文在此不赘述。有兴趣的读者能够自行查看了解。

7.5.3 、如何在使用XML仍是普通文本间权衡

使用XML文档确实有其方便之处。不过XML文档的某些问题却是要考虑一下，好比说延迟，即服务器不能当即解析XML文档成为DOM模型。这个问题在必定程度上会影响AJAX要求的快速反应能力。另外，某些状况下咱们并不须要使用XML来表示数据，好比说数据足够简单成只有一个字符串而已。就好像咱们以前提到的数据校验和级联菜单的例子同样。因此，我的认为在下面这些状况下能够考虑使用XML来做为数据表示的介质：

l 数据比较复杂，须要用XML的结构化方式来表示

l 不用考虑带宽和处理效率支出

l 与系统其余API或者其余系统交互，做为一种数据中转中介

l 须要特定各式的输出视图而文本没法表示的

总之，要认真评估两种表示方式的表示成本和效率，选择合适的合理的表示方式