Java 更新 XML 文檔的四大主流方案深度對比與最佳實踐

問題背景

初學者常遇困惑：DOM 樹在內存中修改後，原 XML 文件未同步更新。JAXP 本身不提供持久化 API，需開發者自行選擇序列化方案。本文對比四種主流方法，分析優劣與適用場景。

方案一：手工遍歷寫入（教學/極簡場景）

• 遞歸遍歷 DOM 節點，拼接字串寫入文件。
• 缺點：易出錯（實體轉義、編碼、縮排）、效率低、難維護。
• 適用：自研 XML 解析器、極受限環境（無第三方庫）。

方案二：Apache Crimson 專有 XmlDocument.write()（舊項目維護）

DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
Document doc = factory.newDocumentBuilder().parse("user.xml");
// ... 修改 doc ...
((org.apache.crimson.tree.XmlDocument) doc).write(
    new FileOutputStream("user.xml")); // 默認 UTF-8
// 或指定編碼
((XmlDocument) doc).write(new OutputStreamWriter(new FileOutputStream("user.xml"), "GB2312"));

• 優點：一行代碼搞定，API 簡單。
• 缺點：強依賴 Crimson，JAXP 1.2+ / Java XML Pack / JWSDP 均移除 Crimson 改用 Xerces+Xalan，代碼不通用；Crimson 性能較差。
• 適用：舊系統 (JAXP 1.1) 維護、快速原型。

方案三：JAXP 標準 Transformer（推薦標準做法）

// 1. 準備源與結果
DOMSource source = new DOMSource(doc);
StreamResult result = new StreamResult(new File("output.xml"));

// 2. 獲取 Transformer
TransformerFactory tf = TransformerFactory.newInstance();
Transformer t = tf.newTransformer();

// 3. 【關鍵】設置輸出屬性
Properties props = t.getOutputProperties();
props.setProperty(OutputKeys.ENCODING, "GB2312");      // 解決中文亂碼
props.setProperty(OutputKeys.INDENT, "yes");          // 縮排美化
props.setProperty(OutputKeys.OMIT_XML_DECLARATION, "no");
t.setOutputProperties(props);

// 4. 執行轉換
t.transform(source, result);

OutputKeys 常用屬性速查

• 優點：JAXP 標準、解析器無關、靈活控制輸出格式、支援 XSLT 複雜轉換。
• 缺點：大文檔內存佔用高（DOM 模型固有）。
• 適用：絕大多數生產環境，特別是需精確控制輸出格式的場景。

方案四：Xalan XML Serializer（大批量/高性能序列化）

// 前同方案三：建立 Transformer、設置屬性、transform(source, domResult)
// 額外步驟：
DOMResult domResult = new DOMResult();
t.transform(new DOMSource(doc), domResult);

Serializer serializer = SerializerFactory.getSerializer(
    OutputProperties.getDefaultMethodProperties("xml"));
Properties sp = serializer.getOutputFormat();
sp.setProperty("encoding", "GB2312");
serializer.setOutputFormat(sp);
serializer.setOutputStream(new FileOutputStream("output.xml"));
serializer.asDOMSerializer().serialize(domResult.getNode());

• 優點：序列化性能優於標準 Transformer，適合大批量文檔輸出。
• 缺點：雙重屬性設置繁瑣、強依賴 Xalan/Xerces、非標準 API。
• 適用：高吞吐批量導出、報表生成等性能敏感場景。

綜合對比表

最佳實踐建議

1. 首選 JAXP Transformer：標準、通用、功能全、社群支援好。
2. 統一編碼為 UTF-8：除非強制對接 GBK 系統，否則全鏈路 UTF-8 避免亂碼。
3. 大文件改用 StAX/SAX：寫入端採用 XMLStreamWriter 流式輸出，避免 DOM 佔用海量堆內存。
4. 封裝工具類：將 Transformer 配置、異常處理、資源關閉封裝為 XmlUtils.writeXml(Document, OutputStream, Encoding)，業務代碼一行調用。
5. 單元測試驗證輸出：使用 XMLUnit 或 Canonical XML 比對期望輸出。

其他替代方案簡覽

• JDOM2 / Dom4j：XMLOutputter / XMLWriter API 更友好，內部同樣委託 Transformer 或自帶序列化器。
• JAXB Marshaller：綁定框架直接輸出，適合「對象→XML」主流場景。
• Castor / XStream / Simple XML：同屬 Data Binding 範疇。

結語

「修改 DOM 後如何落盤」不是 JAXP 缺失，而是設計使然：解析與序列化分離。掌握 Transformer + OutputKeys 標準組合，即可輕鬆應對 95% 場景；極致性能才引入 Xalan Serializer 或流式寫入。拒絕手工拼接、拒絕綁定廠商專有類，是專業 Java XML 開發者的基本素養。