mybatis中的異常BindingException詳解

更新時間：2024年01月18日 08:58:51 作者：小白不很白

這篇文章主要介紹了mybatis中的異常BindingException詳解,此異常是mybatis中拋出的,意思是使用的這個方法找到,但是因為mapperScan()已經掃描到了Mapper類了,在綁定Mapper.xml時沒有綁定到導致的,需要的朋友可以參考下

BindingException異常

此異常是mybatis中拋出的。

意思是使用的這個方法找到,但是因為mapperScan()已經掃描到了Mapper類了，在綁定Mapper.xml時沒有綁定到導致的。

具體異常信息

org.apache.ibatis.binding.BindingException: Invalid bound statement (not found): com.xxx.xxx.xxx.dao.mapper.PageTemplateMapper.findPageTemplateBasicInfoList
   at org.apache.ibatis.binding.MapperMethod$SqlCommand.<init>(MapperMethod.java:227)
   at org.apache.ibatis.binding.MapperMethod.<init>(MapperMethod.java:49)
   at org.apache.ibatis.binding.MapperProxy.cachedMapperMethod(MapperProxy.java:65)
   at org.apache.ibatis.binding.MapperProxy.invoke(MapperProxy.java:58)
   at com.sun.proxy.$Proxy202.findPageTemplateBasicInfoList(Unknown Source)
.....

使用mybatis的步驟

首先要創(chuàng)建一個interface接口Mapper類。

package com.xiaobai.front.cms.dao.mapper;
public interface PageTemplateMapper {
     List<PageTemplateBasicInfo> findPageTemplateBasicInfoList(PageTemplateQueryDto pageTemplateQueryDto);
}

在啟動類或者配置類加掃描Mapper類的路徑。使用的是@MapperScan注解。里面配置的是Mapper類的包路徑。

@Configuration
@MapperScan("com.xiaobai.front.cms.dao.mapper")
public class MybatisConfig {
}

在資源文件夾下配置對應mapper.xml文件，并且寫對應上面方法(findPageTemplateBasicInfoList)的sql。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<mapper namespace="com.xiaobai.front.cms.dao.mapper.PageTemplateMapper">
  <select id="findPageTemplateBasicInfoList" resultType="com.dffl.front.cms.domain.response.PageTemplateBasicInfo">
    .......
  </select>
</mapper>

在配置文件中配置mybatis掃描mapper.xml的路徑

mybatis:
  # 配置mapper的掃描，找到所有的mapper.xml映射文件
  mapperLocations: classpath*:mapper/**/*Mapper.xml

出現BindingException原因分析

第一種

如果mapper.xml中沒有寫對應的方法在啟動項目的時候不會拋出該異常。而在用到該方法時會拋出異常

public SqlCommand(Configuration configuration, Class<?> mapperInterface, Method method) {
      final String methodName = method.getName();
      final Class<?> declaringClass = method.getDeclaringClass();
      MappedStatement ms = resolveMappedStatement(mapperInterface, methodName, declaringClass,
          configuration);
      if (ms == null) {
        if (method.getAnnotation(Flush.class) != null) {
          name = null;
          type = SqlCommandType.FLUSH;
        } else {
          throw new BindingException("Invalid bound statement (not found): "
              + mapperInterface.getName() + "." + methodName);
        }
      } else {
        name = ms.getId();
        type = ms.getSqlCommandType();
        if (type == SqlCommandType.UNKNOWN) {
          throw new BindingException("Unknown execution method for: " + name);
        }
      }
    }
private MappedStatement resolveMappedStatement(Class<?> mapperInterface, String methodName,
        Class<?> declaringClass, Configuration configuration) {
      String statementId = mapperInterface.getName() + "." + methodName;
      if (configuration.hasStatement(statementId)) {
        return configuration.getMappedStatement(statementId);
      } else if (mapperInterface.equals(declaringClass)) {
        return null;
      }
      for (Class<?> superInterface : mapperInterface.getInterfaces()) {
        if (declaringClass.isAssignableFrom(superInterface)) {
          MappedStatement ms = resolveMappedStatement(superInterface, methodName,
              declaringClass, configuration);
          if (ms != null) {
            return ms;
          }
        }
      }
      return null;
    }

configuration 對象是里面有很多的map。其中一個就是掃描mapper類和mapper.xml文件生成的每個方法對應的sql數據。mappedStatements key對應的是mapper類里面的全路徑方法名比如：com.xiaobai.front.cms.dao.mapper.PageTemplateMapper.findPageTemplateBasicInfoList。value對應的就是mapper.xml的信息對象。
當在調用這個findPageTemplateBasicInfoList方法的時候由于mapper.xml中沒有對應的綁定這個方法，mappedStatements中就獲取不到數據。
因為mappedStatements沒有數據所以resolveMappedStatement方法返回null。
所以最后會拋出throw new BindingException("Invalid bound statement (not found): "
mapperInterface.getName() + “.” + methodName);

第二種

沒有配置@MapperScan(“com.xiaobai.front.cms.dao.mapper”)執(zhí)行某方法時也會拋出此異常

 public Resource[] resolveMapperLocations() {
    ResourcePatternResolver resourceResolver = new PathMatchingResourcePatternResolver();
    List<Resource> resources = new ArrayList<Resource>();
    if (this.mapperLocations != null) {
      for (String mapperLocation : this.mapperLocations) { 
        try {
          Resource[] mappers = resourceResolver.getResources(mapperLocation);
          resources.addAll(Arrays.asList(mappers));
        } catch (IOException e) {
          // ignore
        }
      }
    }
    return resources.toArray(new Resource[resources.size()]);
  }