在Java标准库中,StAX(Streaming API for XML)提供了一套基于拉取模式的XML解析方案。与DOM将整棵树装入内存不同,StAX让开发者主动调用读取方法从输入流中获取解析事件,因此非常适合处理体积不确定的XML数据。XMLInputFactory作为StAX的工厂类,负责创建XMLStreamReader实例,而createXMLStreamReader正是我们最常使用的入口方法。
XMLInputFactory的基础用法
XMLInputFactory采用抽象工厂模式,不能通过构造器直接实例化,而是借助静态方法newFactory或newInstance获得实现。得到工厂对象后,就可以调用createXMLStreamReader方法,将多种输入源(如InputStream、Reader、文件路径等)包装成流读取器。需要注意,工厂实例本身不是线程安全的,多个线程应当各自持有独立实例,或者借助局部变量在方法内创建。
下面展示一个最基础的创建过程,从字节流中读取XML内容:
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamReader;
import java.io.FileInputStream;
public class StaxBasic {
public static void main(String[] args) throws Exception {
XMLInputFactory factory = XMLInputFactory.newFactory();
// 禁用外部实体,防止XXE攻击
factory.setProperty(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, false);
factory.setProperty(XMLInputFactory.SUPPORT_DTD, false);
try (FileInputStream fis = new FileInputStream("data.xml")) {
XMLStreamReader reader = factory.createXMLStreamReader(fis);
while (reader.hasNext()) {
int event = reader.next();
if (event == XMLStreamReader.START_ELEMENT) {
System.out.println("遇到元素: " + reader.getLocalName());
}
}
reader.close();
}
}
}
上述代码先关闭了DTD支持与外部实体,这是生产环境中必要的防护手段。随后通过createXMLStreamReader得到读取器,利用hasNext与next方法逐步推进解析。相比把整份文档读入内存,这种方式在文件达到几百兆时依旧只占用少量堆空间。
createXMLStreamReader的重载形式
该方法提供了多个重载版本,可适应不同数据源。常见形式包括传入InputStream、Reader,以及额外指定系统ID(用于解析相对路径)的组合。如果XML来自网络响应或消息队列,一般使用InputStream版本;若已经做过字符解码,则可直接传Reader避免二次编码转换。
以下示例演示带系统ID的创建方式,便于解析器定位外部引用:
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamReader;
import java.io.StringReader;
public class StaxWithSystemId {
public static void main(String[] args) throws Exception {
String xml = "<root><item>示例</item></root>";
XMLInputFactory factory = XMLInputFactory.newFactory();
// 传入Reader并指定systemId
XMLStreamReader reader = factory.createXMLStreamReader(
new StringReader(xml), "http://ipipp.com/schema/root");
while (reader.hasNext()) {
int event = reader.next();
if (event == XMLStreamReader.CHARACTERS) {
System.out.println("文本: " + reader.getText());
}
}
reader.close();
}
}
通过指定系统ID,当XML内部出现相对路径引用时,解析器能拼出完整地址。不过在多数内部系统对接中,XML并不依赖外部资源,此时省略系统ID即可。开发者应根据实际数据来源选择最简洁且安全的重载方法。
事件类型与读取循环
XMLStreamReader将文档拆解为若干事件常量,例如START_ELEMENT、END_ELEMENT、CHARACTERS、ATTRIBUTE等。在循环中调用next返回整型事件码,再通过getLocalName、getText、getAttributeValue等接口提取信息。这种显式控制流程的代码虽然比回调式SAX稍长,但逻辑更直观,也更容易在读取中途做条件中断。
下面的片段展示如何读取元素属性与嵌套文本:
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamReader;
import java.io.StringReader;
public class StaxEvent {
public static void main(String[] args) throws Exception {
String xml = "<user id='1001'><name>张三</name></user>";
XMLInputFactory factory = XMLInputFactory.newFactory();
XMLStreamReader reader = factory.createXMLStreamReader(new StringReader(xml));
while (reader.hasNext()) {
int event = reader.next();
if (event == XMLStreamReader.START_ELEMENT) {
String name = reader.getLocalName();
if ("user".equals(name)) {
String id = reader.getAttributeValue(null, "id");
System.out.println("用户ID: " + id);
}
} else if (event == XMLStreamReader.CHARACTERS) {
String text = reader.getText().trim();
if (!text.isEmpty()) {
System.out.println("内容: " + text);
}
}
}
reader.close();
}
}
可以看到,属性必须在START_ELEMENT事件内通过getAttributeValue读取,而元素正文则对应CHARACTERS事件。由于换行与缩进也会触发CHARACTERS,实际业务中通常要trim并过滤空白,才能拿到有效业务数据。
常见配置与安全注意
除了前面提到的关闭外部实体,XMLInputFactory还支持设置是否合并相邻文本节点、是否保留命名空间等。例如IS_COALESCING设为true可让解析器把分段字符事件合成一个,简化文本处理。但开启合并可能略微增加开销,应结合场景权衡。
在解析不可信来源XML时,务必同时关闭SUPPORT_DTD与IS_SUPPORTING_EXTERNAL_ENTITIES,否则攻击者可构造恶意DTD读取服务器文件。以下表格列出关键配置项:
| 属性名 | 推荐值 | 作用 |
|---|---|---|
| SUPPORT_DTD | false | 禁止处理DTD定义 |
| IS_SUPPORTING_EXTERNAL_ENTITIES | false | 阻止外部实体加载 |
| IS_COALESCING | true或false | 控制文本事件是否合并 |
将这些属性通过setProperty写入工厂,再创建读取器,就能在流式解析的同时把安全风险降到最低。对于长期运行的导入任务,还应把XMLInputFactory的创建放在方法内或使用ThreadLocal隔离,避免多线程共享引发状态混乱。
与其它解析方式对比
DOM适合需要随机访问与修改的小文档,但内存线性增长;SAX是推式模型,必须实现回调接口,控制反转导致代码分散。StAX的createXMLStreamReader兼顾了低内存与代码可读性,在只需顺序提取字段的报文、日志、配置同步等场合优势明显。
当业务要求把XML映射为Java对象时,也可在StAX之上封装轻量绑定层,而不是引入重量级JAXB。这样既保留流式特性,又减少第三方依赖。理解XMLInputFactory与XMLStreamReader的协作机制,是写出健壮数据管道的基础。
XMLInputFactorycreateXMLStreamReaderStAX修改时间:2026-08-09 01:03:38