mybatis-源码解析

Posted 2020-12-02 Emyin

1. SessionFactory

　　对于任何框架而言，在使用前都要进行一系列的初始化，MyBatis也不例外.

　　SqlSessionFactory是MyBatis框架中的一个接口,主要负责MyBatis框架初始化操作以及为开发人员提供SqlSession对象.

 

　　SqlSessionFactory有两个实现类

1. SqlSessionManager类(被抛弃)
2. DefaultSqlSessionFactory类

 

　　SqlSessionFactory基本执行流程

1.  调用 SqlSessionFactoryBuilder 对象的 build(inputStream) 方法；

 

2.  SqlSessionFactoryBuilder 会根据输入流 inputStream 等信息创建XMLConfigBuilder 对象 ;

 

3.  SqlSessionFactoryBuilder 调用 XMLConfigBuilder 对象的 parse() 方法；

 

4.  XMLConfigBuilder 对象返回 Configuration 对象；

 

5.  SqlSessionFactoryBuilder创建一个DefaultSessionFactory 对象,并将Configuration对象作为参数传给DefaultSessionFactory对象；

 

6.  SqlSessionFactoryBuilder 返回 DefaultSessionFactory 对象给 Client ，供 Client使用。

   Client可以使用DefaultSessionFactory对象创建需要的SqlSession.

 2. Configuration

MyBatis框架支持开发人员通过配置文件与其进行交流.在配置文件所配置的信息,在框架运行时,会被XMLConfigBuilder解析并存储在一个Configuration对象中.Configuration对象会被作为参数传送给DeFaultSqlSessionFactory.而DeFaultSqlSessionFactory根据Configuration对象信息为Client创建对应特征的SqlSession对象

 3. SqlSession四大神器

Executor:

每一个SqlSession对象都会拥有一个Executor(执行器对象);这个执行对象负责[增删改查]的具体操作.我们可以简单的将它理解为JDBC中Statement的封装版.

 

Executor是一个接口;主要有两个实现类.分别是[BaseExecutor]和[CachingExecutor].

[BaseExecutor]是一个抽象类.这种通过抽象类实现接口的方式是[适配器设计模式]的体现.主要用于方便次一级子类对接口中方法的实现.

[BaseExecutor]主要有三个实现类[SimpleExecutor],[ ReuseExecutor],[ BatchExecutor]

[SimpleExecutor]被称为[简单执行器],是MyBatis中默认使用的执行器. 每执行一次update或select，就开启一个Statement对象，用完立刻关闭Statement对象。（可以是Statement或PrepareStatement对象）

[ ReuseExecutor]被称为[可重用执行器].这里的重用指的是重复使用Statement. 它会在内部利用一个Map把创建的Statement都缓存起来，每次在执行一条SQL语句时，它都会去判断之前是否存在基于该SQL缓存的Statement对象，存在而且之前缓存的Statement对象对应的Connection还没有关闭的时候就继续用之前的Statement对象，否则将创建一个新的Statement对象，并将其缓存起来。因为每一个新的SqlSession都有一个新的Executor对象，所以我们缓存在ReuseExecutor上的Statement的作用域是同一个SqlSession

[ BatchExecutor]称为[批处理执行器].用于将多个sql语句一次性输送到数据库执行.

[CachingExecutor]称为[缓存执行器]. 先从缓存中获取查询结果，存在就返回，不存在，再委托给Executor delegate去数据库取，delegate可以是上面任一的SimpleExecutor、ReuseExecutor、BatchExecutor。

执行器对象是由Coniguration对象负责创建的.Configuration对象会根据得到[ExecutorType]创建对应的Excecutor对象,并把这个Excecutor对象传给SqlSession对象

 

 

 ExecutorType来决定Configuration对象创建何种类型的执行器.它的赋值可以通过两个地方进行赋值.

       首先.可以通过<settings>标签来设置当前工程中所有SqlSession对象使用的默认Executour

 　　也可以通过SqlSessoinFactory中openSession方法来指定具体的SqlSession使用的执行器

 StatementHandler:

 是四大神器中最重要的一个对象,负责操作Statement与数据库进行交流.在工作时还会使用ParameterHandler进行参数配置,使用ResultHandler将查询结果与实体类对象进行绑定.

在StatementHandler接口中有四种重要的方法.分别是prepare,parameterize,batch,update.

 prepare:用于具体创建一个Statement对象或者preparedStatement对象

 parameterize:用于初始化Statement及对Sql中占位符进行赋值.

 update:用于通知Statement将[insert,update,delete]推送到数据库

 query:用于通知Statement将[select]推送到数据库并返回对应查询结果.

StatementHandler接口下有两个直接实现类[BaseStatementHandler]和[RoutingStatementHandler]

 

[]RoutingStatementHandler]:是一个具体实现类.在这个类中并没有对Statement对象进行具体使用.只是根据得到Executor类型,决定创建何种类型StatementHandler对象.在MyBatis工作时,使用的StatementHandler接口对象实际上就是RoutingStatementHandler对象.

我们可以简单理解为

             StatementHandler statmentHandler = new RountingStatementHandler();

 

[BaseStatementHandler]:是StatementHandler接口的另一个实现类.本身是一个抽象类.用于简化StatementHandler接口实现的难度,属于适配器设计模式体现.它有三个实现类.SimpleStatementHandler,PreparedStatementHandler,CallableStatementHandler.

在RountingStatementHandler创建时,就跟根据接收的Executor类型来创建这个三个类型对象的.

[SimpleStatementHandler]:管理Statement对象向数据库中推送不需要预编译的SQL语句

[PreparedStatementHandler]:管理PreparedStatementHandler对象向数据库推送预编译的SQL语句.

[CallableStatementHandler]:管理CallableStatement对象调用数据库中构造函数.

 

public StatementHandler newStatementHandler(Executor executor, MappedStatement mappedStatement, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
        StatementHandler statementHandler = new RoutingStatementHandler(executor, mappedStatement, parameterObject, rowBounds, resultHandler, boundSql);
        StatementHandler statementHandler = (StatementHandler)this.interceptorChain.pluginAll(statementHandler);
        return statementHandler;
    }

RoutingStatementHandler构造方法,将会根据Executor的类型决定创建SimpleStatementHandler,PreparedStatementHandler,CallableStatementHandler实例对象.

 

public RoutingStatementHandler(Executor executor, MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
        switch(ms.getStatementType()) {
        case STATEMENT:
            this.delegate = new SimpleStatementHandler(executor, ms, parameter, rowBounds, resultHandler, boundSql);
            break;
        case PREPARED:
            this.delegate = new PreparedStatementHandler(executor, ms, parameter, rowBounds, resultHandler, boundSql);
            break;
        case CALLABLE:
            this.delegate = new CallableStatementHandler(executor, ms, parameter, rowBounds, resultHandler, boundSql);
            break;
        default:
            throw new ExecutorException("Unknown statement type: " + ms.getStatementType());
        }

    }

StatementHandler接口方法介绍：

 prepare方法:

 prepare方法用于创建一个(Statement or PreparedStatement or CallableStatement)对象,并设置Statement对象的最大工作时间和一次性读取的最大数据量.让后将生成的Statement对象返回.

  prepare方法只在BaseStatementHandler被实现.在其三个子类中没有被重写.用于三个子类调用获得对应的Statement接口对象.

  prepare方法依靠instantiateStatement(connection)方法来返回具体Statement接口对象.

  这个方法是BaseStatementHandler中定义的抽象方法,由三个子类来具体实现.

 

parameterize方法：

主要为PreparedStatement和CallableStatement传参.因此只在PreparedStatementHandler和CallableStatementHandler中被重写

 PreparedStatementHandler

 public void parameterize(Statement statement) throws SQLException {
        this.parameterHandler.setParameters((PreparedStatement)statement);
    }

CallablestatementHandler

 public void parameterize(Statement statement) throws SQLException {
        this.registerOutputParameters((CallableStatement)statement);
        this.parameterHandler.setParameters((CallableStatement)statement);
    }

在这两个方法中,可以看到都是[ParameterHandler]对象进行参数赋值的.

 

query方法

  输送查询查询语句,并将查询结果转换对应的实体类对象

 

  SimpleStatementHandler 中的 query 方法

 

public <E> List<E> query(Statement statement, ResultHandler resultHandler) throws SQLException {
        String sql = this.boundSql.getSql();
        statement.execute(sql);
        return this.resultSetHandler.handleResultSets(statement);
    }

PreparedStatementHandler中的query方法

public <E> List<E> query(Statement statement, ResultHandler resultHandler) throws SQLException {
        PreparedStatement ps = (PreparedStatement)statement;
        ps.execute();
        return this.resultSetHandler.handleResultSets(ps);
    }

 CallableStatementHandler中的query方法

 public <E> Cursor<E> queryCursor(Statement statement) throws SQLException {
        CallableStatement cs = (CallableStatement)statement;
        cs.execute();
        Cursor<E> resultList = this.resultSetHandler.handleCursorResultSets(cs);
        this.resultSetHandler.handleOutputParameters(cs);
        return resultList;
    }

  可以看到在得到查询结果后,都是使用[ResultSetHandler]对结果进行转换.

 update方法

   输送[insert,update,delete]语句并返回处理数据行，具体代码到三个实现类里看吧

 

SqlSession中四大神器之ParameterHandler

　　参数处理器,负责为PreparedStatement的sql语句参数动态赋值

　　

 这个接口中只有两个方法， 只有一个实现类DefaultParameterHandler

 getParameterObject 方法,用于读取参数.

 setParameters用于对PreparedStatement的参数赋值.

 

参数处理器对象是在创建StatementHandler对象同时被创建的.由Configuration对象负责创建.

 

 protected BaseStatementHandler(Executor executor, MappedStatement mappedStatement, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
        this.configuration = mappedStatement.getConfiguration();
        this.executor = executor;
        this.mappedStatement = mappedStatement;
        this.rowBounds = rowBounds;
        this.typeHandlerRegistry = this.configuration.getTypeHandlerRegistry();
        this.objectFactory = this.configuration.getObjectFactory();
        if (boundSql == null) {
            this.generateKeys(parameterObject);
            boundSql = mappedStatement.getBoundSql(parameterObject);
        }

        this.boundSql = boundSql;
        this.parameterHandler = this.configuration.newParameterHandler(mappedStatement, parameterObject, boundSql);
        this.resultSetHandler = this.configuration.newResultSetHandler(executor, mappedStatement, rowBounds, this.parameterHandler, resultHandler, boundSql);
    }

在mybatis中,使用动态代理模式.当dao.findByDeptNo(10)将要执行时;会被JVM进行拦截

交给mybatis中的代理实现类MapperProxy的invoke方法中，然后在一步步交给ParameterHandler中setParameter方法,将参数交给对应占位符

 

SqlSession中四大神器之ResultSetHandler

 ResultSetHandler接口主要负责两件事

1. 处理Statement执行后产生的结果集，生成结果列表
2. 处理存储过程执行后的输出参数   

只有一个实现类DefaultResultSetHandler