JAXP XML校验错误提示含非必填字段，如何仅展示必填字段？

问题场景 #

项目基于Adoptium Java 1.8做XML与XSD校验，使用以下方式初始化SchemaFactory：

SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI, "com.sun.org.apache.xerces.internal.jaxp.validation.XMLSchemaFactory", null)

对应的XSD定义：

<xs:complexType name="PersonType">
    <xs:sequence>
        <xs:element minOccurs="0" name="NickName"/>
        <xs:element minOccurs="0" name="Address"/>
        <xs:element name="Surname"/>
        <xs:element minOccurs="0" name="Occupation"/>
    </xs:sequence>
</xs:complexType>

当校验<Person/>这个XML时，返回错误提示：

cvc-complex-type.2.4.b: The content of element 'Person' is not complete. One of '{"namespace":NickName, "namespace":Address, "namespace":Surname}' is expected.

该提示存在误导性：实际仅需提供必填元素Surname，但错误信息将可选元素也一并列出，且无法修改Java内嵌的Xerces库源码来调整提示逻辑。

解决方案：二次处理错误信息 #

由于无法修改内置校验库的错误提示逻辑，可通过捕获校验异常后，结合XSD元数据重新生成仅包含必填字段的提示信息来解决，具体步骤如下：

1. 解析XSD获取必填元素列表 #

通过Xerces的内部API解析XSD，提取指定复杂类型的必填元素（minOccurs > 0的元素）：

import com.sun.org.apache.xerces.internal.xs.XSComplexType;
import com.sun.org.apache.xerces.internal.xs.XSElementDeclaration;
import com.sun.org.apache.xerces.internal.xs.XSModel;
import com.sun.org.apache.xerces.internal.xs.XSModelGroup;
import com.sun.org.apache.xerces.internal.xs.XSParticle;
import javax.xml.XMLConstants;
import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;
import java.io.File;
import java.util.HashSet;
import java.util.Set;

private static Set<String> getRequiredElements(String xsdPath, String complexTypeName) throws Exception {
    SchemaFactory factory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
    Schema schema = factory.newSchema(new File(xsdPath));
    // 强转成Xerces的XMLSchema以获取内部元数据模型
    XSModel xsModel = ((com.sun.org.apache.xerces.internal.jaxp.validation.XMLSchema) schema).getXSModel();
    // 获取指定名称的复杂类型（空字符串对应无命名空间的情况，根据实际XSD调整）
    XSComplexType complexType = xsModel.getComplexTypeDefinition(complexTypeName, "");
    Set<String> requiredElements = new HashSet<>();
    
    if (complexType != null) {
        XSParticle particle = complexType.getParticle();
        if (particle != null && particle.getTerm() instanceof XSModelGroup) {
            XSModelGroup modelGroup = (XSModelGroup) particle.getTerm();
            XSParticle[] particles = modelGroup.getParticles();
            for (XSParticle p : particles) {
                // 筛选必填元素（minOccurs默认值为1，未指定时也满足>0）
                if (p.getMinOccurs() > 0) {
                    XSElementDeclaration elemDecl = (XSElementDeclaration) p.getTerm();
                    requiredElements.add(elemDecl.getName());
                }
            }
        }
    }
    return requiredElements;
}

2. 自定义ErrorHandler处理校验异常 #

在校验时设置自定义ErrorHandler，捕获cvc-complex-type.2.4.b类型的错误，替换为仅包含必填元素的提示：

import org.xml.sax.SAXParseException;
import org.xml.sax.ErrorHandler;
import javax.xml.validation.Validator;
import javax.xml.transform.stream.StreamSource;
import java.io.File;

public static void validateXml(String xmlPath, String xsdPath) throws Exception {
    // 提前获取PersonType的必填元素列表
    Set<String> requiredPersonElements = getRequiredElements(xsdPath, "PersonType");
    
    SchemaFactory factory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI, 
        "com.sun.org.apache.xerces.internal.jaxp.validation.XMLSchemaFactory", null);
    Schema schema = factory.newSchema(new File(xsdPath));
    Validator validator = schema.newValidator();
    
    validator.setErrorHandler(new ErrorHandler() {
        @Override
        public void warning(SAXParseException exception) throws SAXException {
            throw exception;
        }

        @Override
        public void error(SAXParseException exception) throws SAXException {
            String originalMsg = exception.getMessage();
            // 匹配目标错误代码
            if (originalMsg != null && originalMsg.startsWith("cvc-complex-type.2.4.b:")) {
                // 生成新的错误提示
                String newMsg = String.format(
                    "cvc-complex-type.2.4.b: The content of element 'Person' is not complete. Required element '%s' is missing.",
                    String.join(", ", requiredPersonElements)
                );
                // 抛出包含新提示的异常，保留原异常的位置信息
                throw new SAXParseException(
                    newMsg,
                    exception.getPublicId(),
                    exception.getSystemId(),
                    exception.getLineNumber(),
                    exception.getColumnNumber()
                );
            }
            // 其他错误直接抛出原异常
            throw exception;
        }

        @Override
        public void fatalError(SAXParseException exception) throws SAXException {
            throw exception;
        }
    });
    
    validator.validate(new StreamSource(new File(xmlPath)));
}

注意事项 #

• 若XSD使用了命名空间，需调整getRequiredElements方法中getComplexTypeDefinition的第二个参数为对应命名空间URI
• 代码依赖Xerces的内部API，在Adoptium Java 8环境下稳定可用，若后续升级Java版本需重新适配
• 可扩展工具类，缓存各复杂类型的必填元素列表，避免重复解析XSD提升性能

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