MyBatis的解析和运行原理

MyBatis的运行可分为两大部分，第一部分是读取配置文件缓存到Configuration对象，用来创建SqlSessionFactory，第二部分是SqlSession的执行过程。

先导入源码，不然你不知道方法之间是怎么调用。

一构建SqlSessionFactory过程

第一步，通过org.apache.ibatis.builder.xml.XMLConfigBuilder来解析配置的XML文件。我们一般是能过new SqlSessionFactoryBuilder().build()方法来创建SqlSessionFactory，最终于的是运行build(Reader reader, String environment, Properties properties)这个方法，接着创建一个XMLConfigBuilder对象来解析XML文件，把读到的数据存入到org.apache.ibatis.session.Configuration中 ，在把数据 存入到Configuration是调用过org.apache.ibatis.builder.xml.XMLConfigBuilderr的parseConfiguration(XNode root)方法，源码如下：

private void parseConfiguration(XNode root) { try { //issue #117 read properties first propertiesElement(root.evalNode("properties")); Properties settings = settingsAsProperties(root.evalNode("settings")); loadCustomVfs(settings); typeAliasesElement(root.evalNode("typeAliases")); pluginElement(root.evalNode("plugins")); objectFactoryElement(root.evalNode("objectFactory")); objectWrapperFactoryElement(root.evalNode("objectWrapperFactory")); reflectorFactoryElement(root.evalNode("reflectorFactory")); settingsElement(settings); // read it after objectFactory and objectWrapperFactory issue #631 environmentsElement(root.evalNode("environments")); databaseIdProviderElement(root.evalNode("databaseIdProvider")); typeHandlerElement(root.evalNode("typeHandlers")); mapperElement(root.evalNode("mappers")); } catch (Exception e) { throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e); } }

是不是知道为什么Mybatis的核心配置是有顺序的，不能打破它的顺序。

第二步，通过得到的configuration对象，调用qlSessionFactoryBuilder类中的build(Configuration config)方法，通过这个方法来调用DefaultSqlSessionFactory这类的构造方法

如果你想知道Mybatis所有的配置的信息，除了看API之外，还可以能Configuration的源码。

二SqlSession运行过程

在旧版本的MyBatis或者是iBatis中，使用的更多是SqlSession接口的方法进行操作，但是有新版的MyBatis建议使用Mapper。

我们一般通过SqlSession的getMapper方法来得到Mapper，面这个方法最终是通过org.apache.ibatis.binding.MapperProxyFactory这个类的newInstance方法产生，这个的重要代码如下

public class MapperProxyFactory<t> { @SuppressWarnings("unchecked") protected T newInstance(MapperProxy<t> mapperProxy) { return (T) Proxy.newProxyInstance(mapperInterface.getClassLoader(), new Class[] { mapperInterface }, mapperProxy); } public T newInstance(SqlSession sqlSession) { final MapperProxy<t> mapperProxy = new MapperProxy<t>(sqlSession, mapperInterface, methodCache); return newInstance(mapperProxy); }}</t></t></t></t>

我们可以看到动态代理对接口的绑定，它的作用就是生成动态代理对象。面代理的方法则被放到了MapperProxy类中。我们还要看MapperProxy的源码。

public class MapperProxy<t> implements InvocationHandler, Serializable { @Override public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { try { if (Object.class.equals(method.getDeclaringClass())) { return method.invoke(this, args); } else if (isDefaultMethod(method)) { return invokeDefaultMethod(proxy, method, args); } } catch (Throwable t) { throw ExceptionUtil.unwrapThrowable(t); } final MapperMethod mapperMethod = cachedMapperMethod(method); return mapperMethod.execute(sqlSession, args); } private MapperMethod cachedMapperMethod(Method method) { MapperMethod mapperMethod = methodCache.get(method); if (mapperMethod == null) { mapperMethod = new MapperMethod(mapperInterface, method, sqlSession.getConfiguration()); methodCache.put(method, mapperMethod); } return mapperMethod; }}</methodhandles></method></t></method></t></t>

看到invoke方法，一旦mapper是一个代理对象，那么它就会运行到invoke方法里面，显然mapper不是一个类，而是接口，所以它会生成MapperMethod对象，它是通过cachedMapperMethod方法对其初始化，然后执行execute方法，把sqlSession各当前运行的参数传递进去。我们查看这个方法的源码：

public Object execute(SqlSession sqlSession, Object[] args) { Object result; switch (command.getType()) { case INSERT: { Object param = method.convertArgsToSqlCommandParam(args); result = rowCountResult(sqlSession.insert(command.getName(), param)); break; } case UPDATE: { Object param = method.convertArgsToSqlCommandParam(args); result = rowCountResult(sqlSession.update(command.getName(), param)); break; } case DELETE: { Object param = method.convertArgsToSqlCommandParam(args); result = rowCountResult(sqlSession.delete(command.getName(), param)); break; } case SELECT: if (method.returnsVoid() && method.hasResultHandler()) { executeWithResultHandler(sqlSession, args); result = null; } else if (method.returnsMany()) { result = executeForMany(sqlSession, args); } else if (method.returnsMap()) { result = executeForMap(sqlSession, args); } else if (method.returnsCursor()) { result = executeForCursor(sqlSession, args); } else { Object param = method.convertArgsToSqlCommandParam(args); result = sqlSession.selectOne(command.getName(), param); } break; case FLUSH: result = sqlSession.flushStatements(); break; default: throw new BindingException("Unknown execution method for: " + command.getName()); } if (result == null && method.getReturnType().isPrimitive() && !method.returnsVoid()) { throw new BindingException("Mapper method '" + command.getName() + " attempted to return null from a method with a primitive return type (" + method.getReturnType() + ")."); } return result; }

我主要看result = executeForMany(sqlSession, args);这名个方法，再查看这个方法的源码：

private <e> Object executeForMany(SqlSession sqlSession, Object[] args) { List<e> result; Object param = method.convertArgsToSqlCommandParam(args); if (method.hasRowBounds()) { RowBounds rowBounds = method.extractRowBounds(args); result = sqlSession.<e>selectList(command.getName(), param, rowBounds); } else { result = sqlSession.<e>selectList(command.getName(), param); } // issue #510 Collections & arrays support if (!method.getReturnType().isAssignableFrom(result.getClass())) { if (method.getReturnType().isArray()) { return convertToArray(result); } else { return convertToDeclaredCollection(sqlSession.getConfiguration(), result); } } return result; }</e></e></e></e>

我们可以看到它最终还调用了SqlSession接口的方法，其它判断成立的条件，还是调用SqlSession接口的方法。

现在我们可以知道为什么MyBatis只用Mapper接口便能够运行SQL，因为映射器的XML文件的命名空间对应的便是这个接口的全路径，那么它根据全路径和方法但能够绑定起来，通过动态代理技术，让这个接口跑起来。

我们已经知道了映射器其实就是一个代理对象，进入MapperMethod的execute方法，通过简单判断就进入SqlSession接口提供的不同方法，但是不知道它们是怎么样运行的。Mapper执行的过程是通过Executor（代理执行器）、StatementHandler（使用JDBC的Statement和PrepareStatement进行操作）、ParameterHandler（用于SQL对参数的处理）、ResultHandler（对数据集ResultSet的封装返回处理）。

执行器（Executor），它是真正执行JAVA与数据库交互的东西，MyBatis提供了三种执行器，可心根据自己的需求在setting元素的defaultExecutorTope中配置，这里不介绍，因为与这篇博客关系不大，自己查API就可以了。我们打开SimpleExecutor这个类，随便打开找一个方法，这里为更好的体现方法的结构，这里贴的方法如下：

public class SimpleExecutor extends BaseExecutor {@Override public <e> List<e> doQuery(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException { Statement stmt = null; try { Configuration configuration = ms.getConfiguration(); StatementHandler handler = configuration.newStatementHandler(wrapper, ms, parameter, rowBounds, resultHandler, boundSql); stmt = prepareStatement(handler, ms.getStatementLog()); return handler.<e>query(stmt, resultHandler); } finally { closeStatement(stmt); } } } private Statement prepareStatement(StatementHandler handler, Log statementLog) throws SQLException { Statement stmt; Connection connection = getConnection(statementLog); stmt = handler.prepare(connection, transaction.getTimeout()); handler.parameterize(stmt); return stmt; }</e></e></e>

我们可以看到它是根据 Configuration来构建StatementHandler，然后使用prepareStatement方法对SQl编译 关对参数进行初始化，这个方法调用了StatementHandler的prepare()进行预编译和基础配置，然后通过StatementHandler的parameterize（）来设置参数并执行。

数据库会话器（StatementHandler）就是专门处理数据库会话的，我们通过RoutingStatementHandler来得到StatementHandler对象，它也使用了代理设计模式，StatementHandler分为三种：CallableStatementHandler、SimpleStatementHandler和PreparedStatementHandler，在初始化的时候会根据上下文环境决定创建那个StatementHandler对象，我们以SimpleStatementHandler为例，我们 看下面的方法（在运行这个方法，还用调用instantiateStatement方法进行SQL预编译）

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

由于执行前参数和SQl都被prepare()方法预编译，参数在parameterixe()方法上已经进行了设置。

参数处理器（ParameterHandler）对预编译语句进行参数设置。实现类（DefaultParameterHandler）

结果处理器（ResultSetHandler），实现类（DefaultResultSetHandler），默认情况是通过这个类来处理。

SqlSession运行总结：SqlSession是通过Executo创建StatementHandler来运行的，面StatementHandler要经过下面三步：prepared预编译SQL；parameterize设置参数；query/执行SQl。