導讀：閱讀源碼是提升自己代碼能力的一個非常重要的手段，但是源碼閱讀有時候也非常麻煩，一定要找到入口點，然后動態地去看代碼，一步步調試然后畫圖做筆記記錄，才能在一團亂中清理出一個道路來。這篇文章介紹了我在閱讀Mybatis源碼的準備過程。
Mybatis簡介
mybatis是一個流行的半自動映射框架，之所以稱為半自動框架是因為它需要手工匹配Java類，SQL和映射關系，而全表映射的Hibernate只需要提供POJO和映射關系就可以了。區別如下表：
| MyBatis | Hibernate |
|---|---|
| java類 | java類 |
| 映射規則 | 映射規則 |
| SQL | 無 |
通過上表也可以看出，Hibenate無需編寫SQL，所以開發效率優于Mybatis.此外，它提供緩存、日志、級聯等功能。但是缺點也是十分明顯，多表關聯復雜的SQL，根據條件變化的SQL。存儲過程等場景使用Hibenate非常不便，而性能又難以通過SQL優化。所以注定Hibernate只適用于場景不太復雜，要求性能不太苛刻的時候使用。如果你需要一個靈活的、可以動態生成映射關系的框架，那么MyBatis是一個最好的選擇。
MyBatis組件以及執行基本流程
- SqlSessionFactoryBuilder（構造器）:它會根據配置信息或者代碼生成SqlSessionFactory（工廠接口）
- SqlSessionFactory：依靠工廠來生成SqlSession。
- SqlSession：是一個既可以發送SQL去執行并返回結果的，也可以獲取Mapper接口，通過Mapper接口查詢并封裝數據。
- SQL Mapper:它是MyBatis新設計的組件，它是由一個Java接口和XML文件（或者注解)構成的，需要給出對應的SQL和映射規則。它負責發送SQL去執行，并返回結果。
用下圖表達上述組件之間的關聯
Mybatis 的構成
mybatis源碼閱讀準備
- github上有一個中文注釋版的MyBatis源碼。MyBatis中文鏈接
- Mybatis是以maven管理的，依賴于Mybatis-parent模塊。將mybatis導入到eclipse中時候，也需要將mybatis-parent模塊導入。mybatis-parent模塊鏈接
- 將模塊mybatis，mybatis-parent模塊導入到Eclipse中，接下來就通過mybatis的最基本的代碼來調試并閱讀mybatis源碼。整個結構如下圖。
image
通過《深入淺出MyBatis技術原理與實戰》一書的代碼來實現基本調試。代碼的目錄請看上圖，代碼的內容下面一一列出。
- 數據庫表role
-- ----------------------------
-- Table structure for role
-- ----------------------------
DROP TABLE IF EXISTS `role`;
CREATE TABLE `role` (
`id` int(11) DEFAULT NULL,
`role_name` varchar(255) DEFAULT NULL,
`note` varchar(255) DEFAULT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
-- ----------------------------
-- Records of role
-- ----------------------------
INSERT INTO `role` VALUES ('1', '張三', '張三的備注');
- 數據庫表role對應的java類
/*
* @author gethin
* 角色的實體類
*/
public class Role {
private long id;
private String roleName;
private String note;
...
getter setter省略
}
- java RoleMapper接口
/*
* @author gethin
*/
public interface RoleMapper {
public Role getRole(Long id);
public Role findRole(String roleName);
public int deleteRole(Long id);
public int insertRole(Role role);
}
- RoleMapper
<?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.gethin.mapper.RoleMapper">
<resultMap type="role" id="roleMap">
<id column="id" property="id" javaType="long" jdbcType="BIGINT" />
<result column="role_name" property="roleName" javaType="string"
jdbcType="VARCHAR" />
<result column="note" property="note"
typeHandler="com.gethin.handler.MyStringHandler" />
</resultMap>
<select id="getRole" parameterType="long" resultMap="roleMap">
select
id,role_name as roleName,note from role where id=#{id}
</select>
<select id="findRole" parameterType="long" resultMap="roleMap">
select
id,role_name,note from role where role_name like CONCAT('%',#{roleName
javaType=string,
jdbcType=VARCHAR,typeHandler=com.gethin.handler.MyStringHandler},'%')
</select>
<insert id="insertRole" parameterType="role">
insert into
role(role_name,note) value(#{roleName},#{note})
</insert>
<delete id="deleteRole" parameterType="long">
delete from role where
id=#{id}
</delete>
</mapper>
- MyStringHandler
@MappedTypes({String.class})
@MappedJdbcTypes(JdbcType.VARCHAR)
public class MyStringHandler implements TypeHandler<String> {
private Logger log=Logger.getLogger(MyStringHandler.class);
@Override
public String getResult(ResultSet rs, String colName) throws SQLException {
log.info("使用我的TypeHandler,ResultSet列名獲取字符串");
return rs.getString(colName);
}
@Override
public String getResult(ResultSet rs, int index) throws SQLException {
log.info("使用我的TypeHandler,ResultSet下標獲取字符串");
return rs.getString(index);
}
@Override
public String getResult(CallableStatement cs, int index) throws SQLException {
log.info("使用我的TypeHandler,CallableStatement下標獲取字符串");
return cs.getString(index);
}
@Override
public void setParameter(PreparedStatement ps, int index, String value, JdbcType arg3) throws SQLException {
log.info("使用我的TypeHandler");
ps.setString(index, value);
}
}
- log4j.properties 配置文件
log4j.rootLogger=DEBUG,stdout
log4j.logger.org.mybatis=DUBUG
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.logDailyFile.layout.ConversionPattern = %5p %d %C:%m%n
- mybatis-config.xml 配置文件
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<settings>
<setting name="lazyLoadingEnabled" value="true"/>
<!-- <setting name="aggressiveLazyLoading" value="false"/> -->
</settings>
<typeAliases>
<typeAlias alias="role" type="com.gethin.po.Role"/>
</typeAliases>
<typeHandlers>
<typeHandler jdbcType="VARCHAR" javaType="string" handler="com.gethin.handler.MyStringHandler"/>
</typeHandlers>
<!-- 定義數據庫的信息，默認使用development數據庫構建環境 -->
<environments default="development">
<environment id="development">
<transactionManager type="JDBC" />
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver" />
<property name="url" value="jdbc:mysql://localhost:3306/mybatis" />
<property name="username" value="dbuser" />
<property name="password" value="123456" />
</dataSource>
</environment>
</environments>
<!-- 定義映射器 -->
<mappers>
<package name="com.gethin.mapper"/>
</mappers>
</configuration>
- 閱讀以及debug入口 （Main）
public class Main {
public static void main(String[] args) {
String resource="mybatis-config.xml";
InputStream inputStream=null;
try {
inputStream = Resources.getResourceAsStream(resource);
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
SqlSessionFactory sqlSessionFactory=null;
sqlSessionFactory=new SqlSessionFactoryBuilder().build(inputStream);
SqlSession sqlSession=null;
try {
sqlSession=sqlSessionFactory.openSession();
RoleMapper roleMapper=sqlSession.getMapper(RoleMapper.class);
Role role=roleMapper.getRole(1L);
System.out.println(role.getId()+":"+role.getRoleName()+":"+role.getNote());
sqlSession.commit();
} catch (Exception e) {
// TODO Auto-generated catch block
sqlSession.rollback();
e.printStackTrace();
}finally {
sqlSession.close();
}
}
}
通過執行Main類，并設立斷點，就可以一步一步進行源碼的調試以及閱讀了。
