mybatis源码解析第三课-mybatis源码调试入门

在网上找了很多mybatis源码调试的博客，感觉写的都不是很完善，后面决定还是静下心来仔细阅读mybatis的API，看完了入门那一个章节之后，基本上就对mybatis的源码调试有了清楚的了解，下面做详细的说明；

第一步：创建mybatis相关的配置文件。
第二步：创建实体类和接口；
第三步：编写测试demo；

工程的总体结构图如下：

第一步：创建mybatis相关的配置文件
包括核心配置文件mybatis-config.xml、映射文件BlogMapper.xml、数据库配置文件db.properties，配置文件内容如下：
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>
    <properties resource="db.properties"></properties>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="${driver}"/>
                <property name="url" value="${url}"/>
                <property name="username" value="${username}"/>
                <property name="password" value="${password}"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="mappings/BlogMapper.xml"/>
    </mappers>
</configuration>

BlogMapper.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的全路径 -->
<mapper namespace="com.test.dao.DiseaseItemMapper">
    <select id="getDiseaseItemXml" resultType="com.test.pojo.Tz_disease_item">
        select * from Tz_disease_item where code = #{code}
    </select>
</mapper>

db.properties

driver=oracle.jdbc.OracleDriver
url=jdbc:oracle:thin:@//127.0.0.1:1521/orcl
username=xxx
password=xxx

第二步：创建实体类和接口；
实体类主要是用于数据查询之后返回的数据结构，接口是用于mybatis做数据操作面向接口编程；
Tz_disease_item.java

package com.test.pojo;
/**
 * @Desc
 * @Date 2018/10/17 9:26
 * @Author liuc
 */
public class Tz_disease_item {

    private String code;
    private String name;
    private String cus;

    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        this.code = code;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getCus() {
        return cus;
    }

    public void setCus(String cus) {
        this.cus = cus;
    }
}

DiseaseItemMapper.java
接口的注册方式有两种
1、在BlogMapper.xml文件设置命名空间为接口的全路径名，如：com.test.dao.DiseaseItemMapper；
2、在mybatis-config.xml加上配置

package com.test.dao;

import com.test.pojo.Tz_disease_item;
import org.apache.ibatis.annotations.Select;

/**
 * @Desc
 * @Date 2018/10/17 10:03
 * @Author liuc
 */
public interface DiseaseItemMapper {

    @Select("select * from Tz_disease_item where code = #{code}")
    Tz_disease_item getDiseaseItem(String code);

}

第三步：编写测试demo；
测试demo的父类，主要是用来初始化SqlSessionFactory，下面编写的测试类直接继承此类就可以操作数据库；
BaseTest.java

package com.test;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Before;
import java.io.InputStream;

/**
 * @Desc
 * @Date 2018/10/17 9:58
 * @Author liuc
 */
public class BaseTest {

    protected SqlSessionFactory sqlSessionFactory;

    @Before
    public void init(){
        try {
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
            System.out.println("sqlSessionFactory初始化-->"+sqlSessionFactory);

        }catch (Exception e){
            e.printStackTrace();
        }
    }
}

demo演示通过两种方式来执行sql语句
1、从代码中调用xml配置的sql
方法：testXml()，需要注意的是，执行xml配置的sql语句需要通过“命名空间.SQL语句的ID”来调用，当然也可以不写命名空间，直接写SQL语句的ID也是可以的，但这样不严谨，也容易出现问题；
2、从代码中调用接口执行sql
方法：testMappper()，需要注意的是，定义的接口类DiseaseItemMapper必须要注册，注册的方式就是将接口的全路径名（com.test.dao.DiseaseItemMapper）配置到对应xml文件中的命名空间；
MyTest.java

package com.test;

import com.test.dao.DiseaseItemMapper;
import com.test.pojo.Tz_disease_item;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;

/**
 * @Desc
 * @Date 2018/10/17 9:10
 * @Author liuc
 */
public class MyTest extends BaseTest {


    @Test
    public void testXml(){
        SqlSession session = sqlSessionFactory.openSession();
        try {
//            Tz_disease_item blog = (Tz_disease_item) session.selectOne("getDiseaseItemXml", "441");
            Tz_disease_item blog = (Tz_disease_item) session.selectOne("com.test.dao.DiseaseItemMapper.getDiseaseItemXml", "441");
            System.out.println(blog.getName());
        } finally {
            session.close();
        }
    }

    @Test
    public void testMappper(){
        SqlSession session = sqlSessionFactory.openSession();
        try {
            DiseaseItemMapper mapper = session.getMapper(DiseaseItemMapper.class);
            Tz_disease_item blog = mapper.getDiseaseItem("441");
            System.out.println(blog.getName());
        } finally {
            session.close();
        }
    }
}

延伸学习：如果对如何通过依赖注入框架来使用 MyBatis 感兴趣可以研究一下 MyBatis-Spring 或 MyBatis-Guice 两个子项目。