萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 網路安全 >  >> 網路應用技術 >> 應用程式教學

JDOM 2.x 創建 XML 完整實戰:格式化輸出、編碼設置 (GB2312/UTF-8)、縮進控制與最佳實踐

JDOM 是 Java 操作 XML 的經典庫,API 直觀、內存效率高。本文對比 JDOM 1.x 與 2.x 差異,給出生產級 XML 生成代碼範例,覆蓋 **命名空間、屬性、文本、CDATA、格式化輸出 (縮進/換行/編碼)** 等核心需求。

一、 版本演進關鍵點:Format 對象取代舊構造函數

  • JDOM 1.x (舊) : `new XMLOutputter(indentSize, newLines, encoding)` — **已棄用/移除**。
  • JDOM 2.x (現行) : 統一使用 `org.jdom2.output.Format` 對象配置所有輸出格式,再構造 `new XMLOutputter(format)`。**靈活、可鏈式調用、線程安全。**

二、 核心配置類:Format 詳解

Format format = Format.getCompactFormat(); // 或 getPrettyFormat() 獲取默認縮進格式
// 編碼設置 (必須在輸出流創建前)
format.setEncoding("GB2312"); // 或 "UTF-8", "ISO-8859-1" 等
// 縮進設置 (關鍵:傳入字符串,而非整數)
format.setIndent("    ");     // 4 個空格縮進 (推薦)
format.setIndent("\t");       // Tab 縮進
format.setIndent("");         // 僅換行,不縮進 (緊湊但可讀)
format.setIndent(null);       // **不換行、不縮進**,單行輸出 (最小體積,難讀)
// 換行符設置
format.setLineSeparator("\n"); // Linux/Unix 默認
format.setLineSeparator("\r\n"); // Windows 風格
// 其他常用設置
format.setOmitDeclaration(false); // 是否省略 XML 聲明
format.setExpandEmptyElements(false); // 空元素縮寫  vs 

三、 完整生產級代碼範例

package com.example.xml;

import java.io.FileOutputStream;
import java.io.IOException;
import org.jdom2.Document;
import org.jdom2.Element;
import org.jdom2.Namespace;
import org.jdom2.Text;
import org.jdom2.output.Format;
import org.jdom2.output.XMLOutputter;

public class XmlGenerator {
    public static void main(String[] args) {
        try {
            // 1. 創建文檔與命名空間
            Document doc = new Document();
            Namespace nsDefault = Namespace.getNamespace("https://www.example.org/schema");
            Namespace nsExt = Namespace.getNamespace("ext", "https://www.example.org/extensions");
            
            // 2. 構建根元素並聲明命名空間
            Element root = new Element("RootElement", nsDefault);
            root.addNamespaceDeclaration(nsExt);
            doc.setRootElement(root);
            
            // 3. 添加子元素、屬性、文本、CDATA
            Element child1 = new Element("ChildOne", nsDefault);
            child1.setAttribute("attrName", "attrValue", nsExt); // 帶命名空間屬性
            child1.setText("普通文本內容"); // 自動轉義特殊字符
            
            Element child2 = new Element("ChildTwo", nsDefault);
            // CDATA 區塊:內容不轉義,適合腳本/HTML/大段特殊字符
            child2.addContent(new org.jdom2.CDATA("包含 <特殊> & 字符 \"內容\" 的 CDATA 區塊"));
            
            root.addContent(child1);
            root.addContent(child2);
            
            // 4. 配置輸出格式
            Format format = Format.getPrettyFormat(); // 獲取默認美化格式 (2空格縮進、換行)
            format.setEncoding("GB2312");             // 設置目標編碼
            format.setIndent("    ");                 // 覆蓋為 4 空格縮進
            format.setLineSeparator("\r\n");          // Windows 換行符
            
            // 5. 輸出到文件
            XMLOutputter outputter = new XMLOutputter(format);
            try (FileOutputStream fos = new FileOutputStream("output.xml")) {
                outputter.output(doc, fos);
            }
            System.out.println("XML 文件生成成功:output.xml");
            
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

四、 生成結果示例 (output.xml)

<?xml version="1.0" encoding="GB2312"?>
<RootElement xmlns="https://www.example.org/schema" xmlns:ext="https://www.example.org/extensions">
    <ChildOne ext:attrName="attrValue">普通文本內容</ChildOne>
    <ChildTwo><![CDATA[包含 <特殊> & 字符 "內容" 的 CDATA 區塊]]></ChildTwo>
</RootElement>

五、 避坑指南與最佳實踐

  1. 編碼一致性鐵律: `format.setEncoding("GB2312")` **必須與** `FileOutputStream` 寫入的字節流編碼一致,**且 XML 聲明中 encoding 屬性值必須匹配**。不一致導致解析錯誤/亂碼。
  2. 命名空間正確聲明: 根元素 `addNamespaceDeclaration` 確保前綴在文檔頂層聲明,子元素復用前綴,避免重複 xmlns 暴漲文件體積。
  3. 大文件流式輸出: 超大 XML (百 MB 以上) 不要構建完整 Document 树,**使用 `XMLStreamWriter` (StAX) 或 JDOM 的 `SAXOutputter` 流式寫入**,避免 OOM。
  4. 特殊字符自動轉義: `setText()` 會自動轉義 `< > & ' "`;**唯有 CDATA 區塊不轉義**,用於包含大量特殊字符的數據 (腳本、SQL、HTML 片段)。
  5. 依賴坐標 (Maven/Gradle):
    <dependency>
        <groupId>org.jdom</groupId>
        <artifactId>jdom2</artifactId>
        <version>2.0.6.1</version> <!-- 檢查最新版 -->
    </dependency>
    
  6. 輸出到字符串 (調試/日誌/網絡發送):
    String xmlString = outputter.outputString(doc); // 直接獲取字符串
    

六、 總結

JDOM 2.x 通過 **Format 對象** 實現了輸出格式的完全可控:**編碼 (GB2312/UTF-8)、縮進 (空格/Tab/無)、換行符 (LF/CRLF)、聲明、空元素展開**。掌握 `Format.getPrettyFormat()` + `setIndent()` + `setEncoding()` 組合拳,配合命名空間管理、CDATA 使用、流式輸出大文件策略,即可覆蓋 99% Java XML 生成場景。**拒絕拼接字符串生成 XML,擁抱標準庫,構建健壯、可維護的數據交換接口。**

copyright © 萬盛學電腦網 all rights reserved