通过jdk实现xsd校验xml

本文介绍了一种使用JDK自带的javax.xml.validation.Schema特性,通过XSD对XML进行校验的方法。提供了详细的代码示例,展示了如何创建Schema并利用其进行XML文件的有效性验证。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

利用jdk自身的javax.xml.validation.Schema特性实现对象xsd对xml的校验,参考代码如下:

package xxx.common.util;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.nio.file.Path;

import javax.xml.transform.Source;
import javax.xml.transform.stream.StreamSource;
import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;
import javax.xml.validation.Validator;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * XML校验器
 * 
 * @author 许畅
 * @since JDK1.7
 * @version 2019年4月16日 许畅 新建
 */
public class XmlValidator {
    
    /** XML schema */
    private static final String XML_SCHEMA = "http://www.w3.org/2001/XMLSchema";
    
    /** 日志记录 */
    private static final Logger LOGGER = LoggerFactory.getLogger(XmlValidator.class);
    
    /** xsd约束 */
    private File xsd;
    
    /** 需要校验的xml */
    private File xml;
    
    /**
     * 构造方法
     *
     * @param xsd xsd约束文件
     * @param xml 需要校验的xml
     */
    public XmlValidator(File xsd, File xml) {
        setXsd(xsd);
        setXml(xml);
    }
    
    /**
     * 构造方法
     *
     * @param xsd xsd约束文件
     * @param xml 需要校验的xml
     */
    public XmlValidator(Path xsd, Path xml) {
        setXsd(xsd.toFile());
        setXml(xml.toFile());
    }
    
    /**
     * 根据xsd校验xml
     * 
     * @return 校验结果集
     */
    public ValidateResult<String> validate() {
        ValidateResult<String> result = new ValidateResult<String>();
        FileInputStream fileInputStream = null;
        try {
            // 建立schema工厂
            SchemaFactory schemaFactory = SchemaFactory.newInstance(XML_SCHEMA);
            // 利用schema工厂,接收验证文档文件对象生成Schema对象
            Schema schema = schemaFactory.newSchema(xsd);
            // 通过Schema产生针对于此Schema的验证器,利用schenaFile进行验证
            Validator validator = schema.newValidator();
            // 得到验证的数据源
            fileInputStream = new FileInputStream(xml);
            Source source = new StreamSource(fileInputStream);
            // 开始验证,成功输出success!!!,失败输出fail
            validator.validate(source);
        } catch (Exception e) {
            result.setSuccess(false);
            String errorMsg = xml.getName() + "校验不通过,请检查【" + xsd.getName() + "】详细约束规则:" + e.getMessage();
            result.setResult(errorMsg);
            LOGGER.error(errorMsg, e);
        } finally {
            if (fileInputStream != null) {
                try {
                    fileInputStream.close();
                } catch (IOException e) {
                    LOGGER.error(e.getMessage(), e);
                }
            }
        }
        return result;
    }
    
    /**
     * @return 获取 xsd属性值
     */
    public File getXsd() {
        return xsd;
    }
    
    /**
     * @param xsd 设置 xsd 属性值为参数值 xsd
     */
    public void setXsd(File xsd) {
        this.xsd = xsd;
    }
    
    /**
     * @return 获取 xml属性值
     */
    public File getXml() {
        return xml;
    }
    
    /**
     * @param xml 设置 xml 属性值为参数值 xml
     */
    public void setXml(File xml) {
        this.xml = xml;
    }
    
    /**
     * 校验结果集
     * 
     * @author 许畅
     * @since JDK1.7
     * @version 2019年4月16日 许畅 新建
     * @param <T> 结果集泛型
     */
    public class ValidateResult<T> {
        
        /**
         * 构造方法
         */
        public ValidateResult() {
            this.success = true;
        }
        
        /** 是否校验成功 */
        private boolean success;
        
        /** 结果集 */
        private T result;
        
        /**
         * @return 获取 success属性值
         */
        public boolean isSuccess() {
            return success;
        }
        
        /**
         * @param success 设置 success 属性值为参数值 success
         */
        public void setSuccess(boolean success) {
            this.success = success;
        }
        
        /**
         * @return 获取 result属性值
         */
        public T getResult() {
            return result;
        }
        
        /**
         * @param result 设置 result 属性值为参数值 result
         */
        public void setResult(T result) {
            this.result = result;
        }
        
    }
    
}

 

附件是我写的一个demo程序,该程序的功能是根据一个定义好的XSD文件去检查指定的XML文件是否满足XSD的约束。 这里的约束比标准的约束要弱一些,比如:这里的约束不限制元素出现的顺序,只关心有没有这个元素。 我测试过的场景: 1.XSD文件中,为某个节点增加一个子节点,程序运行后,检查该子节点是否被添加(此时节点默认值为空字符串); 2.XSD文件中,为某个节点增加一个子节点,然后再为该节点定义一个默认值,程序运行后,检查该子节点是否被添加,以及他的默认值是否是XSD中指定的值; 3.XSD文件中,为某个节点增加一个属性,程序运行后,检查属性是否被添加;同样,如果为属性指定了默认值,该属性的默认值应为XSD中指定的值; 4.XSD文件中,为某个*可重复*的节点增加一个子节点,程序运行后,检查该子节点是否在所有的匹配元素中都被添加;同样如果为子节点指定了默认值,则新添加的子节点的默认值应为XSD中指定的值; 5.XSD文件中,为某个*可重复*的节点增加一个属性,程序运行后,检查该属性是否在所有匹配的元素中都被添加;同样如果为该属性指定了默认值,则新添加的属性的默认值应为XSD中指定的值。 6.XSD文件中,为某个节点增加一个带有属性的子节点,程序运行后,检查子节点是否被添加,以及子节点的属性是否被添加;同样如果为子节点和属性指定了默认值,则新添加的子节点和属性的默认值应为XSD中指定的值。 附件被解压后,有一个eclipse工程和两个文件:salary.xsd & salary.xml。这是我拿分箱处的XML的测试。 将这两个文件放到 c:/xml文件夹下面,运行工程中的test.upgrade.client.Upgrade.java,可以试试。 大家可以任意更改xsdxml,只要不: 1. 改变或删除XML的根节点名称; 2.XML更改后使其不符合XML的规范,比如:某个节点没有被闭合。 程序都还能保证对XML的更改使其满足XSD中规定的元素和属性。 也可以试试其他的XML文件,关于产生XML对应的XSD文件,可以从这个网址上转换一下: http://www.freeformatter.com/xsd-generator.html 我的做法是: 1 解析XSD文件,并将其规定的XML结构映射至自定义的Java类(XMLNode); 2 根据得到XML结构,逐一检查目标XML中是否存在指定的元素或属性。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值