Mybatis入门使用【4】（简单分析mybatis执行查询的过程-基于XML）

最新推荐文章于 2022-10-24 15:28:29 发布

RB_VER

最新推荐文章于 2022-10-24 15:28:29 发布

阅读量144

点赞数

分类专栏： mybatis 文章标签： mybatis

本文链接：https://blog.csdn.net/qq_41242680/article/details/105218034

版权

mybatis 专栏收录该内容

34 篇文章 0 订阅

订阅专栏

首先放上mybatis所执行的主程序。

import com.qublog.dao.UserDao;
import com.qublog.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 java.io.InputStream;
import java.util.List;

public class MybatisTest {
    public static void main(String[] args) throws Exception {
        //读取配置文件
        InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
        //创建SqlSessionFactory（工厂模式）
        SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
        SqlSessionFactory factory = builder.build(in);
        //使用工厂生产一个SqlSession对象
        SqlSession session = factory.openSession();
        //使用SqlSession创建dao接口的代理对象（动态代理模式）,UserDao.class是dao接口的字节码
        UserDao userDao = session.getMapper(UserDao.class);
        //使用代理对象执行方法
        List<User> userList = userDao.findAll();
        for (User user : userList) {
            System.out.println(user);
        }
        //释放资源
        session.close();
        in.close();
    }
}

上面程序使用到的设计模式：

创建工厂mybatis使用了构建者模式：把对象的创建细节隐藏，使用者直接调用方法即可拿到对象。
生产SqlSession使用了工厂模式：解耦，降低了类之间的依赖关系。
创建dao接口实现类使用了代理模式：不修改源码基础上对已有方法增强。

下面我们通过自定义mybatis来分析mybatis执行查询的过程。

首先放入运行整个项目流程的主测试代码：

import com.qublog.dao.UserDao;
import com.qublog.domain.User;
import com.qublog.mybatis.io.Resources;
import com.qublog.mybatis.sqlsession.SqlSession;
import com.qublog.mybatis.sqlsession.SqlSessionFactory;
import com.qublog.mybatis.sqlsession.SqlSessionFactoryBuilder;
import java.io.InputStream;
import java.util.List;

public class MybatisTest {
    public static void main(String[] args) throws Exception {
        //读取配置文件
        InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
        //创建SqlSessionFactory（工厂模式）
        SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
        SqlSessionFactory factory = builder.build(in);
        //使用工厂生产一个SqlSession对象
        SqlSession session = factory.openSession();
        //使用SqlSession创建dao接口的代理对象（动态代理模式）,UserDao.class是dao接口的字节码
        UserDao userDao = session.getMapper(UserDao.class);
        //使用代理对象执行方法
        List<User> userList = userDao.findAll();
        for (User user : userList) {
            System.out.println(user);
        }
        //释放资源
        session.close();
        in.close();
    }
}

比较上面两个程序可以看出，我们将mybatis的四个类Resources、SqlSession、SqlSessionFactory、SqlSessionFactoryBuilder替换为自己所实现的类。

接下来我们先分析mybatis执行流程：

解析配置文件：用到的技术就是解析XML的技术（我们将用dom4j来解析XML）。
根据配置文件信息创建Connection对象（注册驱动、获取连接）。
获取预处理对象PrepareStatement（所需要的SQL语句也是从配置文件信息中获取）。
执行查询。

项目pom.xml如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.qublog</groupId>
    <artifactId>mybatis01_design</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.16</version>
        </dependency>
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.12</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.10</version>
        </dependency>
        <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>
    </dependencies>
</project>

先将配置文件中有关mybatis的内容去掉：
UserDao.xml

<?xml version="1.0" encoding="UTF-8" ?>
<mapper namespace="com.qublog.dao.UserDao">
    <!-- 配置查询所有 -->
    <select id="findAll" resultType="com.qublog.domain.User">
        select * from user ;
    </select>
</mapper>

SqlMapConfig.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- mybatis的主配置文件 -->
<configuration>
    <!-- 配置环境 -->
    <environments default="mysql">
        <!-- 配置mysql的环境 -->
        <environment id="mysql">
            <!-- 配置事务类型 -->
            <transactionManager type="JDBC"></transactionManager>
            <!-- 配置连接池 -->
            <dataSource type="POOLED">
                <!-- 配置连接数据库的基本信息 -->
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/test_mybatis?serverTimezone=UTC"/>
                <property name="username" value="root"/>
                <property name="password" value="1234"/>
            </dataSource>
        </environment>
    </environments>

    <!-- 指定映射配置文件的位置，映射配置文件指的是每个dao独立的配置文件 -->
    <mappers>
        <mapper resource="com/qublog/dao/UserDao.xml" />
    </mappers>
</configuration>

接下来我们要读取xml中配置信息，从源码可以看出，用Resources来实现读取配置文件：

package com.qublog.mybatis.io;

import java.io.InputStream;

//使用类加载器读取配置文件的类
public class Resources {

    //根据传入参数，获取一个字节输入流
    public static InputStream getResourceAsStream(String filePath) {
        return Resources.class.getClassLoader().getResourceAsStream(filePath);
    }
}

读取完配置文件后，我们需要用SqlSessionFactoryBuilder来构建SqlSessionFactory：
SqlSessionFactoryBuilder.java

package com.qublog.mybatis.sqlsession;

import com.qublog.mybatis.cfg.Configuration;
import com.qublog.mybatis.sqlsession.defaults.DefaultSqlSessionFactory;
import com.qublog.mybatis.utils.XMLConfigBuilder;

import java.io.InputStream;

//用于创建一个SqlSessionFactory对象
public class SqlSessionFactoryBuilder {

    //根据参数的字节输入流来构建一个SqlSessionFactory
    public SqlSessionFactory build(InputStream config) {
        Configuration cfg = XMLConfigBuilder.loadConfiguration(config);
        return new DefaultSqlSessionFactory(cfg);
    }
}

通过分析源码，我们可以知道是用XMLConfigBuilder类来解析配置文件：
XMLConfigBuilder.java

package com.qublog.mybatis.utils;

import com.qublog.mybatis.cfg.Configuration;
import com.qublog.mybatis.cfg.Mapper;
import com.qublog.mybatis.io.Resources;
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;

/**
 *  用于解析配置文件
 */
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<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/qublog/dao/IUserDao.xml"
                    //把映射配置文件的内容获取出来，封装成一个map
                    Map<String,Mapper> mappers = loadMapperConfiguration(mapperPath);
                    //给configuration中的mappers赋值
                    cfg.setMappers(mappers);
                }else{
                }
            }
            //返回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<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();
        }
    }
}

这里将返回Configuration类
Configuration.java

package com.qublog.mybatis.cfg;

import java.util.HashMap;
import java.util.Map;

//自定义mybatis的配置类
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;
    }
}

程序中还用到Mapper类，这个类用来封装mapper配置信息：
Mapper.java

package com.qublog.mybatis.cfg;

//用于封装执行的SQL语句和结果类型的全限定类名
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的build方法返回了SqlSessionFactory实现类对象，这里是DefaultSqlSessionFactory：
DefaultSqlSessionFactory.java

package com.qublog.mybatis.sqlsession.defaults;

import com.qublog.mybatis.cfg.Configuration;
import com.qublog.mybatis.sqlsession.SqlSession;
import com.qublog.mybatis.sqlsession.SqlSessionFactory;

//SqlSessionFactory接口的实现类
public class DefaultSqlSessionFactory implements SqlSessionFactory {

    private Configuration cfg;

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

    //用于创建一个新的操作数据库对象
    public SqlSession openSession() {
        return new DefaultSqlSession(cfg);
    }
}

它实现了SqlSessionFactory接口：

package com.qublog.mybatis.sqlsession;

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

主程序中通过工厂的openSession方法生产出SqlSession实现类对象，这里还建立了Connection对象：
DefaultSqlSession.java

package com.qublog.mybatis.sqlsession.defaults;

import com.qublog.mybatis.cfg.Configuration;
import com.qublog.mybatis.sqlsession.SqlSession;
import com.qublog.mybatis.sqlsession.proxy.MapperProxy;
import com.qublog.mybatis.utils.DataSourceUtil;

import java.lang.reflect.Proxy;
import java.sql.Connection;

//SqlSession接口的实现类
public class DefaultSqlSession implements SqlSession {

    private Configuration cfg;
    private Connection connection;

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

    //用于创建代理对象
    public <T> T getMapper(Class<T> daoInterfaceClass) {
        return (T) Proxy.newProxyInstance(daoInterfaceClass.getClassLoader(),
                new Class[]{daoInterfaceClass},new MapperProxy(cfg.getMappers(),connection));
    }

    //用于释放资源
    public void close() {
        if(connection != null) {
            try {
                connection.close();
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }
}

它实现的接口：

package com.qublog.mybatis.sqlsession;

//自定义mybatis中数据库交互的核心类，它里面可以创建dao接口的代理对象
public interface SqlSession {

    //根据参数创建一个代理对象，参数是dao接口的字节码
    <T> T getMapper(Class<T> daoInterfaceClass);
    public void close();
}

其中用于建立Connection对象的DataSourceUtil类：

package com.qublog.mybatis.utils;


import com.qublog.mybatis.cfg.Configuration;

import java.sql.Connection;
import java.sql.DriverManager;

//用于创建数据源的工具类
public class DataSourceUtil {


    //用于获取一个连接
    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);
        }
    }
}

接着使用SqlSession创建dao接口的代理对象（动态代理模式），用代理对象来执行查询所有方法：
MapperProxy.java

package com.qublog.mybatis.sqlsession.proxy;

import com.qublog.mybatis.cfg.Mapper;
import com.qublog.mybatis.utils.Executor;

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.sql.Connection;
import java.util.Map;

public class MapperProxy implements InvocationHandler {

    private Map<String, Mapper> mappers;
    private Connection conn;

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

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

这里用到了Executor类来实现查询：

package com.qublog.mybatis.utils;

import com.qublog.mybatis.cfg.Mapper;

import java.beans.PropertyDescriptor;
import java.lang.reflect.Method;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.ResultSetMetaData;
import java.util.ArrayList;
import java.util.List;

/**
 * 负责执行SQL语句，并且封装结果集
 */
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.qublog.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();
            }
        }
    }
}

最后释放资源，整个过程结束。

RB_VER

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Mybatis入门使用【4】（简单分析mybatis执行查询的过程-基于XML）

import com.qublog.dao.UserDao;import com.qublog.domain.User;import org.apache.ibatis.io.Resources;import org.apache.ibatis.session.SqlSession;import org.apache.ibatis.session.SqlSessionFactory;im...
复制链接

扫一扫

专栏目录