在Java中,我们可以使用javax.xml.transform.Transformer将DOM文档、SAX事件或XML字符串转换为另一种形式,例如格式化的XML文件。Transformer通过输出属性来控制序列化行为,其中indent控制是否缩进,encoding控制输出字符集。

使用Transformer设置indent和encoding
TransformerFactory生成的Transformer实例,可以调用setOutputProperty方法设置标准的输出键。这些键定义在javax.xml.transform.OutputKeys类中。
核心步骤
- 创建TransformerFactory并禁用内部DTD,防止外部实体加载
- 从工厂获取Transformer对象
- 调用setOutputProperty(OutputKeys.INDENT, "yes")开启缩进
- 调用setOutputProperty(OutputKeys.ENCODING, "UTF-8")设置编码
- 使用StreamResult指定输出目标并执行transform
完整示例代码
下面演示如何将一个简单的DOM文档输出为带缩进且编码为UTF-8的XML文件:
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 org.w3c.dom.Document;
import org.w3c.dom.Element;
import java.io.File;
public class TransformerDemo {
public static void main(String[] args) throws Exception {
// 创建DOM文档
DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
dbf.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);
DocumentBuilder builder = dbf.newDocumentBuilder();
Document doc = builder.newDocument();
Element root = doc.createElement("users");
Element user = doc.createElement("user");
user.setAttribute("id", "1");
user.setTextContent("张三");
root.appendChild(user);
doc.appendChild(root);
// 获取Transformer并设置输出属性
TransformerFactory tf = TransformerFactory.newInstance();
tf.setAttribute("http://javax.xml.XMLConstants/feature/secure-processing", true);
Transformer transformer = tf.newTransformer();
// 开启缩进
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
// 设置缩进量为2个空格(部分实现支持)
transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "2");
// 设置编码
transformer.setOutputProperty(OutputKeys.ENCODING, "UTF-8");
// 设置XML声明中的版本
transformer.setOutputProperty(OutputKeys.VERSION, "1.0");
// 输出到文件
StreamResult result = new StreamResult(new File("output.xml"));
transformer.transform(new DOMSource(doc), result);
System.out.println("XML已生成");
}
}
常见输出属性说明
除了indent和encoding,OutputKeys还定义了其他常用属性:
| 属性名 | 作用 | 示例值 |
|---|---|---|
| INDENT | 是否缩进输出 | yes / no |
| ENCODING | 指定输出字符编码 | UTF-8 / GBK |
| OMIT_XML_DECLARATION | 是否省略XML声明 | yes / no |
| METHOD | 输出方法类型 | xml / html / text |
注意事项
如果只设置INDENT为yes但缩进未生效,可能是Transformer实现需要额外的缩进量参数,例如Apache Xalan使用{http://xml.apache.org/xslt}indent-amount。另外,设置encoding为UTF-8时,确保目标流或文件以UTF-8写入,否则仍可能出现乱码。
在Web应用中输出XML给前端时,也应保证响应头的Content-Type与Transformer的encoding一致,例如都使用UTF-8。
使用字符串输出
若希望直接拿到字符串而非写文件,可将StreamResult绑定到StringWriter:
import java.io.StringWriter; import javax.xml.transform.stream.StreamResult; StringWriter sw = new StringWriter(); transformer.transform(new DOMSource(doc), new StreamResult(sw)); String xmlString = sw.toString();
通过上述方式,我们就能灵活控制Java Transformer的输出格式与编码,生成整洁且安全的XML内容。
JavaTransformerindentencodingXML修改时间:2026-07-25 04:18:20