橘子学Mybatis01之源码环境搭建

这一系列我们来分析一下Mybatis的源码，分析源码我们先搭建一个源码环境，方便后续加一些注释。

一、源码下载

直接去github上下载Mybatis的源码，版本是3.x的就行。然后下载下来不管是压缩包还是源码文件夹，只需要导入到idea既可以，不会的建议remake。

二、源码导入

导入idea之后就成为这个样子。

三、设计表

设计一个用户表，我们主抓流程，表结构就简单一点。

SET FOREIGN_KEY_CHECKS=0;

-- ----------------------------
-- Table structure for user
-- ----------------------------
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
  `id` int(32) NOT NULL AUTO_INCREMENT COMMENT '主键id',
  `name` varchar(32) NOT NULL COMMENT '名字',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8mb4 COMMENT='用户表';

-- ----------------------------
-- Records of user
-- ----------------------------
INSERT INTO `user` VALUES ('1', '诸葛亮');
INSERT INTO `user` VALUES ('2', '刘备');

四、代码环境

实体类映射

package com.yx.domain;


import java.io.Serializable;

/**
 * @Author levi
 * @Description //TODO
 * @Date 20:56 2022-9-29
 * @Param  * @param null
 * @return
 **/
public class User implements Serializable {
    private int id;
    private String name;

  public User(int id, String username) {
    this.id = id;
    this.name = username;
  }

  public User() {
  }

  public int getId() {
    return id;
  }

  public void setId(int id) {
    this.id = id;
  }

  public String getName() {
    return name;
  }

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

  @Override
  public String toString() {
    return "User{" +
      "id=" + id +
      ", username='" + name + '\'' +
      '}';
  }
}

dao接口

package com.yx.dao;

import com.yx.domain.User;

import java.util.List;

/**
 * @Author levi
 * @Description //TODO
 * @Date 20:48 2022-9-29
 * @Param  * @param null
 * @return
 **/
public interface IUserDao {

    // 查询所有用户
    List<User> findAll();

    // 根据id查询实体
    User findUserById();

}

mybatis配置文件，在resources目录下面sqlMapConfig.xml

<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">

 <configuration>
    <!--加载外部properties文件，位置必须在第一个-->
    <properties resource="jdbc.properties"/>

    <settings>
      <!-- 控制台输出sql语句 -->
      <setting name="logImpl" value="STDOUT_LOGGING" />
    </settings>
  <typeAliases>
    <!--给单独的实体类取别名-->
    <!--<typeAlias type="com.lwq.domain.User" alias="user"/>-->
    <!--批量给实体类取别名：指定包下面所有的类的别名默认为其类名，不区分大小写-->
    <package name="com.yx.domain"/>
  </typeAliases>


      <environments default="development">
        <environment id="development">
            <!--當前事務交給jdbc處理-->
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driver}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
         </environment>
      </environments>

        <mappers>
          <mapper resource="UserMapper.xml"/>
        </mappers>
</configuration>

jdbc配置文件jdbc.properties放在resources下面

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql:///mybatis22
jdbc.username=root
jdbc.password=root

UserMapper.xml配置文件，放在resources下面

<?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.yx.dao.IUserDao">

  <select id="findAll" resultType="com.yx.domain.User">
          SELECT * FROM `user`
  </select>
    <select id="findUserById" resultType="com.yx.domain.User" parameterType="com.yx.domain.User">
        select * from User where id = #{id}
    </select>
</mapper>

以上是全部的配置文件，下面我们写一个测试类。

测试类：位置就放在test测试目录下面

import com.yx.dao.IUserDao;
import com.yx.domain.User;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.jupiter.api.Test;

import java.io.IOException;
import java.io.InputStream;
import java.util.List;

/**
 * @Author levi
 * @Description //TODO 
 * @Date 21:16 2022-9-29
 * @Param  * @param null
 * @return 
 **/
public class MybatisTest {
  
    @Test
    public void test1() throws IOException {
        // 读取配置文件转化为流
        InputStream inputStream = Resources.getResourceAsStream("sqlMapConfig.xml");
        SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(inputStream);
        SqlSession sqlSession = factory.openSession();
        //这⾥不调⽤SqlSession的api,⽽是获得了接⼝对象，调⽤接⼝中的⽅法。使用JDK动态代理产生代理对象
        IUserDao mapper = sqlSession.getMapper(IUserDao.class);
        // 代理对象执行方法的时候，调用的最终是底层的invoke方法
        List<User> list = mapper.findAll();
        list.forEach(user -> {
          System.out.println(user.toString());
        });
    }
}

运行这个测试方法得到结果,可见我们基于源码的测试环境已经搭建完毕，下面可以一步步的追踪源码看看mybatis精巧的设计了。

Created connection 194415222.
Setting autocommit to false on JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@b968a76]
==>  Preparing: SELECT * FROM `user`
==> Parameters: 
<==    Columns: id, name
<==        Row: 1, 诸葛亮
<==        Row: 2, 刘备
<==      Total: 2
User{id=1, username='诸葛亮'}
User{id=2, username='刘备'}