参数映射
现在我们来看一下上面在执行查询之前参数是如何进行设置的,我们先进入prepareStatement方法:
我们发现,最终是调用了StatementHandler中的parameterize进行参数设置,接下来这里为了节省篇幅,我们不会一步步点进去,直接进入设置参数的方法:
上面的BaseTypeHandler是一个抽象类,setNonNullParameter并没有实现,都是交给子类去实现,而每一个子类就是对应了数据库的一种类型。下图中就是默认的一个子类StringTypeHandler,里面没什么其他逻辑,就是设置参数。
可以看到String里面调用了jdbc中的setString方法,而如果是int也会调用setInt方法。
看到这些子类如果大家之前阅读过我前面讲的MyBatis参数配置,应该就很明显可以知道,这些子类就是系统默认提供的一些typeHandler。而这些默认的typeHandler会默认被注册并和Java对象进行绑定:
正是因为MyBatis中默认提供了常用数据类型的映射,所以我们写Sql的时候才可以省略参数映射关系,可以直接采用下面的方式,系统可以根据我们参数的类型,自动选择合适的typeHander进行映射:
select user_id,user_name from lw_user where user_name=#{userName}
上面这条语句实际上和下面这条是等价的:
select user_id,user_name from lw_user where user_name=#{userName,jdbcType=VARCHAR}
或者说我们可以直接指定typeHandler:
select user_id,user_name from lw_user where user_name=#{userName,jdbcType=VARCHAR,typeHandler=org.apache.ibatis.type.IntegerTypeHandler}
这里因为我们配置了typeHandler,所以会优先以配置的typeHandler为主不会再去读取默认的映射,如果类型不匹配就会直接报错了:
看到这里很多人应该就知道了,如果我们自己自定义一个typeHandler,然后就可以配置成我们自己的自定义类。
所以接下来就让我们看看如何自定义一个typeHandler
自定义typeHandler
自定义typeHandler需要实现BaseTypeHandler接口,BaseTypeHandler有4个方法,包括结果集映射,为了节省篇幅,代码没有写上来:
package com.lonelyWolf.mybatis.typeHandler; import org.apache.ibatis.type.BaseTypeHandler; import org.apache.ibatis.type.JdbcType; import java.sql.CallableStatement; import java.sql.PreparedStatement; import java.sql.ResultSet; import java.sql.SQLException; public class MyTypeHandler extends BaseTypeHandler<String> { @Override public void setNonNullParameter(PreparedStatement preparedStatement, int index, String param, JdbcType jdbcType) throws SQLException { System.out.println("自定义typeHandler生效了"); preparedStatement.setString(index,param); }
然后我们改写一下上面的查询语句:
select user_id,user_name from lw_user where user_name=#{userName,jdbcType=VARCHAR,typeHandler=com.lonelyWolf.mybatis.typeHandler.MyTypeHandler}
然后执行,可以看到,自定义的typeHandler生效了:
结果集映射
接下来让我们看看结果集的映射,回到上面执行sql流程的最后一个方法:
resultSetHandler.handleResultSets(ps)
结果集映射里面的逻辑相对来说还是挺复杂的,因为要考虑到非常多的情况,这里我们就不会去深究每一个细节,直接进入到正式解析结果集的代码,下面的5个代码片段就是一个简单的但是完整的解析流程:
从上面的代码片段我们也可以看到,实际上解析结果集还是很复杂的,就如我们上一篇介绍的复杂查询一样,一个查询可以不断嵌套其他查询,还有延迟加载等等一些复杂的特性
的处理,所以逻辑分支是有很多,但是不管怎么处理,最后的核心还是上面的一套流程,最终还是会调用typeHandler来获取查询到的结果。
是的,你没猜错,这个就是上面我们映射参数的typeHandler,因为typeHandler里面不只是一个设置参数方法,还有获取结果集方法(上面设置参数的时候省略了)。
自定义typeHandler结果集
所以说我们还是用上面那个MyTypeHandler 例子来重写一下取值方法(省略了设置参数方法):
package com.lonelyWolf.mybatis.typeHandler; import org.apache.ibatis.type.BaseTypeHandler; import org.apache.ibatis.type.JdbcType; import java.sql.CallableStatement; import java.sql.PreparedStatement; import java.sql.ResultSet; import java.sql.SQLException; public class MyTypeHandler extends BaseTypeHandler<String> { /** * 设置参数 */ @Override public void setNonNullParameter(PreparedStatement preparedStatement, int index, String param, JdbcType jdbcType) throws SQLException { System.out.println("设置参数->自定义typeHandler生效了"); preparedStatement.setString(index,param); } /** * 根据列名获取结果 */ @Override public String getNullableResult(ResultSet resultSet, String columnName) throws SQLException { System.out.println("根据columnName获取结果->自定义typeHandler生效了"); return resultSet.getString(columnName); } /** * 根据列的下标来获取结果 */ @Override public String getNullableResult(ResultSet resultSet, int columnIndex) throws SQLException { System.out.println("根据columnIndex获取结果->自定义typeHandler生效了"); return resultSet.getString(columnIndex); } /** * 处理存储过程的结果集 */ @Override public String getNullableResult(CallableStatement callableStatement, int columnIndex) throws SQLException { return callableStatement.getString(columnIndex); } }
改写Mapper映射文件配置:
<resultMap id="MyUserResultMap" type="lwUser"> <result column="user_id" property="userId" jdbcType="VARCHAR" typeHandler="com.lonelyWolf.mybatis.typeHandler.MyTypeHandler" /> <result column="user_name" property="userName" jdbcType="VARCHAR" /> </resultMap> <select id="listUserByUserName" parameterType="String" resultMap="MyUserResultMap"> select user_id,user_name from lw_user where user_name=#{userName,jdbcType=VARCHAR,typeHandler=com.lonelyWolf.mybatis.typeHandler.MyTypeHandler} </select>
执行之后输出如下:
因为我们属性上面只配置了一个属性,所以只输出了一次。
工作流程图
上面介绍了代码的流转,可能绕来绕去有点晕,所以我们来画一个主要的对象之间流程图来更加清晰的展示一下MyBatis主要工作流程:
从上面的工作流程图上我们可以看到,SqlSession下面还有4大对象,这4大对象也很重要,后面学习拦截器的时候就是针对这4大对象进行的拦截,关于这4大对象的具体详情,我们下一篇文章再展开分析。
总结
本文主要分析了MyBatis的SQL执行流程。在分析流程的过程中,我们也举例论证了如何自定义typeHandler来实现自定义的参数映射和结果集映射,不过MyBatis中提供的默认映射其实可以满足大部分的需求,如果我们对某些属性需要特殊处理,那么就可以采用自定义的typeHandle来实现,相信如果本文如果读懂了,以下几点大家应该至少会有一个清晰的认识:
1、Mapper接口和映射文件是如何进行绑定的
2、MyBatis中SQL语句的执行流程
3、自定义MyBatis中的参数设置处理器typeHandler
4、自定义MyBatis中结果集处理器typeHandler
当然,其中很多细节并没有提到,而看源码我们也并不需要追求每一行代码都能看懂,就比如我们一个稍微复杂一点的业务系统,即使我们是项目开发者如果某一个模块不是本人负责的,恐怕也很难搞清楚每一行代码的含义。所以对于MyBatis及其他框架的源码中也是一样,首先应该从大局入手,掌握整体流程和设计思想,然后如果对某些实现细节感兴趣,再深入进行了解。