Java通过XML Schema校验XML

Java通过XML Schema校验XML

 

XML的校验在XML处理中非常常见，如果没有有效的办法来校验XML的合法性，往往会导致很多问题。

 

XML的校验是通过XML Schema（XSD） 或DTD文件的语法规范来校验的。DTD现在越来越不受欢迎了，在此选用XSD来校验。

 

Java校验XML是件和扯淡的事情，因为Sun的XML相关软件包会令你云里雾里。

W3C这块的XML相关的规范相当的多，这也是导致XML处理器起来费劲的主要原因。要想精通这些规范和相关的API，实在是异想天开（新的规范在不停出，越来越多！）。

 

校验的原理是通过读取解析XML的时候设置校验的XSD和校验错误处理器，顺便校验的。

 

下面不扯这些废话了，我用DOM4j结合javaxml api使用XSD来校验一个xml有效性，下面这个例子虽然和蹩脚，但是也费了一番功夫，放出来大家研究吧，有更好的实现也希望能和我一同分享。

 

例子如下：

 

XML文件

<? xml  version ="1.0" ?>
< note
         xmlns ="http://www.w3school.com.cn"
         xmlns:xsi ="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation ="http://www.w3school.com.cn file:///D:/_dev_stu/xsdtest/src/note.xml" >

     < to >George </ to >
     < from >John </ from >
     < heading >Reminder </ heading >
     < body >Don't forget the meeting this weekend! </ body >
</ note >

 

XSD文件

<? xml  version ="1.0" ?>
< xs:schema  xmlns:xs ="http://www.w3.org/2001/XMLSchema"
            targetNamespace ="http://www.w3school.com.cn"
            xmlns ="http://www.w3school.com.cn"
            elementFormDefault ="qualified" >

     < xs:element  name ="note" >
         < xs:complexType >
             < xs:sequence >
                 < xs:element  name ="to"  type ="xs:string" />
                 < xs:element  name ="from"  type ="xs:string" />
                 < xs:element  name ="heading"  type ="xs:string" />
                 < xs:element  name ="body"  type ="xs:string" />
             </ xs:sequence >
         </ xs:complexType >
     </ xs:element >

</ xs:schema >

 

测试代码

import org.dom4j.Document;
import org.dom4j.io.OutputFormat;
import org.dom4j.io.SAXReader;
import org.dom4j.io.SAXValidator;
import org.dom4j.io.XMLWriter;
import org.dom4j.util.XMLErrorHandler;

import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
import java.io.File;

/**
* Java XML校验测试
*
* @author leizhimin，2008-9-4 14:42:35
*/
public  class ValidataXMLTest {
     public  static  void main(String[] args) {
        validateXMLByXSD();
        validateXMLByDTD();

    }

     /**
     * 通过XSD（XML Schema）校验XML
     */
     public  static  void validateXMLByXSD() {
        String xmlFileName =  "Q:\\_dev_stu\\xsdtest\\src\\note.xml";
        String xsdFileName =  "Q:\\_dev_stu\\xsdtest\\src\\note.xsd";
         try {
             //创建默认的XML错误处理器
            XMLErrorHandler errorHandler =  new XMLErrorHandler();
             //获取基于 SAX 的解析器的实例
            SAXParserFactory factory = SAXParserFactory.newInstance();
             //解析器在解析时验证 XML 内容。
            factory.setValidating( true);
             //指定由此代码生成的解析器将提供对 XML 名称空间的支持。
            factory.setNamespaceAware( true);
             //使用当前配置的工厂参数创建 SAXParser 的一个新实例。
            SAXParser parser = factory.newSAXParser();
             //创建一个读取工具
            SAXReader xmlReader =  new SAXReader();
             //获取要校验xml文档实例
            Document xmlDocument = (Document) xmlReader.read( new File(xmlFileName));
             //设置 XMLReader 的基础实现中的特定属性。核心功能和属性列表可以在 [url]http://sax.sourceforge.net/?selected=get-set[/url] 中找到。
            parser.setProperty(
                     "http://java.sun.com/xml/jaxp/properties/schemaLanguage",
                    "http://www.w3.org/2001/XMLSchema");
            parser.setProperty(
                    "http://java.sun.com/xml/jaxp/properties/schemaSource",
                    "file:" + xsdFileName);
            //创建一个SAXValidator校验工具，并设置校验工具的属性
            SAXValidator validator = new SAXValidator(parser.getXMLReader());
            //设置校验工具的错误处理器，当发生错误时，可以从处理器对象中得到错误信息。
            validator.setErrorHandler(errorHandler);
            //校验
            validator.validate(xmlDocument);

            XMLWriter writer = new XMLWriter(OutputFormat.createPrettyPrint());
            //如果错误信息不为空，说明校验失败，打印错误信息
            if (errorHandler.getErrors().hasContent()) {
                System.out.println("XML文件通过XSD文件校验失败！");
                writer.write(errorHandler.getErrors());
            } else {
                System.out.println("Good! XML文件通过XSD文件校验成功！");
            }
        } catch (Exception ex) {
            System.out.println("XML文件: " + xmlFileName + " 通过XSD文件:" + xsdFileName + "检验失败。\n原因： " + ex.getMessage());
            ex.printStackTrace();
        }
    }

    /**
     * 通过DTD校验XML
     */
    public static void validateXMLByDTD() {
        //todo：暂时不用，以后再说吧
    }
}

 

运行结果

Good! XML文件通过XSD文件校验成功！