Java中如何用Dom4j的Document.asXML方法将文档转换为XML字符串

Java开发中处理XML文档时，将Dom4j的Document对象转换为XML字符串是常见需求，Document类的asXML方法可以直接实现这个转换功能，操作简单且适配大多数基础场景。

基础使用方式

首先需要引入Dom4j的依赖，如果是Maven项目可以在pom.xml中添加如下依赖配置：

<dependency>
    <groupId>org.dom4j</groupId>
    <artifactId>dom4j</artifactId>
    <version>2.1.4</version>
</dependency>

创建Document对象并调用asXML方法的完整示例如下：

import org.dom4j.Document;
import org.dom4j.DocumentHelper;
import org.dom4j.Element;

public class Dom4jAsXMLDemo {
    public static void main(String[] args) throws Exception {
        // 创建Document对象
        Document document = DocumentHelper.createDocument();
        // 添加根元素
        Element root = document.addElement("user");
        // 添加子元素
        Element nameElement = root.addElement("name");
        nameElement.setText("张三");
        Element ageElement = root.addElement("age");
        ageElement.setText("25");
        
        // 调用asXML方法转换为XML字符串
        String xmlString = document.asXML();
        System.out.println(xmlString);
    }
}

上述代码运行后输出的XML字符串内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<user><name>张三</name><age>25</age></user>

方法特性说明

Document.asXML方法输出的XML字符串默认包含XML声明头，编码格式为UTF-8，元素之间不会自动添加换行和缩进，所有内容会拼接在一行中。

如果不需要XML声明头，可以手动处理转换后的字符串，示例代码如下：

public class RemoveXmlHeaderDemo {
    public static void main(String[] args) throws Exception {
        Document document = DocumentHelper.createDocument();
        Element root = document.addElement("book");
        root.addElement("title").setText("Java编程思想");
        
        String xmlString = document.asXML();
        // 移除XML声明头
        if (xmlString.startsWith("<?xml")) {
            int endIndex = xmlString.indexOf("?>");
            xmlString = xmlString.substring(endIndex + 2);
        }
        System.out.println(xmlString);
    }
}

特殊字符处理

当XML元素内容包含特殊字符比如<、>、&时，asXML方法会自动对这些字符进行转义，不需要开发者手动处理，示例如下：

public class SpecialCharDemo {
    public static void main(String[] args) throws Exception {
        Document document = DocumentHelper.createDocument();
        Element root = document.addElement("content");
        // 内容包含特殊字符
        root.setText("a < b & c > d");
        
        String xmlString = document.asXML();
        System.out.println(xmlString);
    }
}

输出结果中特殊字符已经被正确转义：

<?xml version="1.0" encoding="UTF-8"?>
<content>a &lt; b &amp; c &gt; d</content>

自定义输出格式

如果希望输出的XML字符串有缩进和换行，不能直接通过asXML方法实现，需要配合OutputFormat和XMLWriter来完成，示例代码如下：

import org.dom4j.Document;
import org.dom4j.DocumentHelper;
import org.dom4j.Element;
import org.dom4j.io.OutputFormat;
import org.dom4j.io.XMLWriter;
import java.io.StringWriter;

public class FormatXmlDemo {
    public static void main(String[] args) throws Exception {
        Document document = DocumentHelper.createDocument();
        Element root = document.addElement("student");
        root.addElement("id").setText("1001");
        Element info = root.addElement("info");
        info.addElement("class").setText("三年级");
        
        // 创建格式化配置，设置缩进为4个空格，开启换行
        OutputFormat format = OutputFormat.createPrettyPrint();
        format.setIndentSize(4);
        format.setEncoding("UTF-8");
        
        StringWriter writer = new StringWriter();
        XMLWriter xmlWriter = new XMLWriter(writer, format);
        xmlWriter.write(document);
        xmlWriter.close();
        
        String formattedXml = writer.toString();
        System.out.println(formattedXml);
    }
}

该方式输出的XML字符串会带有清晰的层级缩进，可读性更强，适合需要展示XML内容的场景。

常见问题说明

• asXML方法是线程安全的，同一个Document对象在多线程环境下调用该方法不会出现数据错乱问题
• 如果Document对象没有设置编码，asXML方法默认使用UTF-8编码生成XML声明，修改Document的编码属性不会影响asXML的输出编码
• 转换后的XML字符串如果包含中文，直接输出到文件时需要确保文件编码为UTF-8，避免出现乱码

Dom4jDocument_asXMLXML字符串Java修改时间：2026-06-25 22:36:34