MyBatis 框架的自定义——手撕代码硬刚框架(从配置文件到sqlsession)

Mybatis的底层

　　在自定义前，我们先来掌握一下MyBatis的底层流程。

　　首先我们分析一下这段代码：

 　　这个方法是怎么运作的呢？创建代理对象用Proxy类的newProxyInstance方法即可创建，三个参数分别为：类加载器，代理对象要实现的接口字节码数组，如何代理

　　我们要在哪个参数做文章呢？明显是第三个，如何代理。

 　　究其本质，MyBatis的底层是如何执行的呢，不外乎就是解析xml配置，获取驱动注册连接，生成jdbc的那几个connection什么的类，完成连接执行查询。然后创建dao的代理对象 最后由代理对象执行selectlist方法返回List结果。

MyBatis的自定义

　　既然我们要自定义，我们就要自定义之前案例所有我们能看到的类：

　　class Resources

　　class SqlSessionBuilder

　　interface SqlSessionFactory

　　interface SqlSession

　　在第一个项目的基础上，现在我们把mybatis给删了，删完之后相当于没有mybatis那一套内容了

　　可以看到我们test里面的类都不能用了

 　　首先来创我们的Resources

　　写完之后就可以在test里导包了。

　　然后我们设计getResourceAsStream方法，返回值是InputStream。

package com.itheima.mybatis.io;
import java.io.InputStream;

/**
 * 使用类加载器读取配置文件的 类
 */
public class Resources {
    /**
     * 根据传入的参数，获取一个字节输入流
     * @param filePath
     * @return
     */
    public static InputStream getResourceAsStream(String filePath) {
        return Resources.class.getClassLoader().getResourceAsStream(filePath);
        //三部走：拿到当前类的字节码，获取字节码的类加载器，根据类和关键环节很快就可怜见，加载器读取配置
    }
}

　　现在我们创SqlSessionFactoryBuilder类和SqlSessionFactory接口，前者的功能是创建一个sqlsessionfactory对象。

 　　现在test里面关于这两个东西就不会报错了

 　　顺便我们加入SqlSession接口

　　并加入两个方法

　　至此，test类的代码全部不报错了。

 　　现在将配置文件有关mybatis的部分删去

 

　　现在我们在mybatis目录下创一个utils包，在包下创一个XMLConfigBuilder类，并拷下面的代码

package com.itheima.mybatis.utils;

import com.itheima.mybatis.annotations.Select;
import com.itheima.mybatis.io.Resources;
import com.itheima.mybatis.sqlsession.Configuration;
import com.itheima.mybatis.sqlsession.defaults.DefaultSqlSession;
import com.itheima.mybatis.sqlsession.mappers.Mapper;
import org.dom4j.Attribute;
import org.dom4j.Document;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;

import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Method;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * @author 黑马程序员
 * @Company http://www.ithiema.com
 *  用于解析配置文件
 */
public class XMLConfigBuilder {



    /**
     * 解析主配置文件，把里面的内容填充到DefaultSqlSession所需要的地方
     * 使用的技术：
     *      dom4j+xpath
     */
    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 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 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/itheima/dao/IUserDao.xml"
                    //把映射配置文件的内容获取出来，封装成一个map
                    Map mappers = loadMapperConfiguration(mapperPath);
                    //给configuration中的mappers赋值
                    cfg.setMappers(mappers);
                }else{
                    System.out.println("使用的是注解");
                    //表示没有resource属性，用的是注解
                    //获取class属性的值
                    String daoClassPath = mapperElement.attributeValue("class");
                    //根据daoClassPath获取封装的必要信息
                    Map 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();
            }
        }

    }

    /**
     * 根据传入的参数，解析XML，并且封装到Map中
     * @param mapperPath    映射配置文件的位置
     * @return  map中包含了获取的唯一标识（key是由dao的全限定类名和方法名组成）
     *          以及执行所需的必要信息（value是一个Mapper对象，里面存放的是执行的SQL语句和要封装的实体类全限定类名）
     */
    private static Map loadMapperConfiguration(String mapperPath)throws IOException {
        InputStream in = null;
        try{
            //定义返回值对象
            Map mappers = new HashMap();
            //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 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();
        }
    }

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

        //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
                //判断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;
    }







}

XMLConfigBuilder

　　这里用到的是jom4j+xpath解析xml，于是我们来到全局配置文件把dom4和jaxenj依赖导进去，

 　　然后我们在itheima目录下创一个cfg目录，里面创我们的Configuration类

　　定义我们连接的四个重要信息

　　生成他们的getset方法后，我们在cfg目录下设计一个mapper类。　　 

　　mapper我们分析过，mapper包含两部分，分别为执行的SQL语句和封装结果的实体类全限定类名。

　　我们回到XMLConfigBuilder，可以看到loadMapperConfiguration和loadMapperAnnotation，他们分别是用xml文档配置和注解配置两种方法。本阶段不涉及注解，我们把注解的部分注释掉。

　　现在我们重点看XMLConfigBuilder类，在取出mappers中的所有mapper标签后，会根据mapperPath把映射配置文件的内容获取出来，封装成一个map。

　　之前我们提到过map里key值是namespace+id，value是一个mapper对象，包含sql查询语句和结果类型的全限定类名。

 　　现在我们来写Configuration的setMappers方法。我们在Configuration里加一个mappers成员变量。

 　　然后添加set和get方法，我们发现set方法是用=的方式赋值，那如果我有两个mappers，循环第二遍就会覆盖原来的mappers了。

　　显然这是不对的，于是Configuration的set方法不能使用直接赋值的方式，要写成这样。

 　　然后我们把XMLConfigBuilder里导包的删掉，注解的部分注释掉。

　　现在我们来写SqlSessionFactoryBuilder里的build方法，在此之前我们创建一个SqlSessionFactory的实现类。

 　　我们回到SqlSessionFactoryBuilder，我们首先创建一个Configuration，然后实例化一下我们的实现类。把cfg作为参数传给这个实现类。

 　　现在我们再来修改下DefaultSqlSessionFactory。

 　　再创一个sqlsession的实现类。

　　再到sqlsessionfactory里的方法改一改

 　　这样的话我们现在的类都有了对应的关系——配置文件根据Resources类拿到io流传给构建者，构建者通过工具类(Configuration)创建工厂，工厂提供opensession方法创建sqlsession类。