在Java开发中处理XML数据时，经常需要将解析得到的Document对象转换为字符串形式，用于日志输出、接口传输或者后续的业务处理。这种转换操作看似简单，实际实现时需要考虑编码、格式保留、异常处理等多个维度，不同的实现方案也有各自的适用场景。
方案一：使用Java自带的Transformer类
Java标准库中的javax.xml.transform包提供了Transformer类，可以直接完成Document到字符串的转换，不需要引入额外的第三方依赖，是最基础的实现方式。
核心实现步骤
- 创建TransformerFactory实例
- 通过工厂获取Transformer对象
- 创建DOMSource封装Document对象
- 创建StringWriter作为输出目标
- 执行转换操作并获取结果字符串
示例代码
import org.w3c.dom.Document;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import java.io.StringWriter;
public class XmlDocumentToString {
public static String documentToString(Document document) throws TransformerException {
// 创建转换器工厂
TransformerFactory transformerFactory = TransformerFactory.newInstance();
// 获取转换器实例
Transformer transformer = transformerFactory.newTransformer();
// 设置输出编码为UTF-8，避免中文乱码
transformer.setOutputProperty("encoding", "UTF-8");
// 是否保留XML原有格式，yes为保留缩进，no为压缩为一行
transformer.setOutputProperty("indent", "yes");
// 封装Document为DOMSource
DOMSource domSource = new DOMSource(document);
// 创建字符串输出流
StringWriter stringWriter = new StringWriter();
StreamResult streamResult = new StreamResult(stringWriter);
// 执行转换
transformer.transform(domSource, streamResult);
// 返回转换后的字符串
return stringWriter.toString();
}
}
注意事项
使用这种方式时，如果Document对象是通过解析外部XML文件得到的，转换后的字符串会保留原XML的声明头。如果需要去掉XML声明，可以额外设置输出属性：
// 去掉XML声明头
transformer.setOutputProperty("omit-xml-declaration", "yes");
方案二：使用第三方工具包简化操作
如果项目中已经引入了Apache Commons Lang或者Spring框架等第三方依赖，可以使用工具类简化转换逻辑，减少重复代码。
使用Apache Commons Lang的XmlUtils
Apache Commons Lang的XmlUtils类提供了封装好的转换方法，内部已经处理了常见的异常和编码问题，代码更简洁。
import org.apache.commons.lang3.XmlUtils;
import org.w3c.dom.Document;
import java.io.StringWriter;
public class XmlDocumentToStringWithCommons {
public static String documentToString(Document document) {
StringWriter stringWriter = new StringWriter();
XmlUtils.writeDocumentTo(document, stringWriter);
return stringWriter.toString();
}
}
使用Spring的DomUtils
如果项目基于Spring框架，也可以使用Spring提供的工具类完成转换，适配Spring生态下的XML处理场景。
import org.springframework.util.xml.DomUtils;
import org.w3c.dom.Document;
import java.io.StringWriter;
public class XmlDocumentToStringWithSpring {
public static String documentToString(Document document) {
StringWriter stringWriter = new StringWriter();
DomUtils.writeDocument(document, stringWriter);
return stringWriter.toString();
}
}
两种方案对比
不同实现方案的适用场景和特点如下：
| 方案 | 优点 | 缺点 | 适用场景 |
|---|---|---|---|
| Java自带Transformer | 无额外依赖，兼容性好 | 代码相对繁琐，需要手动处理异常和属性配置 | 无第三方依赖的项目，或者需要高度自定义转换规则的场景 |
| 第三方工具包 | 代码简洁，内置异常处理，减少重复代码 | 需要引入额外依赖，增加项目体积 | 已经有对应第三方依赖的项目，追求开发效率的场景 |
常见问题与解决
中文乱码问题
转换后出现中文乱码，通常是因为没有设置正确的输出编码，需要在Transformer中显式设置encoding属性为UTF-8，同时确保Document解析时的编码也和输出编码一致。
格式丢失问题
如果转换后的字符串所有内容挤在一行，没有缩进，是因为没有设置indent属性，将其设置为yes即可保留原XML的缩进格式。如果原XML本身没有缩进，即使设置该属性也不会自动生成缩进。
转换异常问题
转换过程中可能抛出TransformerException，通常是因为Document对象不完整或者包含非法节点，需要在转换前校验Document的有效性，或者捕获异常后做降级处理。