MyBatis实现与原理剖析

1. 入门案例步骤总结

• 使用Maven工程导入相应的包（Mybatis、mysql、log4j（通过一个配置文件来灵活地进行配置）、junit（测试类））
• 写相应的dao类和domain类
• 编写Mybatis的配置文件（例如SqlMapConfig.xml）和相关dao类的配置文件（例如UserDao.xml）
• 编写测试文件
  • 读取配置文件
  • 创建SqlSessionFactory工厂
  • 生成SqlSession对象
  • 通过生成的对象创建dao接口的代理对象
  • 使用代理对象执行方法
  • 释放资源

2. 执行代码分析

public static void main(String[] args) throws Exception{
        //1.读取配置文件
        InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
        //2.创建SqlSessionFactory工厂
        SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new 	  SqlSessionFactoryBuilder();
        SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(in);
        //3.使用工厂生成SqlSession对象
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //4.使用SqlSession创建Dao接口的代理对象
        UserDao userDao = sqlSession.getMapper(UserDao.class);
        //5.使用代理对象执行方法
        List<User> list = userDao.findAll();
        for(User user : list){
            System.out.println(user);
        }
        //6.释放资源
        sqlSession.close();
        in.close();
    }

整个的执行流程可以描述如下：

​ 首先通过SqlMapConfig.xml文件读取连接数据库的配置信息。再通过构建工厂生成对象，在这一步中，用到了创建者模式和工厂模式。在创建工厂时用到了创建者模式，即把创建对象的任务交给SqlSessionFactory去完成，这样能将创建对象的细节进行屏蔽，使用者直接调用方法即可获得对象。在接下来的生成对象过程中用到了工厂模式，这样能够降低类之间的依赖关系以达到解耦的目的。下一步就是使用创建的SqlSession对象生成dao接口的代理对象，这里又用到了代理模式，能够实现在不改变源码的基础上对已有方法进行增强。后面就是具体的执行过程和资源释放。

3. 配置文件分析

SqlMapConfig.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">
<!-- mybatis的主配置文件 -->
<configuration>
    <!-- 配置mysql环境 -->
    <environments default="mysql">
        <environment id="mysql">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="username" value="root" />
                <property name="password" value="" />
                <property name="url" value="jdbc:mysql://localhost:3306/test" />
                <property name="driver" value="com.mysql.jdbc.Driver" />
            </dataSource>
        </environment>
    </environments>

    <!-- 指定映射配置文件的位置，映射配置文件指的是每个dao独立的配置文件,可以理解为指明dao操作的配置文件 的位置-->
    <mappers>
        <mapper resource="com/cb/dao/UserDao.xml" />
    </mappers>
</configuration>

UserDao.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.cb.dao.UserDao">
    <!--配置查询所有-->
    <select id="findAll" resultType="com.cb.domain.User">
        select * from user
    </select>
</mapper>

JDBC文件的执行过程

 public <T> List<T> getForList(Class<T> clazz, String sql, Object...args) {
        Connection connection = null;
        PreparedStatement preparedStatement = null;
        ResultSet resultSet = null;
        try {
            connection = Utils.getConnection();
            preparedStatement = connection.prepareStatement(sql);

            for(int i = 0; i < args.length; i++){
                preparedStatement.setObject(i + 1, args[i]);
            }

            resultSet = preparedStatement.executeQuery();

            ResultSetMetaData metaData = resultSet.getMetaData();
            int columnCount = metaData.getColumnCount();

            ArrayList<T> list = new ArrayList<>();
            while(resultSet.next()){
                T t = clazz.newInstance();
                for(int i = 0; i < columnCount; i++){
                    Object object = resultSet.getObject(i + 1);
                    String columnLabel = metaData.getColumnLabel(i + 1);

                    Field declaredField = clazz.getDeclaredField(columnLabel);
                    declaredField.setAccessible(true);
                    declaredField.set(t, object);
                }

                list.add(t);
            }

            return list;
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            Utils.closeResource(connection, preparedStatement, resultSet);
        }

        return null;
    }

首先对jdbc的执行过程进行分析，大致可以分为5步。

• 根据配置文件信息创建Connection对象注册驱动，获取连接。
• 获取预处理对象PreParedStatement预编译sql语句
• 执行sql语句得到resultSet
• 处理resultSet
• 释放资源

对比Mybatis的配置文件我们可以发现，针对jdbc执行过程的第一步，我们可以根据以下配置信息实现第一步，其中解析xml文件用到的技术是domj4。

<dataSource type="POOLED">
	<property name="username" value="root" />
    <property name="password" value="" />
    <property name="url" value="jdbc:mysql://localhost:3306/test" />
    <property name="driver" value="com.mysql.jdbc.Driver" />
</dataSource>

而对于第二步第三步，我们可以通过UserDao.xml文件的相关信息实现，下面语句能够得到sql语句，即能获得Preparement并执行，同时还能够得到封装实体类的全限定类名用于第四步的反射封装获取值。

<mapper namespace="com.cb.dao.UserDao">
	<select id="findAll" resultType="com.cb.domain.User">
        select * from user
	</select>
</mapper>

总而言之，只要配置信息能够提供连接信息和映射信息，就能够让jdbc这个过程正常执行。

4. 手撕Mybatis源码

经过上面的分析，我们可以尝试一下自定义Mybatis。通过Mybatis的调用过程，我们可以发现这么几个类：

• class Resource
• class SqlSessionFactoryBuilder
• interface SqlSessionFactory
• interface SqlSession

在自定义相关类和接口的时候，首先定义相关目录mybatis。首先是Resource的创建，创建目录为mybatis.io，具体的实现与功能如下：

/**
 *@Author: Ben
 *@Description: 使用类加载器读取配置文件的类
 *@Date: 19:46 2020/7/15
 */
public class Resources {
    /**
     *@Author: Ben
     *@Description: 根据传入的参数来获取一个字节输入流
     *@Date: 19:47 2020/7/15
     */
    public static InputStream getResourceAsStream(String filePath){
        //通过当前字节码的类加载器读取配置信息
        return Resources.class.getClassLoader().getResourceAsStream(filePath);
    }
}

接下来是SqlSessionFactoryBuilder的创建，创建目录为mybatis.Sqlsession，由于这个类是创建Factory类，而创建出的SqlSessionFactory又会进一步创建SqlSession对象。因此可以定义三个文件。

首先编写SqlSessionFactoryBuilder文件，它的功能是根据配置文件最终创建SqlSession对象，因此在这里要用到xml的解析功能，由于我们的关注点是对Mybatis的分析，对于xml文件解析就可以调用相应的工具包实现，在这里就可以调用XMLConfigBuilder实现，解析时需要用到dom4j+xpath技术，因此要在Maven中进行相应的导入。如下：

 <dependency>
	<groupId>dom4j</groupId>
	<artifactId>dom4j</artifactId>
	<version>1.6.1</version>
 </dependency>

 <dependency>
	<groupId>jaxen</groupId>
    <artifactId>jaxen</artifactId>
    <version>1.1.6</version>
 </dependency>

XMLConfigBuilder文件如下，大致解释一下就是首先解压主配置文件，就是SqlMapConfig.xml文件，根据标签获取相应的值，然后文件提供两种方式，一种是XML方式，另一种是注解方式，根据配置文件的设定选用不同的方式读取配置信息并组成映射信息（执行的SQL语句和要封装的实体类全限定类名）。

/**
 *@Author: Ben
 *@Description: 用于解析XML文件
 *@Date: 21:31 2020/7/15
 */

public class XMLConfigBuilder {



   /**
    *@Author: Ben
    *@Description: 解析主配置文件，把里面的内容填充到DefaultSqlSession所需要的地方
    *@Date: 21:31 2020/7/15
    */
    public static Configuration loadConfiguration(InputStream config){
        try{
            //定义封装连接信息的配置对象（mybatis的配置对象）
            Configuration cfg = new Configuration();

            //1.获取SAXReader对象
            SAXReader reader = new SAXReader();
            //2.根据字节输入流获取Document对象
            Document document = reader.read(config);
            //3.获取根节点
            Element root = document.getRootElement();
            //4.使用xpath中选择指定节点的方式，获取所有property节点
            List<Element> propertyElements = root.selectNodes("//property");
            //5.遍历节点
            for(Element propertyElement : propertyElements){
                //判断节点是连接数据库的哪部分信息
                //取出name属性的值
                String name = propertyElement.attributeValue("name");
                if("driver".equals(name)){
                    //表示驱动
                    //获取property标签value属性的值
                    String driver = propertyElement.attributeValue("value");
                    cfg.setDriver(driver);
                }
                if("url".equals(name)){
                    //表示连接字符串
                    //获取property标签value属性的值
                    String url = propertyElement.attributeValue("value");
                    cfg.setUrl(url);
                }
                if("username".equals(name)){
                    //表示用户名
                    //获取property标签value属性的值
                    String username = propertyElement.attributeValue("value");
                    cfg.setUsername(username);
                }
                if("password".equals(name)){
                    //表示密码
                    //获取property标签value属性的值
                    String password = propertyElement.attributeValue("value");
                    cfg.setPassword(password);
                }
            }
            //取出mappers中的所有mapper标签，判断他们使用了resource还是class属性
            List<Element> mapperElements = root.selectNodes("//mappers/mapper");
            //遍历集合
            for(Element mapperElement : mapperElements){
                //判断mapperElement使用的是哪个属性
                Attribute attribute = mapperElement.attribute("resource");
                if(attribute != null){
                    System.out.println("使用的是XML");
                    //表示有resource属性，用的是XML
                    //取出属性的值
                    String mapperPath = attribute.getValue();//获取属性的值"com/cb/dao/IUserDao.xml"
                    //把映射配置文件的内容获取出来，封装成一个map
                    Map<String, Mapper> mappers = loadMapperConfiguration(mapperPath);
                    //给configuration中的mappers赋值
                    cfg.setMappers(mappers);
                }else{
                    System.out.println("使用的是注解");
                    //表示没有resource属性，用的是注解
                    //获取class属性的值
                    String daoClassPath = mapperElement.attributeValue("class");
                    //根据daoClassPath获取封装的必要信息
                    Map<String,Mapper> mappers = loadMapperAnnotation(daoClassPath);
                    //给configuration中的mappers赋值
                    cfg.setMappers(mappers);
                }
            }
            //返回Configuration
            return cfg;
        }catch(Exception e){
            throw new RuntimeException(e);
        }finally{
            try {
                config.close();
            }catch(Exception e){
                e.printStackTrace();
            }
        }

    }

   /**
    *@Author: Ben
    *@Description: 根据传入的参数，解析XML并且封装到Map中，  map中包含了获取的唯一标识（key是由dao的全限定类名和方法名组成）
    *              以及执行所需的必要信息（value是一个Mapper对象，里面存放的是执行的SQL语句和要封装的实体类全限定类名）
    *@Date: 21:32 2020/7/15
    */
    private static Map<String,Mapper> loadMapperConfiguration(String mapperPath)throws IOException {
        InputStream in = null;
        try{
            //定义返回值对象
            Map<String,Mapper> mappers = new HashMap<String,Mapper>();
            //1.根据路径获取字节输入流
            in = Resources.getResourceAsStream(mapperPath);
            //2.根据字节输入流获取Document对象
            SAXReader reader = new SAXReader();
            Document document = reader.read(in);
            //3.获取根节点
            Element root = document.getRootElement();
            //4.获取根节点的namespace属性取值
            String namespace = root.attributeValue("namespace");//是组成map中key的部分
            //5.获取所有的select节点
            List<Element> selectElements = root.selectNodes("//select");
            //6.遍历select节点集合
            for(Element selectElement : selectElements){
                //取出id属性的值      组成map中key的部分
                String id = selectElement.attributeValue("id");
                //取出resultType属性的值  组成map中value的部分
                String resultType = selectElement.attributeValue("resultType");
                //取出文本内容            组成map中value的部分
                String queryString = selectElement.getText();
                //创建Key
                String key = namespace+"."+id;
                //创建Value
                Mapper mapper = new Mapper();
                mapper.setQueryString(queryString);
                mapper.setResultType(resultType);
                //把key和value存入mappers中
                mappers.put(key,mapper);
            }
            return mappers;
        }catch(Exception e){
            throw new RuntimeException(e);
        }finally{
            in.close();
        }
    }

    /**
     *@Author: Ben
     *@Description: 根据传入的参数，得到dao中所有被select注解标注的方法。
     *              根据方法名称和类名，以及方法上注解value属性的值，组成Mapper的必要信息
     *@Date: 21:32 2020/7/15
     */
    private static Map<String,Mapper> loadMapperAnnotation(String daoClassPath)throws Exception{
        //定义返回值对象
        Map<String,Mapper> mappers = new HashMap<String, Mapper>();

        //1.得到dao接口的字节码对象
        Class daoClass = Class.forName(daoClassPath);
        //2.得到dao接口中的方法数组
        Method[] methods = daoClass.getMethods();
        //3.遍历Method数组
        for(Method method : methods){
            //取出每一个方法，判断是否有select注解
            boolean isAnnotated = method.isAnnotationPresent(Select.class);
            if(isAnnotated){
                //创建Mapper对象
                Mapper mapper = new Mapper();
                //取出注解的value属性值
                Select selectAnno = method.getAnnotation(Select.class);
                String queryString = selectAnno.value();
                mapper.setQueryString(queryString);
                //获取当前方法的返回值，还要求必须带有泛型信息
                Type type = method.getGenericReturnType();//List<User>
                //判断type是不是参数化的类型
                if(type instanceof ParameterizedType){
                    //强转
                    ParameterizedType ptype = (ParameterizedType)type;
                    //得到参数化类型中的实际类型参数
                    Type[] types = ptype.getActualTypeArguments();
                    //取出第一个
                    Class domainClass = (Class)types[0];
                    //获取domainClass的类名
                    String resultType = domainClass.getName();
                    //给Mapper赋值
                    mapper.setResultType(resultType);
                }
                //组装key的信息
                //获取方法的名称
                String methodName = method.getName();
                String className = method.getDeclaringClass().getName();
                String key = className+"."+methodName;
                //给map赋值
                mappers.put(key,mapper);
            }
        }
        return mappers;
    }

通过分析XML解析工具类，我们可以发现里面定义了一个Configuration类用于存储基本信息以及Mapper类用于存储映射信息，因此我们也要同样定义。其中Configuration中还包括了Mapper类的实现。

Configuration类：

/**
 *@Author: Ben
 *@Description: 自定义mybatis配置类
 *@Date: 20:21 2020/7/15
 */
public class Configuration {
    private String driver;
    private String url;
    private String username;
    private String password;

    public String getDriver() {
        return driver;
    }

    private Map<String,Mapper> mappers = new HashMap<String,Mapper>();

    public Map<String, Mapper> getMappers() {
        return mappers;
    }

    public void setMappers(Map<String, Mapper> mappers) {
        this.mappers.putAll(mappers);//此处需要使用追加的方式
    }
    public void setDriver(String driver) {
        this.driver = driver;
    }

    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }

    public String getUsername() {
        return username;
    }

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

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

Mapper类：

/**
 *@Author: Ben
 *@Description: 用于封装执行的sql语句和结果类型的全限定类名
 *@Date: 20:23 2020/7/15
 */
public class Mapper {
    private String queryString;
    private String resultType;

    public String getQueryString() {
        return queryString;
    }

    public void setQueryString(String queryString) {
        this.queryString = queryString;
    }

    public String getResultType() {
        return resultType;
    }

    public void setResultType(String resultType) {
        this.resultType = resultType;
    }
}

通过解析文件工具类我们就可以完成SqlSessionFactoryBuilder类的创立，由于需要返回值，我们又创建了一个实体类继承于SqlSessionFactory：

/**
 *@Author: Ben
 *@Description: 用于创建一个工厂对象
 *@Date: 19:54 2020/7/15
 */
public class SqlSessionFactoryBuilder {
    /**
     *@Author: Ben
     *@Description: 根据参数的字节输入流来构建一个SqlSessionFactory工厂
     *@Date: 19:54 2020/7/15
     */
    public SqlSessionFactory build(InputStream config){
        Configuration cfg = XMLConfigBuilder.loadConfiguration(config);
        return new DefaultSqlSessionFactory(cfg);
    }
}

SqlSessionFactory接口如下，里面定义了openSession()方法用于SqlSession对象生成：

public interface SqlSessionFactory {
    /**
     * 用于打开一个新的SqlSession对象
     * @return
     */
    SqlSession openSession();
}

SqlSession接口也是用同样的方法创建，里面定义了需要使用的getMapper()方法和close()方法。

public interface SqlSession {
    /**
     *@Author: Ben
     *@Description: 根据参数创建一个代理对象, daoInterfaceClass表示dao的接口字节码
     *@Date: 19:58 2020/7/15
     */
    <T> T getMapper(Class<T> daoInterfaceClass);

    /**
     *@Author: Ben
     *@Description: 释放资源
     *@Date: 19:58 2020/7/15
     */
    void close();
}

接下来就是SqlSession和SqlSessionFactory的具体实现类DefaultSqlSession和DefaultSqlSessionFactory

DefaultSqlSessionFactory类的实现如下：

/**
 *@Author: Ben
 *@Description: 接口的实现类
 *@Date: 21:09 2020/7/15
 */
public class DefaultSqlSessionFactory implements SqlSessionFactory {

    private Configuration cfg;

    public DefaultSqlSessionFactory(Configuration cfg){
        this.cfg = cfg;
    }

    /**
     *@Author: Ben
     *@Description: 用于创建一个新的操作对象
     *@Date: 21:10 2020/7/15
     */
    @Override
    public SqlSession openSession() {
        return new DefaultSqlSession(cfg);
    }
}

DefaultSqlSession类的实现如下，在这里由于要传入一个Connection，因此又编写了一个DBUtils工具类获取Connection：

public class DefaultSqlSession implements SqlSession {

    private Configuration cfg;
    private Connection connection;

    public DefaultSqlSession(Configuration cfg){
        this.cfg = cfg;
        connection = DataSourceUtil.getConnection(cfg);
    }

    /**
     *@Author: Ben
     *@Description: 用于创建代理对象
     *@Date: 21:11 2020/7/15
     */
    @Override
    public <T> T getMapper(Class<T> daoInterfaceClass) {
        return (T) Proxy.newProxyInstance(daoInterfaceClass.getClassLoader(),
                new Class[]{daoInterfaceClass},new 	 MapperProxy(cfg.getMappers(),connection));
    }

    /**
     *@Author: Ben
     *@Description: 释放资源
     *@Date: 21:11 2020/7/15
     */
    @Override
    public void close() {
        if(connection != null) {
            try {
                connection.close();
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }
}

DataSourceUtil类，通过配置文件的Drive获取Connection连接。

/**
 *@Author: Ben
 *@Description: 用于创建数据源的工具类
 *@Date: 21:13 2020/7/15
 */
public class DataSourceUtil {

    /**
     * 用于获取一个连接
     * @param cfg
     * @return
     */
    public static Connection getConnection(Configuration cfg){
        try {
            Class.forName(cfg.getDriver());
            return DriverManager.getConnection(cfg.getUrl(), cfg.getUsername(), cfg.getPassword());
        }catch(Exception e){
            throw new RuntimeException(e);
        }
    }
}

最后就是DefaultSqlSession类中方法的完善，上面见到的是已经完善好了的，由于用到了反射，还需要定义一个Proxy，具体的实现如下，主要就是在已有的Mapper中找有没有方法与输入的相匹配，不匹配则报错，匹配就调用Executor类进行执行：

public class MapperProxy implements InvocationHandler {

    //需要两个信息 1.映射信息，即全限定类名 2.连接信息
    private Map<String, Mapper> mappers;
    private Connection conn;

    public MapperProxy(Map<String,Mapper> mappers,Connection conn){
        this.mappers = mappers;
        this.conn = conn;
    }

    /**
     *@Author: Ben
     *@Description: 用于对方法进行增强的，我们的增强其实就是调用selectList方法
     *@Date: 21:18 2020/7/15
     */
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        //1.获取方法名
        String methodName = method.getName();
        //2.获取方法所在类的名称
        String className = method.getDeclaringClass().getName();
        //3.组合key
        String key = className+"."+methodName;
        //4.获取mappers中的Mapper对象
        Mapper mapper = mappers.get(key);
        //5.判断是否有mapper
        if(mapper == null){
            throw new IllegalArgumentException("传入的参数有误");
        }
        //6.调用工具类执行查询所有
        return new Executor().selectList(mapper,conn);
    }
}

Executor类也是工具类，里面封装的是selectList方法，作用是负责执行SQL语句，并且封装结果集。实现如下：

/**
 *@Author: Ben
 *@Description: 负责执行SQL语句，并且封装结果集
 *@Date: 21:25 2020/7/15
 */
public class Executor {

    public <E> List<E> selectList(Mapper mapper, Connection conn) {
        PreparedStatement pstm = null;
        ResultSet rs = null;
        try {
            //1.取出mapper中的数据
            String queryString = mapper.getQueryString();//select * from user
            String resultType = mapper.getResultType();//com.itheima.domain.User
            Class domainClass = Class.forName(resultType);
            //2.获取PreparedStatement对象
            pstm = conn.prepareStatement(queryString);
            //3.执行SQL语句，获取结果集
            rs = pstm.executeQuery();
            //4.封装结果集
            List<E> list = new ArrayList<E>();//定义返回值
            while(rs.next()) {
                //实例化要封装的实体类对象
                E obj = (E)domainClass.newInstance();

                //取出结果集的元信息：ResultSetMetaData
                ResultSetMetaData rsmd = rs.getMetaData();
                //取出总列数
                int columnCount = rsmd.getColumnCount();
                //遍历总列数
                for (int i = 1; i <= columnCount; i++) {
                    //获取每列的名称，列名的序号是从1开始的
                    String columnName = rsmd.getColumnName(i);
                    //根据得到列名，获取每列的值
                    Object columnValue = rs.getObject(columnName);
                    //给obj赋值：使用Java内省机制（借助PropertyDescriptor实现属性的封装）
                    PropertyDescriptor pd = new PropertyDescriptor(columnName,domainClass);//要求：实体类的属性和数据库表的列名保持一种
                    //获取它的写入方法
                    Method writeMethod = pd.getWriteMethod();
                    //把获取的列的值，给对象赋值
                    writeMethod.invoke(obj,columnValue);
                }
                //把赋好值的对象加入到集合中
                list.add(obj);
            }
            return list;
        } catch (Exception e) {
            throw new RuntimeException(e);
        } finally {
            release(pstm,rs);
        }
    }


    private void release(PreparedStatement pstm,ResultSet rs){
        if(rs != null){
            try {
                rs.close();
            }catch(Exception e){
                e.printStackTrace();
            }
        }

        if(pstm != null){
            try {
                pstm.close();
            }catch(Exception e){
                e.printStackTrace();
            }
        }
    }
}

至此，基本的Mybatis相关类我们就手动实现了一次，通过具体的手动实现能够更好的理解原理。也可以与jdbc联系起来理解。