在Java中如何启用Schema对XML文档校验

作者: Peter潘的博客 | 来源:发表于2017-06-05 03:26 被阅读1429次

前言

好久没有写博客了，换了工作，才发现入坑(即使大公司也想选择自己喜欢且合适的部门啊，不是BAT就一定牛逼的)。。。😔，不扯了，生活还是要继续，技术还是要研究！平时我们在编写Spring配置的时候，一旦在配置上有错误，在应用启动的时候，就会抛出校验错误的异常。最近在研究Spring源码时，发现其底层在处理XML元素时，是对解析器做了特殊的配置，才实现了Schema对XML文档的校验功能(在默认情况下并不支持)，带着好奇心就对其进行研究了一下，并且为后续的源码分析做一个基础和铺垫。

先来看一个简单地例子

PS:Spring底层对于XML的解析使用的Java本身自带的JAXP来进行处理，并没有使用Dom4j等框架来进行处理，至于为什么没有像Hibernate那样使用Dom4j来完成配置文件的解释，我个人认为是:XML的解析工作本身并不是一件复杂的事情，它就是个体力活，因此Spring的设计者们在设计的时候应该是考虑到在处理这些工作的时候没有必要再去引入一些第三方的依赖来进行处理，因此我们这里的例子也是基于JAXP来说明的。

下面是一份不满足Schema约束的文档，我们将使用JAXP来对其进行解析，看看其是否抛出异常。

不满足Schema约束的文档.png

package com.panlingxiao.spring.ioc.xml;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;

/**
 * Created by panlingxiao on 2017/6/5.
 * 使用JAXP解析一份无效的XML文档(即满足相应DTD和Schema定义的元素规则)，
 */
public class ValidateXmlTest {

    public static void main(String[] args) throws Exception{
       DocumentBuilderFactory builderFactory = DocumentBuilderFactory.newInstance();
        DocumentBuilder documentBuilder = builderFactory.newDocumentBuilder();
        //解析文档
        Document document = documentBuilder.parse(ValidateXmlTest.class.getClassLoader().getResourceAsStream("validation/error.xml"));
        System.out.println(document);
    }
}

运行上面的程序:

运行结果1.png

我们会发现，上面的运行结果压根没有抛出异常，从而我们可以得到结论：在默认的情况下，使用Jaxp的DOM解析并不会使用Shema完成对XML文档的校验。

启用Schema对XML文档校验

如果在使用JAXP解析XML文档时,希望能够实现通过Schema对其进行校验的话，我们只需完成以下的几个步骤即可：

设置DocumentBuilderFactory，让底层的解析器启用校验功能
设置DocumentBuilderFactory属性，指定使用哪一个Schema完成对文档的校验(默认都是W3C规范所提供的Schema)
设置DocumentBuilderFactory，让底层的解析器提供对命名空间的支持，因为默认情况下其只支持DTD，解析器并不支持命名空间，如果解析器不支持命名空间，那么其Schema校验依然无效(这点需要特别注意)
为DocumentBuilder设置一个ErrorHandler，如果不设置，则会使用默认的ErrorHandler,它只会给出警告信息，并不会抛出异常，因此那样对于我们来说就没啥意义了

下面就让我们验证上面的步骤，这里我并不准备直接给出一个最终的结果，而是通过每一个步骤，来验证上面的结论，这样更能清楚的帮助我们理解它们的作用和意义。

设置启用解析器进行文档校验:

package com.panlingxiao.spring.ioc.xml;

import org.w3c.dom.Document;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;

/**
 * Created by panlingxiao on 2017/6/5.
 * 使用JAXP解析一份无效的XML文档(即满足相应DTD和Schema定义的元素规则)，
 */
public class ValidateXmlTest {

    public static void main(String[] args) throws Exception{
        DocumentBuilderFactory builderFactory = DocumentBuilderFactory.newInstance();
        //设置解析器在解析文档的时候校验文档
        builderFactory.setValidating(true);

        DocumentBuilder documentBuilder = builderFactory.newDocumentBuilder();
        //解析文档
        Document document = documentBuilder.parse(ValidateXmlTest.class.getClassLoader().getResourceAsStream("validation/error.xml"));
        System.out.println(document);
    }
}

设置启用解析器进行文档校验---运行结果.png

通过上面的警告，我们可以看到两个问题：第一是在校验的过程中发生了错误，但是并没有抛出异常，第二是说在校验的过程中没有找到DOCTYPE，即没有找到对应DTD文档，这也说明了解析器在默认情况下并不支持XSD的校验。

不支持Schema的原因分析.png

好了，既然文档上都这么说了，那么我们就只能启用XSD的校验！

使用XSD校验

package com.panlingxiao.spring.ioc.xml;

import org.w3c.dom.Document;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;

/**
 * Created by panlingxiao on 2017/6/5.
 * 使用JAXP解析一份无效的XML文档(即满足相应DTD和Schema定义的元素规则)，
 */
public class ValidateXmlTest {
    //定义两个常量，注意：这两个常量是固定值
    static final String JAXP_SCHEMA_LANGUAGE = 
"http://java.sun.com/xml/jaxp/properties/schemaLanguage";
          
    static final String W3C_XML_SCHEMA ="http://www.w3.org/2001/XMLSchema";

    public static void main(String[] args) throws Exception{
        DocumentBuilderFactory builderFactory = DocumentBuilderFactory.newInstance();
        //设置解析器在解析文档的时候校验文档
        builderFactory.setValidating(true);
        //通过指定factory的属性，确定使用Schema进行校验
        builderFactory. setAttribute(JAXP_SCHEMA_LANGUAGE,W3C_XML_SCHEMA);

        DocumentBuilder documentBuilder = builderFactory.newDocumentBuilder();

        //解析文档
        Document document = documentBuilder.parse(ValidateXmlTest.class.getClassLoader().getResourceAsStream("validation/error.xml"));
        System.out.println(document);
    }
}

启用XSD的校验的结果.png

可以看到，这次的错误信息和上面所产生的信息完全不同，而且像cvs-xxx这种错误，我们平时在编写Spring配置的时候也经常遇到，其本质就是因为命名空间所导致的。

命名空间造成的错误.png

下面我们为解析器加上对命名空间的支持：

package com.panlingxiao.spring.ioc.xml;

import org.w3c.dom.Document;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;

/**
 * Created by panlingxiao on 2017/6/5.
 * 使用JAXP解析一份无效的XML文档(即满足相应DTD和Schema定义的元素规则)，
 */
public class ValidateXmlTest {

    //定义两个常量，注意：这两个常量是固定值
    static final String JAXP_SCHEMA_LANGUAGE =
            "http://java.sun.com/xml/jaxp/properties/schemaLanguage";
    static final String W3C_XML_SCHEMA =
            "http://www.w3.org/2001/XMLSchema";

    public static void main(String[] args) throws Exception{
        DocumentBuilderFactory builderFactory = DocumentBuilderFactory.newInstance();
        //设置解析器在解析文档的时候校验文档
        builderFactory.setValidating(true);
        //通过指定factory的属性，确定使用Schema进行校验
        builderFactory. setAttribute(JAXP_SCHEMA_LANGUAGE,W3C_XML_SCHEMA);
        //让解析器支持命名空间
        builderFactory.setNamespaceAware(true);

        DocumentBuilder documentBuilder = builderFactory.newDocumentBuilder();
        //解析文档
        Document document = documentBuilder.parse(ValidateXmlTest.class.getClassLoader().getResourceAsStream("validation/error.xml"));
        System.out.println(document);
    }
}

解析器支持命名空间后的结果.png

直接使用IDE的validate校验功能.png

可以看到，上面的错误信息是一样的，只是我们的代码中并没有将错误以异常的形式抛出，而只是以警告的信息输出而已，我们只需加上一个ErrorHandler，自己手动地将异常输出即可。

package com.panlingxiao.spring.ioc.xml;

import org.w3c.dom.Document;
import org.xml.sax.ErrorHandler;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;

/**
 * Created by panlingxiao on 2017/6/5.
 * 使用JAXP解析一份无效的XML文档(即满足相应DTD和Schema定义的元素规则)，
 */
public class ValidateXmlTest {

    //定义两个常量，注意：这两个常量是固定值
    static final String JAXP_SCHEMA_LANGUAGE =
            "http://java.sun.com/xml/jaxp/properties/schemaLanguage";
    static final String W3C_XML_SCHEMA =
            "http://www.w3.org/2001/XMLSchema";

    public static void main(String[] args) throws Exception{
        DocumentBuilderFactory builderFactory = DocumentBuilderFactory.newInstance();
        //设置解析器在解析文档的时候校验文档
        builderFactory.setValidating(true);
        //通过指定factory的属性，确定使用Schema进行校验
        builderFactory. setAttribute(JAXP_SCHEMA_LANGUAGE,W3C_XML_SCHEMA);
        //让解析器支持命名空间
        builderFactory.setNamespaceAware(true);

        DocumentBuilder documentBuilder = builderFactory.newDocumentBuilder();
        //添加ErrorHandler,将解析的异常手动抛出
        documentBuilder.setErrorHandler(new ErrorHandler() {
            @Override
            public void warning(SAXParseException exception) throws SAXException {
                System.out.println("warning");
                throw  exception;
            }

            @Override
            public void error(SAXParseException exception) throws SAXException {
                System.out.println("error");
                throw  exception;
            }

            @Override
            public void fatalError(SAXParseException exception) throws SAXException {
                System.out.println("fatal");
                throw  exception;
            }
        });

        //解析文档
        Document document = documentBuilder.parse(ValidateXmlTest.class.getClassLoader().getResourceAsStream("validation/error.xml"));
        System.out.println(document);
    }
}

运行结果:

加上ErrorHandler后的运行结果.png

我们终于看到了"熟悉的错误"，通过以上的配置，我们即可完成在解析XML文档时，同时使用Schema来对文档本身是否有效进行校验。这里需要说明一下的是，两种校验方式是无法共存的，默认使用的是DTD校验，但是我们一旦设置了使用Schema校验，那么即使是一份使用DTD约束的有效文档，也校验时也会出错。

Spring中的处理方式

分析完上面的内容，我们知道了自己如何去使用Schema对XML文档校验。下面我们来看一下Spring中处理方式。由于Spring中内容较多，我们不再从头开始分析起，我们会直接定位到我们关注的部分进行查看。

Spring中的处理方式.png

这里需要说明一下的是，Spring中在外部看来，是通过XMLBeanDefinitionReader来完成Bean定义的加载、解析、以及Bean定义的注册，但是XMLBeanDefinitionReader其底层维护了多个组件来完成上面的每一件事情，这很好地体现了单一职责的设计。而DefaultDocumentLoader这个组件，就是完成Bean定义的加载功能。

上面的源码非常简单：
(1). 它首先创建出DocumentBuilderFactory，并且设置namespaceAware的值，但是这里的值是由外部传入的，那么它到底是true还是false呢?它的默认设置是false,其原因是因为设置namespaceAware为true的情况只有在使用Schema的校验情况下进行处理，而如果是DTD校验，实际上是没有必要的。然而由于Spring早期的校验方式是基于DTD的，到了2.5之后才出现了XSD的校验方式。为了兼容多种情况的存在，因此它这里一开始将namespaceAware设置为false,一旦发现是XSD校验时，再把它重新设置为true即可。

(2).判断当前的校验模式，即判断是DTD校验还是XSD校验。在Spring中，是通过一个int值来区分校验的模式。

校验模式.png

不管使用哪种校验方式，都需要将DocumentBuilderFactory的validating设置为true。如果发现使用的是XSD校验，则强制地设置让解析器去支持namespace。并且设置使用标准的W3C所提供的XSD进行校验，后面的设置与我们上面的实例是一样的。

设置Factory的属性.png

在设置完成之后，后面的处理就是完成对Bean定义的加载了。

加载Bean定义.png

至此，我们就已经分析完成所有如何使用Schema校验的全部内容，如果对您有所帮助，请为我点个👍，谢谢~

在Java中如何启用Schema对XML文档校验

前言

先来看一个简单地例子

启用Schema对XML文档校验

Spring中的处理方式

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

Java学习笔记

程序员