# mybatis

**Repository Path**: lyon_zhao/mybatis

## Basic Information

- **Project Name**: mybatis
- **Description**: 自定义mybatis分解，详细记录mybatis底层实现原理
- **Primary Language**: Java
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2020-11-23
- **Last Updated**: 2022-04-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### 第一步 解析配置文件

##### 1.1 解析配置是原生的

```java
MybatisTest.java     

        //1.读取配置文件
        InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
        //2.创建SqlSessionFactory工厂
        SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
        //factory:装着cfg对象，  cfg：数据库参数，映射文件的执行操作以及对应的方法
        SqlSessionFactory factory = builder.build(in);
下接第二步
```

##### 1.2 对build 方法进行解析

> ```java
> build 是在   SqlSessionFactoryBuilder.java 中
>         public SqlSessionFactory build(InputStream config){//SqlMapConfig.xml 的 流对象
>         //cfg：数据库参数，映射文件的执行操作以及对应的方法   loadConfiguration 查看3
>         Configuration cfg = XMLConfigBuilder.loadConfiguration(config);//从xml中解析和从注解的解析    
>         return  new DefaultSqlSessionFactory(cfg);
>     }
>     
> ```

##### 1.3对 loadConfiguration 方法进行解析

```java
loadConfiguration方法是在XMLConfigBuilder.java中
    public static Configuration loadConfiguration(InputStream config){//SqlMapConfig.xml流对象
        try{
            //定义封装连接信息的配置对象（mybatis的配置对象）
            Configuration cfg = new Configuration(); //查看3.1

            //1.获取SAXReader对象  解析xml的工具类
            SAXReader reader = new SAXReader();
            //2.根据字节输入流获取Document对象
            Document document = reader.read(config); //config 1 中 InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");  解析xml的配置in对象
            //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/itheima/dao/IUserDao.xml"
                    //把映射配置文件的内容获取出来，封装成一个map
                    //loadMapperConfiguration 查看3.2
                    Map<String,Mapper> mappers = loadMapperConfiguration(mapperPath); 
                    //给configuration中的mappers赋值
                    cfg.setMappers(mappers);
                }else{
                    System.out.println("使用的是注解");
                    //表示没有resource属性，用的是注解
                    //获取class属性的值
                    String daoClassPath = mapperElement.attributeValue("class");//com.itheima.dao.IUserDao
                    //根据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();
            }
        }

    }
    
```

###### 1.3.1Configuration说明

封装的配置类

```java
Configuration.java

public class Configuration {

    private String driver;
    private String url;
    private String username;
    private String password;

    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 String getDriver() {
        return driver;
    }

    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;
    }
}
```

###### 1.3.2 loadMapperConfiguration 说明

```java
XMLConfigBuilder.java
private static Map<String,Mapper> loadMapperConfiguration(String mapperPath)throws IOException {
        InputStream in = null;
        try{
            //定义返回值对象  //Mapper 是封装对象 查看3.3
            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");//接口名
            //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();//sql
                //创建Key
                String key = namespace+"."+id;//com.itheima.dao.IUserDao.findAll
                //创建Value
                Mapper mapper = new Mapper();
                mapper.setQueryString(queryString);//sql
                mapper.setResultType(resultType);//返回的类型（封装的类型）
                //把key和value存入mappers中
                mappers.put(key,mapper); // {com.itheima.dao.IUserDao.findAll:{queryString:Sql,resultType:User}}
            }
            return mappers;
        }catch(Exception e){
            throw new RuntimeException(e);
        }finally{
            in.close();
        }
    }

```

###### 1.3.3 Mapper说明

封装对象

```java
public class Mapper {

    private String queryString;//SQL
    private String resultType;//实体类的全限定类名 USer

    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;
    }
}
```

### 第二步 构建连接对象

##### 2.1 获取连接对象

```java
MybatisTest.java
    
    //上接第一步
    //session内部两个成员，cfg，connection
        SqlSession session = factory.openSession();  //2.2

	//下接第三步
    
    
```

##### 2.2   新建DefaultSqlSession对象返回

```
DefaultSqlSessionFactory.java

    @Override
    public SqlSession openSession() {
        return new DefaultSqlSession(cfg);   //2.3
    }
```

##### 2.3  根据cfg配置对象，创建DefaultSqlSession 连接对象

```
    public DefaultSqlSession(Configuration cfg){
        this.cfg = cfg;
        
        //2.4
        connection = DataSourceUtil.getConnection(cfg);//根据cfg中的参数，获得连接对象
    }
```

##### 2.4 获取连接对象

```java
   DataSourceUtil.java
   
   
   public static Connection getConnection(Configuration cfg){
        try {
            Class.forName(cfg.getDriver());//注册驱动
            return DriverManager.getConnection(cfg.getUrl(), cfg.getUsername(), cfg.getPassword());  //封装的jdbc底层的连接方法
        }catch(Exception e){
            throw new RuntimeException(e);
        }
    }
```





### 第三步 创建Dao的接口代理对象

##### 3.1  创建接口代理对象

```java
        MybatisTest.java
        
        //上接第二步
        IUserDao userDao = session.getMapper(IUserDao.class);  //构建连接对象
		//getMapper 方法接3.3
```

##### 3.2 接口对象

```java
IUserDao.javajava


public interface IUserDao {

    /**
     * 查询所有操作
     * @return
     */
//    @Select("select * from t_user")
    List<User> findAll();
}
```

##### 3.3   getMapper 映射方法

```java
    DefaultSqlSession.java

        public <T> T getMapper(Class<T> daoInterfaceClass) {
                //类加载器，接口的数组，invocationhandller（如何增强，invoke方法）
                return (T) Proxy.newProxyInstance(daoInterfaceClass.getClassLoader(),
                        new Class[]{daoInterfaceClass},new MapperProxy(cfg.getMappers(),connection));
            }
		//实现的动态代理的方法，参数是 类加载器，方法实例，增强方法
		//new Class[]{daoInterfaceClass}  匿名内部类 创建daoInterfaceClass这个字节码对象的实例
		//MapperProxy(cfg.getMappers(),connection)  接3.4

```

##### 3.4   MapperProxy 映射方法

```java
    //map的key是全限定类名+方法名
    private Map<String,Mapper> mappers;
    private Connection conn;

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

    /**
     * 用于对方法进行增强的，我们的增强其实就是调用selectList方法
     * @param proxy
     * @param method
     * @param args
     * @return
     * @throws Throwable
     */
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        //1.获取方法名
        String methodName = method.getName();//findAll
        //2.获取方法所在类的名称
        String className = method.getDeclaringClass().getName();//当前方法所在的接口的全限定名称com.itheima.dao.IUserDao
        //3.组合key
        String key = className+"."+methodName;//com.itheima.dao.IUserDao.findAll
        //4.获取mappers中的Mapper对象
        Mapper mapper = mappers.get(key);//mapper: sql  封装类型User
        //5.判断是否有mapper
        if(mapper == null){
            throw new IllegalArgumentException("传入的参数有误");//没有这个语句 com.itheima.dao.IUserDao.findAll
        }
        //6.调用工具类执行查询所有
        return new Executor().selectList(mapper,conn);//List<User>  下接3.5
    }
```

##### 3.5  selectList查询工具类方法



```java
Executor.java

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);//User.class
            //2.获取PreparedStatement对象
            pstm = conn.prepareStatement(queryString);  
            //3.执行SQL语句，获取结果集
            rs = pstm.executeQuery();  //JDBC原生的sql执行方法
            //4.封装结果集
            List<E> list = new ArrayList<E>();//定义返回值
            while(rs.next()) {//一行
                //实例化要封装的实体类对象
                E obj = (E)domainClass.newInstance();//user对象

                //取出结果集的元信息：ResultSetMetaData
                ResultSetMetaData rsmd = rs.getMetaData();
                //取出总列数
                int columnCount = rsmd.getColumnCount();
                //遍历总列数
                for (int i = 1; i <= columnCount; i++) {//一列
                    //获取每列的名称，列名的序号是从1开始的
                    String columnName = rsmd.getColumnName(i);//id username  sex
                    //根据得到列名，获取每列的值
                    Object columnValue = rs.getObject(columnName);//获取结果集当前游标位置的id 的值
                    //给obj赋值：使用Java内省机制（借助PropertyDescriptor实现属性的封装）
                    PropertyDescriptor pd = new PropertyDescriptor(columnName,domainClass);//要求：实体类的属性和数据库表的列名保持一种
                    //获取它的写入方法
                    Method writeMethod = pd.getWriteMethod();//写id的操作：setId(id);
                    //把获取的列的值，给对象赋值
                    writeMethod.invoke(obj,columnValue);//user.setId(1); user.setUsername("zhangsan");
                }
                //把赋好值的对象加入到集合中
                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();
            }
        }
    }
```

### 第四步 调用动态代理的方法

```java
        //4.使用SqlSession创建Dao接口的代理对象
        IUserDao userDao = session.getMapper(IUserDao.class);
        //5.使用代理对象执行方法
        List<User> users = userDao.findAll();//代理对象执行任何方法，都是在执行底层的invoke方法
        for(User user : users){
            System.out.println(user);
        }
        //6.释放资源
        session.close();
        in.close();
```