使用transformer类可将xml字符串格式化为易读形式,首先通过DocumentBuilder解析XML字符串为Document对象,再利用transformer设置缩进和编码等属性,最后将dom树转换为带格式的字符串输出。示例代码展示了从解析到转换的完整流程,并封装为静态工具方法便于复用,注意处理异常及确保输入XML合法。

在java中格式化输出XML字符串,主要是通过Transformer类来实现美化(pretty print)功能。这种方式可以将原始的、无缩进或紧凑型的XML字符串转换为具有缩进、换行等可读性更强的格式。
使用Transformer格式化XML字符串
核心思路是利用javax.xml.transform包中的类将XML内容解析并重新输出为格式化后的字符串。
步骤说明:
- 将XML字符串转换为
Document对象(需要借助DocumentBuilder) - 使用
Transformer设置输出属性,如缩进、编码等 - 执行转换并将结果写入字符串
示例代码:
import org.w3c.dom.Document; import org.xml.sax.InputSource; import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.DocumentBuilderFactory; import javax.xml.transform.OutputKeys; import javax.xml.transform.Transformer; import javax.xml.transform.TransformerFactory; import javax.xml.transform.dom.DOMSource; import javax.xml.transform.stream.StreamResult; import java.io.StringReader; import java.io.StringWriter; public class formatXml { public static String formatXml(String xmlString) { try { // 解析字符串为Document DocumentBuilder builder = DocumentBuilderFactory.newinstance().newDocumentBuilder(); Document document = builder.parse(new InputSource(new StringReader(xmlString))); // 配置Transformer进行格式化 Transformer transformer = TransformerFactory.newInstance().newTransformer(); transformer.setOutputProperty(OutputKeys.INDENT, "yes"); transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "2"); // 执行转换 StringWriter writer = new StringWriter(); transformer.transform(new DOMSource(document), new StreamResult(writer)); return writer.toString(); } catch (Exception e) { throw new RuntimeException("XML格式化失败", e); } } // 使用示例 public static void main(String[] args) { String xml = "<root><child name="test"/></root>"; System.out.println(formatXml(xml)); } }
注意事项与常见问题
实际使用中需要注意以下几点:
立即学习“Java免费学习笔记(深入)”;
- 确保XML字符串格式正确,否则解析会抛出异常
- 需要引入标准的JAXP API,Java SE自带无需额外依赖
- 若使用第三方库如
jsoup或JDOM,也有更简洁的方法,但原生方式更通用 - 注意命名空间和特殊字符的处理,避免转义问题
简化工具方法封装
可以将上述逻辑封装成一个静态工具方法,在多个项目中复用。
例如创建XmlUtils.format(String xml)方法,直接返回美化后的字符串,调用时只需一行代码即可完成格式化。
基本上就这些。只要掌握Transformer的使用,Java中格式化XML字符串并不复杂,关键是正确解析输入并设置合适的输出属性。