使用XSD校验Mybatis的SqlMapper配置文件(2)

编写好XSD文件，然后来看怎么使用XSD文件校验，并解析SqlMapper文件，也就是实现doParseSqlMapperResourceWithSchema()方法。

为了实现这个功能，有两个基本要求：

(1)兼容性：需要兼容mybatis的原生配置，兼容有两种层级，一种是使用DTD校验，这个前面已经说了，走原来的流程，兼容性没有问题；另一种就是走XSD校验，但也需要兼容mybatis原生配置，这种兼容性一方面从上面修改的XSD文件去保证，另一方面也需要从XML的解析去保证。

(2)扩展性：修改的目的就是为了扩展性，所以扩展性也是一个基本要求。但是扩展性不是随意性，也需要按照规范来扩展，这个规范就是自定义的XSD文件。

 

为了达到这两个基本要求，下面是我的一种思路，主要借鉴于Spring的自定义命名空间：

1、创建一个EntityResolver，读取类路径下指定模式的配置文件，比如："classpath*:**/dysd-*-namespaces.ini"

2、在ini文件中定义命名空间元信息，如：

使用命名空间作为Section的名称，下面的schema、parser分别表示命名空间的xsd文件和解析器实现类，这样就可以根据XML中的XSD命名空间找到校验文件，并且有一个解析入口了。

说明：

1. apache的commons-configuration提供了ini格式文件的读取API
2. Spring中使用META-INF/spring.schemas和META-INF/spring.handlers来存储XSD文件和解析器实现类，这里我修改为使用ini文件集中配置
3. 因为读取的是所有类路径下满足通配符的ini文件，因此可以非常简单的扩展其它命名空间，至于在Java中具体怎么使用XSD来校验，这里就不细说了

我把XML的解析分解为三要素：解析上下文、解析器、被解析文件。doParseSqlMapperResourceWithSchema()方法也很简洁：

protected void doParseSqlMapperResourceWithSchema(Configuration configuration, Resource mapperLocation){
    ISqlMapperParserContext context = new SqlMapperParserContext(configuration);
    XmlParserUtils.parseXml(context, mapperLocation);
}

解析器接口如下：

public interface IParser<E extends IParserContext> {
    public void parse(E parserContext, String location);
    public void parse(E parserContext, String[] locationPatterns);
    public void parse(E parserContext, InputStream inputStream);
    public void parse(E parserContext, Resource resource);
}

解析上下文和解析器实现类又依次分为三个层级：

（1）通用解析上下文：

public interface IParserContext { 
    public ProblemReporter getProblemReporter();
    public EventListener getEventListener();
    public SourceExtractor getSourceExtractor();
    public Environment getEnvironment();
}

相应层级的解析器实现类主要负责加载被解析文件（比如将字符串通配符加载为Resource对象集合），保证不重复解析，保证可并发执行等。

（2）XML解析上下文

public interface IXmlParserContext extends IParserContext{
    public boolean isNamespaceAware();  
    public DocumentLoader getDocumentLoader();
    public EntityResolver getEntityResolver();
    public ErrorHandler getErrorHandler();
    public XmlParserDelegate getDelegate();
}

相应层级的解析器实现类主要负责将Resource转换为Document对象，并在转换的过程中进行校验。

（3）SqlMapper解析上下文

public interface ISqlMapperParserContext extends IXmlParserContext{
    public Configuration getConfiguration();
}

相应层级的解析器实现类主要负责查找根元素所在命名空间的解析器，并使用解析器对Document进行解析。

最终，将解析委托给ini配置文件中的SchemaSqlMapperNamespaceParser类，但是因为这个类需要在文本文件中配置，不方便有参数的构造函数，因而进一步委托给SchemaSqlMapperParserDelegate：

public class SchemaSqlMapperNamespaceParser implements INamespaceParser<ISqlMapperParserContext> {

    @Override
    public void init() {
        
    }

    @Override
    public void parse(ISqlMapperParserContext parserContext, Document document, Resource resource) {
        SchemaSqlMapperParserDelegate delegate = new SchemaSqlMapperParserDelegate(parserContext, document, resource);
        delegate.parse();
    }
    
    @Override
    public void destory() {
        
    }
}

至此，XSD校验已经完成，也已经找到XML解析入口，后续就是在SchemaSqlMapperParserDelegate中真正的解析了。