使用XSD校验Mybatis的SqlMapper配置文件的方法(1)

 更新时间:2016年11月07日 09:12:30   作者:linjisong  
这篇文章以前面对SqlSessionFactoryBean的重构为基础,简单的介绍了相关操作知识,然后在给大家分享使用XSD校验Mybatis的SqlMapper配置文件的方法,感兴趣的朋友参考下吧

这篇文章以前面对SqlSessionFactoryBean的重构为基础,先简单回顾一下做了哪些操作:

新建SqlSessionFactoryBean,初始代码和mybatis-spring相同;

重构buildSqlSessionFactory()方法,将众多的if语句抽取为一组小方法,预留自定义配置的方法,同时添加常用属性的getter方法;

提取组件工厂接口,并提供组件创建工具类SqlSessionComponetFactorys,将散落在不同地方的new Xxx()集中管理,便于组件的替换。

现在来看怎么扩展,首先创建SchemaSqlSessionFactoryBean,继承重构后的SqlSessionFactoryBean,在XML配置中同步修改为新建的类:

public class SchemaSqlSessionFactoryBean extends SqlSessionFactoryBean {
}

对于一些简单的功能扩展,比如设置默认结果类型,扫描指定的类型简称,这里就不过多讨论了,这里集中讲述怎么扩展为使用XSD校验SqlMapper配置。

一、覆盖SqlSessionFactoryBean中的doParseSqlMapperResource()方法,这个方法的作用是解析一个SqlMapper配置文件

当然,为了兼容性,需要先判断是否为DTD,如果是DTD,按原方法解析,否则按自定义方法解析:

package org.dysd.dao.mybatis.schema;
import org.apache.ibatis.executor.ErrorContext;
import org.apache.ibatis.session.Configuration;
import org.springframework.core.NestedIOException;
import org.springframework.core.io.Resource;
import org.springframework.util.xml.XmlValidationModeDetector;
public class SchemaSqlSessionFactoryBean extends SqlSessionFactoryBean {
@Override
protected void doParseSqlMapperResource(Configuration configuration, Resource mapperLocation)
throws NestedIOException {
int mode = detectValidationMode(mapperLocation);
if(mode == XmlValidationModeDetector.VALIDATION_DTD){//如果是DTD,使用Mybatis官方的解析
super.doParseSqlMapperResource(configuration, mapperLocation);
}else{
try {
// 使用Schema校验
this.doParseSqlMapperResourceWithSchema(configuration, mapperLocation);
} catch (Exception e) {
throw new NestedIOException("Failed to parse mapping resource: '" + mapperLocation + "'", e);
} finally {
ErrorContext.instance().reset();
}
}
}
protected void doParseSqlMapperResourceWithSchema(Configuration configuration, Resource mapperLocation){
}
private int detectValidationMode(Resource mapperLocation) throws NestedIOException {
int mode = -1;
try {
XmlValidationModeDetector detector = new XmlValidationModeDetector();
mode = detector.detectValidationMode(mapperLocation.getInputStream());
} catch (Exception e) {
throw new NestedIOException("Failed to parse mapping resource: '" + mapperLocation + "'", e);
} finally {
ErrorContext.instance().reset();
}
return mode;
}
}

这里借用了Spring中的XmlValidationModeDetector来侦测XML配置文件的校验模式,逻辑上也很简单,就是一行一行读,在正文开始前,发现有dtd定义,就返回DTD模式,否则返回XSD模式(实际上,不止是侦测模式借用了Spring,后面的自定义命名空间也借鉴了Spring)。

至此,对SqlMapper配置文件的解析工作已经分为两支,兼容mybatis官方的解析,并将XSD模式下的解析导航到方法doParseSqlMapperResourceWithSchema()中。

二、编写用于校验SqlMapper的XSD文件(需要有一定的XSD基础知识,可参考本博客中关于XML部分的学习笔记)

1、先使用一款XML工具,将Mybatis的DTD文件转换为原始的XSD文件,有很多XML工具有这种功能,可以网上搜索一下

这里分成三个层级:

(1)根元素(mapper元素):对应一个SqlMapper文件,有一个namespace属性,表示它的子元素的一个逻辑分类。需注意的是,这里的namespace属性不同于XML命名空间,前者是mybatis自身的一个逻辑分类,后者是用于定义XML文件中可以出现的xml元素和属性约束。

(2)一级子元素(cache|cache-ref|resultMap|parameterMap|sql|insert|update|delete|select):mapper的一级子元素,因为mybatis框架对一级子元素有不同处理,所以这里单独作为一个层级,因为主要是增删改查语句,所以称之为语句级statement元素

(3)其它要素(SQL配置文本,include|trim|where|set|foreach|choose|if):用于配置SQL脚本的文本,以及动态脚本元素,称之为脚本级script元素

2、在生成XSD文件基础之上做如下修改

(1)添加命名空间,比如:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xsd:schema xmlns="http://dysd.org/schema/sqlmapper"
targetNamespace="http://dysd.org/schema/sqlmapper"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
elementFormDefault="qualified" version="1.0">

(2)将一级元素包装为一个元素组statementGroup

(3)修改mapper元素,允许出现其它命名空间的元素

(4)将动态脚本元素包装为一个元素组dynaScriptGroup,并允许出现其它命名的元素

(5)使用dynaScriptGroup替换出现动态脚本元素的地方,比如<select>元素

(6)其它的一些优化,比如将statementType可以取的三个值STATEMENT、PREPARED、CALLABLE定义为枚举类型:

<xsd:simpleType name="statementType">
<xsd:restriction base="xsd:token">
<xsd:enumeration value="STATEMENT" />
<xsd:enumeration value="PREPARED" />
<xsd:enumeration value="CALLABLE" />
</xsd:restriction>
</xsd:simpleType>

类似的还有parameterMode、jdbcType、javaType等等。

以上所述是小编给大家介绍的使用XSD校验Mybatis的SqlMapper配置文件小结,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对脚本之家网站的支持!

相关文章

  • Springboot项目打war包docker包找不到resource下静态资源的解决方案

    Springboot项目打war包docker包找不到resource下静态资源的解决方案

    今天小编就为大家分享一篇关于Springboot项目打war包docker包找不到resource下静态资源的解决方案,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-03-03
  • 详解Java中CountDownLatch的用法

    详解Java中CountDownLatch的用法

    这篇文章主要为大家详细介绍了Java中CountDownLatch类的用法,本文通过一些简单的示例进行了简单介绍,感兴趣的小伙伴可以跟随小编一起了解一下
    2023-05-05
  • 深入了解java Lombok的使用方法

    深入了解java Lombok的使用方法

    这篇文章主要介绍了深入了解java Lombok的使用,Lombok是一个通过注解以达到减少代码的Java库,如通过注解的方式减少get,set方法,构造方法等,需要的朋友可以参考下
    2019-06-06
  • Java编程Iterator迭代器设计原理及实现代码示例

    Java编程Iterator迭代器设计原理及实现代码示例

    这篇文章主要介绍了Java编程Iterator迭代器设计原理及实现代码示例,具有一定参考价值,需要的朋友可以了解下。
    2017-10-10
  • Netty启动流程注册多路复用源码解析

    Netty启动流程注册多路复用源码解析

    这篇文章主要介绍了Netty启动流程注册多路复用源码分析,继续分析channel是如何注册到selector中的,有需要的朋友可以借鉴参考下,希望能够有所帮助
    2022-03-03
  • JVM指令的使用深入详解

    JVM指令的使用深入详解

    这篇文章主要给大家介绍了关于JVM指令使用的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-01-01
  • java实现文件和base64相互转换

    java实现文件和base64相互转换

    这篇文章主要为大家详细介绍了java如何实现文件和base64相互转换,文中的示例代码讲解详细,具有一定的参考价值,感兴趣的小伙伴可以跟随小编一起学习一下
    2023-11-11
  • Java几个重要的关键字详析

    Java几个重要的关键字详析

    这篇文章主要介绍了Java几个重要的关键字详析,文章围绕主题展开详细的内容介绍,具有一定的参考一下,需要的小伙伴可以参考一下,希望对你的学习有所帮助
    2022-07-07
  • spring boot2结合mybatis增删改查的实现

    spring boot2结合mybatis增删改查的实现

    这篇文章主要给大家介绍了关于spring boot2结合mybatis增删改查的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用spring boot2具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧
    2019-09-09
  • java数据库开发之JDBC的完整封装兼容多种数据库

    java数据库开发之JDBC的完整封装兼容多种数据库

    这篇文章主要介绍了java数据库开发之JDBC的完整封装兼容多种数据库,需要的朋友可以参考下
    2020-02-02

最新评论