org.apache.ibatis.binding.BindingException分析及解决

一、问题描述

使用mybatis的项目在本地可以正常运行，但当使用maven或Jenkins打包部署到远程服务器上时出现了绑定错误，异常信息为：
org.apache.ibatis.binding.BindingException: Invalid bound statement (not found): com.yo.news.user.mapper.UserMapper.getUserByTelPwd

二、问题分析和解决方法

首先，给定的异常提示信息并不精准，有多个错误原因都会抛出该异常。mybatis出现这个问题，通常是由Mapper interface和对应的xml文件的定义对应不上引起的，这时就需要仔细检查对比包名、xml中的namespace、接口中的方法名称等是否对应。我之前就因为称忘记在xml标签的id属性中添加方法名或写错方法名而出现这个错误。

出现这个错误时，按以下步骤检查一般就会解决问题：
1：检查xml文件所在package名称是否和Mapper interface所在的包名一一对应；
2：检查xml的namespace是否和xml文件的package名称一一对应；
3：检查方法名称是否对应；
4：去除xml文件中的中文注释；
5：随意在xml文件中加一个空格或者空行然后保存。

6：如果接口中的返回值List集合（不知道其他集合也是），那么xml里面的配置，尽量用resultMap（保证resultMap配置正确）,不要用resultType

我在项目中遇到的问题可以使用第五个解决方法解决：“随意在xml文件中加一个空格或者空行然后保存”，看起来这么怪异的解决方式，实际上是触发了IDE的自动编译功能。由于xml文件在编译的时候，不一定总能立即从源目录复制到class文件的编译目录(MyEclipse经常出这个问题)，有时候你源目录中的xml文件已经修改好了，而class所在的目录里面还是旧的。因此真正确定有效的方式是将正确的xml文件复制到class输出目录。

发现了问题就要从根本上解决，而不应该当出现了问题再去解决。我最后发现Jenkins通过maven把项目打成war包，或者Eclipse通过使用maven命令tomcat7:deploy远程自动部署项目打成的war包，war包里面缺少Mapper对应的xml文件，也就是没有把xml文件打包进去。解决办法是，在pom.xml文件中的build标签中添加如下代码，显示的强制将xml文件打到war包中：

<resources>
        <resource>
            <directory>src/main/java</directory>
            <includes>
                <include>**/*.xml</include>
            </includes>
            <filtering>false</filtering>
        </resource>
</resources>

pom文件.png

还有种情况会出这个错误，比如配置xml映射文件需要满足特定要求：

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"  
    p:dataSource-ref="dataSource"  p:configLocation="classpath:mybatis-config.xml">
    <property name="mapperLocations">
        <list>
            <value>classpath*:mapper/com/xxx/**/*Mapper.xml</value>
            <value>classpath*:dao/com/xxx/**/*Mapper.xml</value>
        </list>
    </property>
 </bean>

如上只有Mapper结尾的xml文件才会被Mybatis扫描到，这个时候如果忘记了这个规则，xml使用了其他名称，如xxxDao.xml。这样xml的配置就不会加入到Mybatis存储配置的一个map对象里去，也会出现 Invalid bound statement 的错误。解决方法就是把xml文件改名即可。

另外mybatis还有另外一种参数绑定失败报错：

org.mybatis.spring.MyBatisSystemException: nested exception is org.apache.ibatis.binding.BindingException: Parameter 'status' not found. Available parameters are [param, fromUser, appid, param3, param1, param2]
 
	at org.mybatis.spring.MyBatisExceptionTranslator.translateExceptionIfPossible(MyBatisExceptionTranslator.java:76)
	at org.mybatis.spring.SqlSessionTemplate$SqlSessionInterceptor.invoke(SqlSessionTemplate.java:399)
	at com.sun.proxy.$Proxy27.update(Unknown Source)
	at org.mybatis.spring.SqlSessionTemplate.update(SqlSessionTemplate.java:269)
	at org.apache.ibatis.binding.MapperMethod.execute(MapperMethod.java:55)
	at org.apache.ibatis.binding.MapperProxy.invoke(MapperProxy.java:53)
	at com.sun.proxy.$Proxy28.updateDialogByFrom2(Unknown Source)
	at com.benmu.mts.wx.center.dao.CustomDialogDaoTest.updateDialogByFrom2(CustomDialogDaoTest.java:54)
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.lang.reflect.Method.invoke(Method.java:498)
	at org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:45)
	at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:15)
	at org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:42)
	at org.junit.internal.runners.statements.InvokeMethod.evaluate(InvokeMethod.java:20)

dao层代码：

@Repository
public interface CustomDialogDao {
    
    void updateDialogByFrom2(@Param("param") CustomDialog param, @Param("fromUser") String fromUser, @Param("appid") String appid);
}

mapper.xml代码：

<?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.benmu.mts.wx.center.service.dao.CustomDialogDao">
<update id="updateDialogByFrom2" parameterType="com.benmu.mts.wx.center.custom.bean.CustomDialog">
        update custom_dialog
        <set>
            <if test="status != null">
                status = #{status}
            </if>
        </set>
        where 1=1 and appid = #{appid} and fromUser = #{fromUser}
    </update>
</mapper>

解决办法：

<update id="updateDialogByFrom2" >
        update custom_dialog
        <set>
            <if test="param.status != null">
                status = #{param.status}
            </if>
        </set>
        where 1=1 and appid = #{appid} and from_user = #{fromUser}
    </update>

总结：

Dao层已经把CustomDialog定义成了param，如果要使用status，就要调用param这个对象的属性，否则status是找不到的

來源：https://www.jianshu.com/p/800fe918cc7a