org.apache.ibatis.binding.BindingException: Invalid bound statement (not found) 引发的血案

故事背景

今天在跑项目(SpringBoot+mybatis)时，当通过service调用DAO时，系统抛出了异常：

org.apache.ibatis.binding.BindingException: Invalid bound statement (not found)

很奇怪的异常，异常堆栈也没有关键的信息。从这句话大概的分析可以知道原因是：mybatis的Mapper接口不能够和XML映射文件绑定起来，所以导致的接口调用失败。

解决历程：

首先当然是Google，这个问题原来很常见，网上给出的解决方案终结一下大概有下面几点：

1. 检查xml文件所在的package名称是否和interface对应的package名称一一对应（这个不是必须）

2. 检查xml文件的namespace是否和mapper接口的package名称一一对应

3. 检查函数名称能否对应上

4. 去掉xml文件中的中文注释

5. 随意在xml文件中加一个空格或者空行然后保存

以上几点我都做了确保，依旧没有解决问题。

此外还有一个很奇怪的现象，我跑单元测试时，无论是我调用Service还是直接调用DAO，都能够很好的执行，并获得结果。然后就自习对比了一下， 发现在我项目的Application.java和ApplicationTest.java中有一点区别，就是：Application.java类上我加了@MapperScan注解，也就是指定了Mapper接口的扫描路径，这是唯一的区别了，于是从这里出发。

1. 先看@MapperScan注解的作用

这个注解可以加载Java config类上面，用于扫描mybatis的Mapper接口。里面有两个很重要的属性：

• basePackages ：这个值注解扫描的base包。

• annotationClass：准确的指定这个扫描器扫描的注解，也就是被某个注解标记的接口才会被扫描成Mapper。

但是我在自己的应用中，@MapperScan值配置了basePackages属性，没有配置annotationClass属性，所以那个model包下面的DAO接口，也就扫描成了Mapper，但是这个DAO接口是没有对应的XML映射文件的，所以报错了。

2. 解决方式：

后来我加上了annotationClass=Mapper.class这个属性之后，就可以正常的访问了。问题成功解决。

3. 深究背后的原理(source is truth)

我们应该仔细看一下@MapperScan 源码：

@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.TYPE)@Documented@Import(MapperScannerRegistrar.class)public @interface MapperScan {  String[] value() default {};  String[] basePackages() default {};  Class<?>[] basePackageClasses() default {};  Class<? extends BeanNameGenerator> nameGenerator() default BeanNameGenerator.class;  Class<? extends Annotation> annotationClass() default Annotation.class;  Class<?> markerInterface() default Class.class;  String sqlSessionTemplateRef() default "";  String sqlSessionFactoryRef() default "";  Class<? extends MapperFactoryBean> factoryBean() default MapperFactoryBean.class;}

上面的源码我们应该关注的是：@Import(MapperScannerRegistrar.class)

也就是MapperScan 导入了MapperScannerRegistrar并作为一个bean。也就是需要分析MapperScannerRegistrar.java源码

从类继承图我们知道关键点在于ImportBeanDefinitionRegistrar.class 接口。实现这个接口我们能够具备注册除了Spring标准的bean以外的其余bean到Spring容器。

完整的源码我就不给了，我就给出
registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) 里面的核心部分。

Class<? extends Annotation> annotationClass = annoAttrs.getClass("annotationClass");if (!Annotation.class.equals(annotationClass)) {  scanner.setAnnotationClass(annotationClass);}

这段代码显示，当我们没有配置@MapperScan注解的annotationClass 属性的时候，那么scanner就会不会设置scanner的annotationClass域，当我们配置了这个属性时，就会把这个条件注入scanner里面。

在 scanner.registerFilters(); 里面有一行很重要的代码：

// if specified, use the given annotation and / or marker interfaceif (this.annotationClass != null) {  addIncludeFilter(new AnnotationTypeFilter(this.annotationClass));  acceptAllInterfaces = false;}if (this.markerInterface != null) {  addIncludeFilter(new AssignableTypeFilter(this.markerInterface) {    @Override    protected boolean matchClassName(String className) {      return false;    }  });  acceptAllInterfaces = false;}

也就是如果scanner的annotationClass为空，那么mybatis的scanner注册器就不会添加AnnotationTypeFilter，也就是不会添加annotation作为过滤条件。但是我也没有配置markerInterface属性，也就是接口过滤，这时候，@MapperScanner会扫描basePackages下面的所有接口都作为Mapper,也就是把DAO也作为Mapper扫描了，也就会抛出碰到的异常。

至此，原理分析完毕。

其实这里面涉及到两个Spring特别重要的类：
ImportBeanDefinitionRegistrar
ClassPathBeanDefinitionScanner
理解这两个类会大大加深对Spring的理解

参考：http://blog.csdn.net/softwarehe/article/details/8889206