package com.github.looly.hutool;
import java.io.BufferedWriter;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
import com.github.looly.hutool.exceptions.UtilException;
/**
* XML工具类<br>
* 此工具使用w3c dom工具，不需要依赖第三方包。
*
* @author xiaoleilu
*
*/
public class XmlUtil {
/** 在XML中无效的字符 正则 */
public final static String INVALID_REGEX = "[\\x00-\\x08\\x0b-\\x0c\\x0e-\\x1f]";
// -------------------------------------------------------------------------------------- Read
/**
* 读取解析XML文件
*
* @param file XML文件
* @return XML文档对象
*/
public static Document readXML(File file) {
if (file == null) {
throw new NullPointerException("Xml file is null !");
}
if (file.exists() == false) {
throw new UtilException("File [" + file.getAbsolutePath() + "] not a exist!");
}
if (file.isFile() == false) {
throw new UtilException("[" + file.getAbsolutePath() + "] not a file!");
}
try {
file = file.getCanonicalFile();
} catch (IOException e) {
}
final DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
try {
final DocumentBuilder builder = dbf.newDocumentBuilder();
return builder.parse(file);
} catch (Exception e) {
throw new UtilException("Parse xml file [" + file.getAbsolutePath() + "] error!", e);
}
}
/**
* 读取解析XML文件
*
* @param absoluteFilePath XML文件绝对路径
* @return XML文档对象
*/
public static Document readXML(String absoluteFilePath) {
return readXML(new File(absoluteFilePath));
}
/**
* 将String类型的XML转换为XML文档
*
* @param xmlStr XML字符串
* @param charset
* @return XML文档
*/
public static Document parseXml(String xmlStr, String charset) {
if (StrUtil.isBlank(xmlStr)) {
throw new UtilException("Xml content string is empty !");
}
xmlStr = cleanInvalid(xmlStr);
final DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
try {
final DocumentBuilder builder = dbf.newDocumentBuilder();
return builder.parse(IoUtil.toStream(xmlStr, charset));
} catch (Exception e) {
throw new UtilException("Parse xml file [" + xmlStr + "] error!", e);
}
}
/**
* 将String类型的XML转换为XML文档
*
* @param xmlStr XML字符串
* @return XML文档
*/
public static Document parseXml(String xmlStr) {
return parseXml(xmlStr, null);
}
// -------------------------------------------------------------------------------------- Write
/**
* 将XML文档转换为String
*
* @param doc XML文档
* @return XML字符串
*/
public static String xmlToStr(Document doc) {
try {
Source source = new DOMSource(doc);
ByteArrayOutputStream outStream = new ByteArrayOutputStream();
final Transformer xformer = TransformerFactory.newInstance().newTransformer();
// xformer.setOutputProperty(OutputKeys.ENCODING, encoding);
xformer.transform(source, new StreamResult(outStream));
return outStream.toString();
} catch (Exception e) {
throw new UtilException("Trans xml document to string error!", e);
}
}
/**
* 将XML文档写入到文件
*
* @param doc XML文档
* @param absolutePath 文件绝对路径，不存在会自动创建
* @param charset 字符集
*/
public static void xmlToFile(Document doc, String absolutePath, String charset) {
BufferedWriter writer = null;
try {
writer = FileUtil.getBufferedWriter(absolutePath, charset, false);
Source source = new DOMSource(doc);
final Transformer xformer = TransformerFactory.newInstance().newTransformer();
xformer.setOutputProperty(OutputKeys.ENCODING, charset);
xformer.transform(source, new StreamResult(writer));
} catch (Exception e) {
throw new UtilException("Trans xml document to string error!", e);
} finally {
FileUtil.close(writer);
}
}
// -------------------------------------------------------------------------------------- Create
/**
* 创建XML文档
* @param rootElementName 根节点名称
* @return XML文档
*/
public static Document createXml(String rootElementName) {
DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
DocumentBuilder builder = null;
try {
builder = dbf.newDocumentBuilder();
} catch (Exception e) {
throw new UtilException("Create xml document error!", e);
}
Document doc = builder.newDocument();
doc.appendChild(doc.createElement(rootElementName));
return doc;
}
// -------------------------------------------------------------------------------------- Function
/**
* 去除XML文本中的无效字符
*
* @param xmlContent XML文本
* @return 当传入为null时返回null
*/
public static String cleanInvalid(String xmlContent) {
if (xmlContent == null) return null;
return xmlContent.replaceAll(INVALID_REGEX, "");
}
/**
* 根据节点名获得子节点列表
* @param element 节点
* @param tagName 节点名
* @return 节点列表
*/
public static List<Element> getElements(Element element, String tagName) {
final NodeList nodeList = element.getElementsByTagName(tagName);
return transElements(element, nodeList);
}
/**
* 根据节点名获得第一个子节点
* @param element 节点
* @param tagName 节点名
* @return 节点
*/
public static Element getElement(Element element, String tagName) {
final NodeList nodeList = element.getElementsByTagName(tagName);
if(nodeList == null || nodeList.getLength() < 1) {
return null;
}
int length = nodeList.getLength();
for(int i = 0; i < length; i++) {
Element childEle = (Element)nodeList.item(i);
if(childEle == null || childEle.getParentNode() == element) {
return childEle;
}
}
return null;
}
/**
* 根据节点名获得第一个子节点
* @param element 节点
* @param tagName 节点名
* @return 节点中的值
*/
public static String elementText(Element element, String tagName) {
Element child = getElement(element, tagName);
return child == null ? null : child.getTextContent();
}
/**
* 根据节点名获得第一个子节点
* @param element 节点
* @param tagName 节点名
* @return 节点中的值
*/
public static String elementText(Element element, String tagName, String defaultValue) {
Element child = getElement(element, tagName);
return child == null ? defaultValue : child.getTextContent();
}
/**
* 将NodeList转换为Element列表
* @param nodeList NodeList
* @return Element列表
*/
public static List<Element> transElements(NodeList nodeList) {
return transElements(null, nodeList);
}
/**
* 将NodeList转换为Element列表
* @param parentEle 父节点，如果指定将返回此节点的所有直接子节点，nul返回所有就节点
* @param nodeList NodeList
* @return Element列表
*/
public static List<Element> transElements(Element parentEle, NodeList nodeList) {
final ArrayList<Element> elements = new ArrayList<Element>();
int length = nodeList.getLength();
for(int i = 0; i < length; i++) {
Element element = (Element)nodeList.item(i);
if(parentEle == null || element.getParentNode() == parentEle) {
elements.add(element);
}
}
return elements;
}
// ---------------------------------------------------------------------------------------- Private method start
// ---------------------------------------------------------------------------------------- Private method end
}