Java中文档工具模子DOM利用履历
当前位置：以往代写 > JAVA 教程 >Java中文档工具模子DOM利用履历

Java中文档工具模子DOM利用履历

2019-06-14

Java中文档工具模子DOM利用履历

Java中文档工具模子DOM利用履历

副标题#e#

文档工具模子 (DOM) 是一个文档尺度，对付完备的文档和巨大的应用措施，DOM 提供了大量机动性。DOM尺度是尺度的。它很强壮且完整，而且有很多实现。这是很多大型安装的抉择因素－－出格是对产物应用措施，以制止在API产生改变时举办大量的改写。

以上是我在选择处理惩罚XML数据时之所以没有选择JDOM可能dom4j等其它面向工具的尺度的原因，不外也由于DOM从一开始就是一种与语言无关的模子，并且它更趋向用于像C或Perl这类语言，没有操作Java的面向工具的机能，所以在利用的进程中也碰着了不少的贫苦，本日这里做一个小结。别的，我今朝利用XML主要是作为数据传输的统一名目，并统一用户界面展示的接口，应用的面并不是很广，所以利用到的DOM的内容其实不多。

在筹备利用它的时候，是做了富裕的筹备的，也有碰着坚苦的筹备，所以一开始就有了一个简朴的东西类来封装DOM工具利用时须要的民众要领，实际证明这样做是很明智的，一个简朴的建设Document工具的操纵，要是每次都需要写上5行以上代码，而且还要处理惩罚那些烦人的Exception，实在是会冲击各人的努力性，所以在最初，做了一个XMLTool类，专门封装了如下的民众要领：

1、Document工具建设（包罗空的Document工具建设，以一个给定Node节点作为根节点建设。

2、将一个类型的XML字符串转换成一个Document工具。

3、从物理硬盘读取一个XML文件并返回一个Document工具。

4、将一个Node工具转换成字符串。

个中每个要领都截获相关的DOM操纵所抛出的异常，转换成一个RuntimeException抛出，这些异常在实际利用进程中，一般状况下其实都不会抛出，出格是象生成一个Document工具时的ParserConfigurationException、转换Node节点成字符串时要生成一个Transformer工具时的TransformerConfigurationException等等，没有须要在它们身上花时间精神。并且真就出了相关的异常的话，其实基础没有步伐处理惩罚，这样的状况凡是是系统情况设置有问题（好比须要的DOM实现理会器等包没有插手情况），所以包装该异常时只是很扼要的获取其Message抛出。


#p#副标题#e#

代码如下：

/**
* 初始化一个空Document工具返回。
* @return a Document
*/
public static Document newXMLDocument() {
　try {
　　return newDocumentBuilder().newDocument();
　} catch (ParserConfigurationException e) {
　　　throw new RuntimeException(e.getMessage());
　}
}
/**
* 初始化一个DocumentBuilder
* @return a DocumentBuilder
* @throws ParserConfigurationException
*/
public static DocumentBuilder newDocumentBuilder()
throws ParserConfigurationException {
return newDocumentBuilderFactory().newDocumentBuilder();
}
/**
* 初始化一个DocumentBuilderFactory
* @return a DocumentBuilderFactory
*/
public static DocumentBuilderFactory newDocumentBuilderFactory() {
　DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
　dbf.setNamespaceAware(true);
　return dbf;
}
/**
* 将传入的一个XML String转换成一个org.w3c.dom.Document工具返回。
* @param xmlString 一个切合XML类型的字符串表达。
* @return a Document
*/
public static Document parseXMLDocument(String xmlString) {
　if (xmlString == null) {
　　throw new IllegalArgumentException();
　}
　try {
　　return newDocumentBuilder().parse(
　　　new InputSource(new StringReader(xmlString)));
　} catch (Exception e) {
　　throw new RuntimeException(e.getMessage());
　}
}
/**
* 给定一个输入流，理会为一个org.w3c.dom.Document工具返回。
* @param input
* @return a org.w3c.dom.Document
*/
public static Document parseXMLDocument(InputStream input) {
　if (input == null) {
　　throw new IllegalArgumentException("参数为null！");
　}
　try {
　　return newDocumentBuilder().parse(input);
　} catch (Exception e) {
　　throw new RuntimeException(e.getMessage());
　}
}
/**
* 给定一个文件名，获取该文件并理会为一个org.w3c.dom.Document工具返回。
* @param fileName 待理会文件的文件名
* @return a org.w3c.dom.Document
*/
public static Document loadXMLDocumentFromFile(String fileName) {
　if (fileName == null) {
　　throw new IllegalArgumentException("未指定文件名及其物理路径！");
　}
　try {
　　return newDocumentBuilder().parse(new File(fileName));
　} catch (SAXException e) {
　　throw new IllegalArgumentException("方针文件（" + fileName + "）不能被正确理会为XML！\n" + e.getMessage());
　} catch (IOException e) {
　　throw new IllegalArgumentException("不能获取方针文件（" + fileName + "）！\n" + e.getMessage());
　} catch (ParserConfigurationException e) {
　　throw new RuntimeException(e.getMessage());
　}
}
/**
* 给定一个节点，将该节点插手新结构的Document中。
* @param node a Document node
* @return a new Document
*/
public static Document newXMLDocument(Node node) {
　Document doc = newXMLDocument();
　doc.appendChild(doc.importNode(node, true));
　return doc;
}
/**
* 将传入的一个DOM Node工具输出成字符串。假如失败则返回一个空字符串""。
* @param node DOM Node 工具。
* @return a XML String from node
*/
public static String toString(Node node) {
　if (node == null) {
　　throw new IllegalArgumentException();
　}
　Transformer transformer = newTransformer();
　if (transformer != null) {
　　try {
　　　StringWriter sw = new StringWriter();
　　　transformer.transform(new DOMSource(node),
　　　　new StreamResult(sw));
　　　　return sw.toString();
　　} catch (TransformerException te) {
　　　throw new RuntimeException(te.getMessage());
　　}
　}
　return errXMLString("不能生成XML信息！");
}
/**
* 将传入的一个DOM Node工具输出成字符串。假如失败则返回一个空字符串""。
* @param node DOM Node 工具。
* @return a XML String from node
*/
public static String toString(Node node) {
　if (node == null) {
　　throw new IllegalArgumentException();
　}
　Transformer transformer = newTransformer();
　if (transformer != null) {
　　try {
　　　StringWriter sw = new StringWriter();
　　　transformer.transform(new DOMSource(node),new StreamResult(sw));
　　　return sw.toString();
　　} catch (TransformerException te) {
　　　　throw new RuntimeException(te.getMessage());
　　}
　}
　return errXMLString("不能生成XML信息！");
}
/**
* 获取一个Transformer工具，由于利用时都做沟通的初始化，所以提取出来作为民众要领。
* @return a Transformer encoding gb2312
*/
public static Transformer newTransformer() {
　try {
　　Transformer transformer =TransformerFactory.newInstance().newTransformer();
　　Properties properties = transformer.getOutputProperties();
　　properties.setProperty(OutputKeys.ENCODING, "gb2312");
　　properties.setProperty(OutputKeys.METHOD, "xml");
　　properties.setProperty(OutputKeys.VERSION, "1.0");
　　properties.setProperty(OutputKeys.INDENT, "no");
　　transformer.setOutputProperties(properties);
　　return transformer;
　} catch (TransformerConfigurationException tce) {
　　throw new RuntimeException(tce.getMessage());
　}
}
/**
* 返回一段XML表述的错误信息。提示信息的TITLE为：系统错误。之所以利用字符串拼装，主要是这样做一般
* 不会有异常呈现。
* @param errMsg 提示错误信息
* @return a XML String show err msg
*/
public static String errXMLString(String errMsg) {
　StringBuffer msg = new StringBuffer(100);
　msg.append("<?xml version=\"1.0\" encoding=\"gb2312\" ?>");
　msg.append("<errNode title=\"系统错误\" errMsg=\"" + errMsg + "\"/>");
　return msg.toString();
}
/**
* 返回一段XML表述的错误信息。提示信息的TITLE为：系统错误
* @param errMsg 提示错误信息
* @param errClass 抛出该错误的类，用于提取错误来历信息。
* @return a XML String show err msg
*/
public static String errXMLString(String errMsg, Class errClass) {
　StringBuffer msg = new StringBuffer(100);
　msg.append("<?xml version=\"1.0\" encoding=\"gb2312\" ?>");
　msg.append("<errNode title=\"系统错误\" errMsg=\""+ errMsg
　　+ "\" errSource=\""
　　+ errClass.getName()
　　+ "\"/>");
　return msg.toString();
}
/**
* 返回一段XML表述的错误信息。
* @param title 提示的title
* @param errMsg 提示错误信息
* @param errClass 抛出该错误的类，用于提取错误来历信息。
* @return a XML String show err msg
*/
public static String errXMLString(
　String title,
　String errMsg,
　Class errClass) {
　　StringBuffer msg = new StringBuffer(100);
　　msg.append("<?xml version=\"1.0\" encoding=\"gb2312\" ?>");
　　msg.append("<errNode title=\""
　　　+ title
　　　+ "\" errMsg=\""
　　　+ errMsg
　　　+ "\" errSource=\""
　　　+ errClass.getName()
　　　+ "\"/>");
　　return msg.toString();
　}

#p#副标题#e#

以上都是DOM的根基应用，所以就纷歧一具体说明白。

在实际利用进程中，有几种状况利用很频繁，可是DOM的接口的设计却使该操纵很贫苦，所以别离添加了相应的处理惩罚要领。

个中最贫苦的要数获取一个节点的Text子节点文本信息了，如下的XML节点：

<element>
text
</element>

#p#分页标题#e#

在拥有element节点工具时，要获取个中的文本信息"text"，首先要获取element节点的子节点列表，要判定其是否存在子节点，假如存在，那么遍历其子节点找到一个TextNode节点，通过getNodeValue()要领来获取该文本信息，由于这里element节点没有信息时没有子节点，所以必需判定element节点是否存在子节点才气去会见真正包括了文本信息的TextNode节点，那么假如要处理惩罚的数据都是以这种形式给出的，就会增加大量的开拓代码同时让开拓事情枯燥无味，因此这里利用了一个默认的约定实现，就是，给出了一个民众要领，该要领取给定Node下的直接子节点的Text节点文本信息，假如不存在Text节点则返回null，这个约定固然使该要领的利用有所限制，也大概导致错误利用该要领，可是，按实际利用的状况来看，这样的约定和利用方法是没有问题的，因为实际用到的都是上面举的例子的状况，代码：

#p#分页标题#e#

/**
* 这个要领获取给定Node下的Text节点文本信息，假如不存在Text节点则返回null。
* 留意：是直接子节点，相差2层或2层以上不会被思量。
* @param node a Node 一个Node。
* @return a String 假如给定节点存在Text子节点，则返回第一个会见到的Text子节点文本信息，假如不存在则返回null。
*/
public static String getNodeValue(Node node) {
　 if (node == null) {
　　 return null;
　 }
　 Text text = getTextNode(node);
　 if (text != null) {
　　 return text.getNodeValue();
　 }
　 return null;
}
/**
* 这个要领获取给定Node下的Text节点，假如不存在Text节点则返回null。
* 留意：是直接子节点，相差2层或2层以上不会被思量。
* @param node a Node 一个Node。
* @return a Text 假如给定节点存在Text子节点，则返回第一个会见到的Text子节点，假如不存在则返回null。
*/
public static Text getTextNode(Node node) {
　 if (node == null) {
　　 return null;
　 }
　 if (node.hasChildNodes()) {
　　 NodeList list = node.getChildNodes();
　　 for (int i = 0; i < list.getLength(); i++) {
　　　 if (list.item(i).getNodeType() == Node.TEXT_NODE) {
　　　　 return (Text) list.item(i);
　　　 }
　　 }
　 }
　 return null;
}

#p#副标题#e#

上面代码将获取给定Node节点的直接Text子节点分隔包装。

另一个很常常遇到的状况是，我但愿直接定位到方针节点，获取该节点工具，而不需要通过一层一层的节点遍向来找到方针节点，DOM2接口中至少提供了如下的方法来定位节点：

1、对付Document工具：

1） getDocumentElement()――获取根节点工具，实际很少利用的，因为根节点根基也就只是根节点罢了，实际的数据节点都是根节点下的直接子节点开始的。

2） getElementById(String elementId)――这个要领原来应该是一个最佳的定位要领，可是在实际利用进程中没有被我利用，其主要原因就是，这里的"ID"差异于一个节点的属性"ID"，这在org.w3c.dom.Document的API说明中是明晰指出，而我找了不少的资料也没有看到有关的利用方法，所以只好放弃了。

3） getElementsByTagName(String tagname)――这个要领其实是没有步伐的选择，只好用它了，不外实际倒也很适用，固然该要领返回的是一个NodeList，可是实际利用时，将节点的tagName设计成非凡字符串，那么就可以直接获取了，而实际利用时，其实也差不多，许多时候会直接拿数据库中的字段名来作为tagName，以利便得获取该字段得值，在一个简朴得约定下，利用了如下要领：

/**
* 这个要领检索参数element下所有TagName为：tagName的节点，并返回节点列表的第一个节点。
* 假如不存在该tagName的节点，则返回null。
* @param element 待搜索节点
* @param tagName 待搜索标签名
* @return a Element 得到以tagName为标签名的节点列表的第一个节点。
*/
public static Element getFirstElementByName(
　 Element element,String tagName) {
　　 return (Element) getFirstElement(element.getElementsByTagName(tagName));
}
/**
* 从给定节点列表中获取第一个节点返回，假如节点荟萃为null/空，则返回null。
* @param nodeList a NodeList
* @return a Node
*/
private static Node getFirstElement(NodeList nodeList) {
　 if (nodeList == null || nodeList.getLength() == 0) {
　　 return null;
　 }
　 return nodeList.item(0);
}

这个约定看似限制很大，其实实际利用时根基都是这样的，只要获取第一个给定tagName的Element节点就可以了的。

4）getElementsByTagNameNS(String namespaceURI, String localName)――这个要领根基没有利用，因为还没有遇到需要利用定名空间的状况。

2、对付Element工具――――Element工具和Document工具类似，少了getDocumentElement()要领，不外和Document一样也都是主要利用getElementsByTagName()要领。

3、其它的节点工具根基没有直接定位的会见要领

#p#分页标题#e#

尚有一种，是由于DOM2的限制导致的，DOM2类型中，不能将一个Document docA的节点直接插手到另一个Document docB工具的节点的子节点列表中，要这么做必需首先将docA的节点通过docB的importNode要领转换后在添加到方针节点的子节点列表中，所以也有一个要领来统一处理惩罚：

/**
* 这个要领将参数appendedDoc的根节点及其以下节点附加到doc的跟节点下面。
* 作为doc的跟节点的作后一个子节点。
* 相当于：doc.appendDoc(appendedDoc);
* @param doc a Document
* @param appendedDoc a Document
*/
public static void appendXMLDocument(Document doc, Document appendedDoc) {
　 if (appendedDoc != null) {
　　 doc.getFirstChild().appendChild(
　　 doc.importNode(appendedDoc.getFirstChild(), true));
　 }
}
/**
* 这个要领将参数appendedDoc的根节点及其以下节点附加到node节点下面。
* 作为node节点的作后一个子节点。
* 相当于：node.appendDoc(appendedNode);
* @param node 待添加的节点将被添加到该节点的最后。
* @param appendedNode a Node 这个节点将被添加作为node节点的最后一个子节点。
*/
public static void appendXMLDocument(Node node, Node appendedNode) {
　 if (appendedNode == null) {
　　 return;
　 }
　 if (appendedNode instanceof Document) {
　　 appendedNode = ((Document) appendedNode).getDocumentElement();
　 }
　 node.appendChild(node.getOwnerDocument().importNode(appendedNode, true));
}

根基上就这些常用的了，其它尚有一些琐屑的要领，不外都不常用到，就不作先容了。

    关键字：

在线提交作业