DOM4J 通过 OutputFormat.setEncoding()指定输出 编码 并匹配对应 字节 流(如 OutputstreamWriter)来控制 xml 编码,XML 声明中的 encoding 属性由输出器自动生成;写入 String 时编码设置无效,读取时编码由输入源决定。

DOM4J 本身不直接“设置 XML 的 编码 格式”,而是通过 输出时指定字符编码 来控制生成的 XML 文件或 字符串 使用哪种编码(如 UTF-8、GBK)。XML 声明中的 encoding 属性(如 <?xml version="1.0" encoding="UTF-8"?>)由输出器(XMLWriter 或 OutputFormat)自动写入,前提是正确配置了编码参数。
1. 使用 OutputFormat 指定编码并启用 XML 声明
这是最常用的方式。创建 OutputFormat 实例,设置编码和是否输出 XML 声明:
-
OutputFormat.setEncoding("UTF-8"):告诉输出器用 UTF-8 编码写入内容 -
OutputFormat.setSuppressDeclaration(false)(默认就是 false):确保生成<?xml ……?>声明
示例代码:
Document document = DocumentHelper.createDocument(); document.addComment("Hello World"); OutputFormat format = OutputFormat.createPrettyPrint(); format.setEncoding("UTF-8"); // ✅ 关键:设置编码 format.setSuppressDeclaration(false); // 确保输出 <?xml ……?> XMLWriter writer = new XMLWriter(new FileWriter("output.xml"), format); writer.write(document); writer.close();
生成的文件头部会是:<?xml version="1.0" encoding="UTF-8"?>
立即学习“Java 免费学习笔记(深入)”;
2. 写入到 OutputStream 时注意 字节 流编码匹配
如果写入的是 FileOutputStream 或网络流,必须用 OutputStreamWriter 包装,并指定相同编码,否则实际字节写入可能乱码:
OutputStream os = new FileOutputStream("output.xml"); OutputStreamWriter osw = new OutputStreamWriter(os, "UTF-8"); // ✅ 必须和 OutputFormat.setEncoding 一致 XMLWriter writer = new XMLWriter(osw, format); writer.write(document); writer.close();
⚠️ 错误做法:只设 OutputFormat.setEncoding("UTF-8"),但用 FileWriter("xxx.xml")(它用系统默认编码),会导致声明写的是 UTF-8,实际内容却是 GBK 字节 —— XML 解析时会报错。
3. 写入字符串时无需手动设编码(String 无编码概念)
若用 XMLWriter 写入 StringWriter 获取 XML 字符串,OutputFormat.setEncoding() 不起作用(因为 String 是 Unicode 内存表示):
StringWriter sw = new StringWriter(); XMLWriter writer = new XMLWriter(sw, format); // format.setEncoding("UTF-8") 这里被忽略 writer.write(document); String xmlStr = sw.toString(); // ✅ 得到的是正常 Unicode 字符串 // 后续若要保存为文件,再按需用 UTF-8 字节写出
此时 XML 声明里的 encoding="UTF-8" 仅作语义提示,真正编码由你后续保存时决定。
4. 读取已有 XML 时编码由输入源决定,与 DOM4J 设置无关
DOM4J 解析 XML 时,编码由输入源(如文件 bom、XML 声明、http Content-Type 或 SAX 解析器默认)决定,OutputFormat 对读取过程完全无效。确保原始文件编码和声明一致即可,例如文件是 UTF-8 且开头有 <?xml version="1.0" encoding="UTF-8"?>,DOM4J 就能正确识别。
基本上就这些。核心就一条:输出时靠 OutputFormat.setEncoding() + 匹配的字节流 /Writer,其他地方设了也没用。