如何通过JAXB验证多根元素XSD并获取XML的根元素

我们有一个包含多个可选根元素的XSD，待验证的XML仅能选用其中一个根元素，且无法修改该XSD标准。示例XSD如下：

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns="http://com.sample/schema/message" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://com.sample/schema/message">
    <xs:element name="FirstTypeMessage">
        <xs:complexType>
            [...]
        </xs:complexType>
    </xs:element>
    <xs:element name="SecondTypeMessage">
        <xs:complexType>
            [...]
        </xs:complexType>
    </xs:element>
</xs:schema>

现有一套可正常运行的JAXB验证代码，核心逻辑如下：

// From parameters
String xmlCode = "[...]" // OMISSIS the content of the xml
String xsdFilePath = "com/sample/schema/xsd/Sample.xsd";

[...]

ByteArrayInputStream xmlInputStream = new ByteArrayInputStream(xmlCode.getBytes("UTF-8"));
SimpleHandler xmlParseHandler = new SimpleHandler();

SchemaFactory schemaFactory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
schemaFactory.setErrorHandler(xmlParseHandler);

URL schemaURL = Thread.currentThread().getContextClassLoader().getResource(xsdFilePath);
Schema schema = schemaFactory.newSchema(schemaURL);

Validator schemaValidator = schema.newValidator();
schemaValidator.setErrorHandler(xmlParseHandler);

// Validate xml instance against the grammar.
schemaValidator.validate(new StreamSource(xmlInputStream));
if (xmlParseHandler.getSaxParseExceptionList() != null) {
    logger.warn("WARNING : xml is not valid : " + xmlParseHandler.getSaxParseExceptionMessages().toString());
    [...]
}

现在需要在轻量前提下（避免加载完整DOM），确定当前验证的XML使用了哪个根元素，优先在验证过程中直接获取。

方案1：自定义SAX Handler拦截根元素（推荐，一次解析完成验证+获取） #

Validator底层基于SAX解析，可扩展现有SimpleHandler，在startElement方法中捕获首次触发的元素（即根元素），同时保留原有错误处理逻辑。

自定义Handler代码 #

public class RootTrackingHandler extends DefaultHandler {
    private String rootElementName;
    private boolean rootFound = false;
    private List<SAXParseException> saxParseExceptionList = new ArrayList<>();

    // 保留原有错误处理方法
    @Override
    public void error(SAXParseException e) throws SAXException {
        saxParseExceptionList.add(e);
    }

    @Override
    public void fatalError(SAXParseException e) throws SAXException {
        saxParseExceptionList.add(e);
    }

    @Override
    public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {
        if (!rootFound) {
            // 记录根元素本地名称，需命名空间可同步记录uri
            rootElementName = localName;
            rootFound = true;
        }
        super.startElement(uri, localName, qName, attributes);
    }

    // 获取根元素名称
    public String getRootElementName() {
        return rootElementName;
    }

    // 原有错误信息获取方法，保持不变
    public List<SAXParseException> getSaxParseExceptionList() {
        return saxParseExceptionList;
    }

    public List<String> getSaxParseExceptionMessages() {
        return saxParseExceptionList.stream().map(SAXParseException::getMessage).collect(Collectors.toList());
    }
}

修改验证代码 #

// 替换原SimpleHandler为自定义Handler
RootTrackingHandler xmlParseHandler = new RootTrackingHandler();

// 后续验证逻辑不变
SchemaFactory schemaFactory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
schemaFactory.setErrorHandler(xmlParseHandler);

URL schemaURL = Thread.currentThread().getContextClassLoader().getResource(xsdFilePath);
Schema schema = schemaFactory.newSchema(schemaURL);

Validator schemaValidator = schema.newValidator();
schemaValidator.setErrorHandler(xmlParseHandler);

ByteArrayInputStream xmlInputStream = new ByteArrayInputStream(xmlCode.getBytes(StandardCharsets.UTF_8));
schemaValidator.validate(new StreamSource(xmlInputStream));

// 验证完成后获取根元素
if (xmlParseHandler.getSaxParseExceptionList().isEmpty()) {
    String rootElement = xmlParseHandler.getRootElementName();
    // 处理根元素逻辑
} else {
    logger.warn("WARNING : xml is not valid : " + xmlParseHandler.getSaxParseExceptionMessages().toString());
    [...]
}

此方案仅需一次SAX解析，同时完成验证和根元素捕获，完全符合轻量要求。

方案2：JAXB Unmarshaller结合验证（需绑定Java对象场景） #

如果后续需要将XML转换为JAXB生成的Java类，可通过Unmarshaller反序列化时直接获取根对象，同时开启Schema验证。

示例代码 #

// 初始化JAXBContext，传入所有根元素对应的Java类
JAXBContext jaxbContext = JAXBContext.newInstance(FirstTypeMessage.class, SecondTypeMessage.class);

Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
// 设置验证Schema
unmarshaller.setSchema(schema);
// 设置错误处理器
unmarshaller.setEventHandler(xmlParseHandler);

ByteArrayInputStream xmlInputStream = new ByteArrayInputStream(xmlCode.getBytes(StandardCharsets.UTF_8));
Object rootObj = unmarshaller.unmarshal(xmlInputStream);

// 判断根元素类型
if (rootObj instanceof FirstTypeMessage) {
    // 处理FirstTypeMessage逻辑
} else if (rootObj instanceof SecondTypeMessage) {
    // 处理SecondTypeMessage逻辑
}
// 其他根元素类型依次判断

此方案为流式解析，不加载完整DOM，适合需要后续处理Java对象的场景。

方案3：预读取XML根元素（效率略低，需二次解析） #

若仅需快速获取根元素名称，可先用SAX解析到根元素即停止，再执行验证逻辑。但会触发两次XML解析，适合对效率要求不高的场景。

根元素读取工具方法 #

public static String getRootElementName(String xmlCode) throws IOException, SAXException {
    ByteArrayInputStream inputStream = new ByteArrayInputStream(xmlCode.getBytes(StandardCharsets.UTF_8));
    XMLReader xmlReader = XMLReaderFactory.createXMLReader();
    RootTrackingHandler tempHandler = new RootTrackingHandler();
    xmlReader.setContentHandler(tempHandler);
    xmlReader.parse(new InputSource(inputStream));
    return tempHandler.getRootElementName();
}

使用方式 #

// 先获取根元素
String rootElement = getRootElementName(xmlCode);
// 再执行原有的验证逻辑
[...]

内容的提问来源于stack exchange，提问作者Patcha