MyBatis源码分析（05）执行查询SQL

一时失言乱红尘 2022-12-09 05:30 112阅读 0赞

前面的获取对象的过程基本都debug完了，下面看最后一行：

> String name = mapper.selectNameById(1);

也就是执行SQL语句的具体过程。

下面从SQL语句的执行开始debug：

> 1、String name = mapper.selectNameById(1);

![aa54937c5fb45e99dd659a22788d24fa.png][]

我们自定义的接口UserMapper是个接口，没有实现类，前面分析获取mapper时我们知道，mybatis会为mapper类生成代理类，生成代理类的方法是使用MapperProxyFactory工厂类生成，代理的类其实就是MapperProxy，所以我们要看下一步的执行过程就要进入这个类进行查看，

> 1、String name = mapper.selectNameById(1);
> 
> 2、org.apache.ibatis.binding.MapperProxy\#invoke

![8ea0171297d87874c13f3ebe05941f52.png][]

其中第一个if判断 if (Object.class.equals(method.getDeclaringClass()))  ，这个MapperProxy就是一个InvocationHandler（他的作用是jdk创建动态代理时用的，没印象的可以复习一下），也就是我们会根据当前的接口创建一个这个接口的动态代理对象，使用动态代理对象再利用反射调用实际对象的目标方法。

然而动态代理对象里面的方法都是Interface规定的。但是动态代理对象也能调用比如toString(),hashCode()等这些方法呀，这些方法是所有类从Object继承过来的。

所以这个判断的根本作用就是，如果利用动态代理对象调用的是toString，hashCode,getClass等这些从Object类继承过来的方法，就直接反射调用。如果调用的是接口规定的方法。我们就用MapperMethod来执行。所以这个判断是十分必要的。

继续看下面的方法，判断出不是Object的方法，是接口的方法，所以执行下面的代码，从cachedMapperMethod中获取要执行的方法：

> 1、String name = mapper.selectNameById(1);
> 
> 2、org.apache.ibatis.binding.MapperProxy\#invoke
> 
> 3、org.apache.ibatis.binding.MapperProxy\#cachedMapperMethod

![d08002c2b091e9e89cd0c0769d7b9620.png][]

这是个典型的从缓存中获取方法对象的代码，如果缓存中没有，就新建并加入缓存，最后返回这个方法，methodCache对象是一个map，存储了创建过的方法对象，创建的方式是根据接口，方法和配置对象进行创建。到这里我们就获取了我们实际要执行的方法的对象了。

现在我们回来继续看第二步，回到org.apache.ibatis.binding.MapperProxy\#invoke方法中，

![9f0b20e87f675312866ac6b8a758d075.png][]

最后一行代码return中执行的，就是真正操作数据库的方法。我们继续看下一步：

![d2a9c96e2c33a5ca58df975e754a79c4.png][]

进入这个方法可以看到，内容很丰富，开始是一个判断语句块，判断当前的操作是什么类型，我们通过idea来看一下正在执行的是什么类型：

![3d1eacf093ed5d12b9eb7ef035abdc50.png][]

如果是增删改的话，执行方式比较一致和简单，

![cf45ec1bdee5b0f5888b0f8abf10d7d4.png][]

准备好参数然后去执行，本次执行的是查询操作，所以我们主要看下面的SELECT：

![0cd926e29f3a531d0a74c8c77ad19928.png][]

查询操作通过判断返回的类型，执行对应的方法，前面几种是比较经典的返回类型，如果都不满足，就会执行else内的方法，本次的selectNameById方法执行的就是else中的内容：

![af9e6846a16c43550df163a8f364598f.png][]

第一行是转换参数为SQL命令中的形式，下面这一行是关键，真正执行的是sqlSession.selectOne方法，我们在前面讨论获取sqlSession对象的源码的时候，查看了SqlSession类中的方法，这是其中一个。传入的第一个参数就是方法：

![31f7bb77a976742df174e9c81e7d33fa.png][]

第二个就是参数，下面我进入这个方法，查看流程：

![961594a56717e791a8426793130a8c3b.png][]

我们在使用mybatis的时候，用的是官方文档建议的方法，获取mapper对象，使用mapper对象执行我们自定义的数据库操作方法。官方文档上还有另一种调用方法：

![8e8add3f960736da8b16198b0c5a4c23.png][]

就是直接调用sqlSession中的方法，上面图片例子中的两个参数就是我们前面的过程在组合的参数，也就是说获取mapper对象执行方法最终的过程也是执行sqlSession中的内容，和上面这种方法殊途同归。我们继续来看selectOne中的内容，selectOne最终的执行过程也是执行selectList查询一个列表，然后获取列表中的第一个元素，继续看selectList方法：

![a634c7159261ebcad3d893cc824e7f19.png][]

这里加了一个方法参数，RowBounds.DEFAULT，这是物理分页传入的默认参数，返回的结果其实分页了，但是和没分页效果一样，下面继续调用：

![57656b628da8d90ef9520a2a4832ffd4.png][]

我们在执行jdbc的时候，先编译SQL语句，获取一个Statement对象，这里获取的是一个MappedStatement对象，这个类对应的就是select标签。类的属性和select标签的属性一致。下面这一行executor.query方法执行操作，继续看下面的代码，使用Executor的对象执行，Executor是一个接口，有两个实现类，通过工具可以看到这里使用的是CachingExecutor类的对象实例执行的：

![72b621d43a2809e41e8433a119dcc437.png][]

通过类名我们可以猜测到，这个Executor执行类是使用内存的，将数据保存到缓存中，这样可以有效的解决增删改查性能。缓存的作用域为mapper（namespace），所以同一个namespace的操作会影响到相同作用域下的缓存，这样不同的域对同一个表进行操作很有可能导致缓存中的数据不一样，出现问题，还是不推荐使用。我们看方法的内容：

![a29dbad0e98ecb7219bf9ff44d2b07ee.png][]

前面两行是创建缓存值，获取记录，继续往下看：

![3d54409d8713dd2e6dc7e026324efb99.png][]

上面这个过程就是一级缓存的内容，如果缓存里不为空，就从缓存中查询，如果缓存为空，就查询数据库，这里启动程序只进行一次查询，所以会走查询数据库的分支，最后一行的delegate对象，也是一个Executor对象，这里走不使用缓存的分支，执行操作使用的BaseExecutor对象：

![e0b7cdd9105c03884c3bf81da209ca8f.png][]

这里从数据库查，走的是：

> list = queryFromDatabase(ms, parameter, rowBounds, resultHandler, key, boundSql);

这条代码分支，从名字可以看出从数据库查询，参数中传了很多，除了编译好的SQL，还有分页，结果的handler，等等，这些是mybatis封装jdbc后以自己的特色去执行SQL的方式，这种麻烦的方法简化了我们使用mybatis的方式，下面继续看：

![5f1dfecb4aa6cbdcff13bacc5fa94b75.png][]

看代码：

> localCache.putObject(key, EXECUTION\_PLACEHOLDER);

这里查询了一次以后，加入了一级缓存当中，下面就是执行doQuery方法：

![843ba0ff2f87838d7e4f0a826042ff3e.png][]

这里进入了SimpleExecutor类中，第一行的Statement stmt =null;代码有点眼熟，就是我们jdbc中的Statement 对象，说明我们马上要接近真相了！继续，前面三个是对SQL语句进行预编译，然后执行query方法，通过debug，知道下一步执行这个方法：

![150cbd3e38cc1e26b37526ac5f0d0e90.png][]

这里就是一行调用，继续debug：

![947ac1315552de70ea83a2e306cee8c0.png][]

第一行是jdk中jdbc的类，执行获取预编译操作，然后执行了ps.execute();，这个就是我们的jdbc方法！终于到这里了！resultSetHandler是mybatis的对象，包装jdbc的结果，我们继续看：

![436f95caa0fe905d7a71eb2617bea598.png][]

ResultSetHandler负责处理两件事，一是处理Statement执行后产生的结果集，生成结果列表，二是处理存储过程执行后的输出参数。DefaultResultSetHandler类是ResultSetHandler的默认实现，这里执行了这个类的handleResultSets方法，其实现的步骤就是将Statement执行后的结果集，按照Mapper文件中配置的ResultType或ResultMap来封装成对应的对象，最后将封装的对象返回即可，这里有一行代码：

> ResultSetWrapper rsw = getFirstResultSet(stmt);

我们进入getFirstResultSet方法看一看：

![22133a227cbd2c5dff5fec578341a9a9.png][]

这里的代码很眼熟了，就是jdbc接收结果的过程，最后一行把这个结果封装成了mybatis中的结果对象，封装的过程如下：

![e59d64eb8b5db5e45812c95e0d1942e7.png][]

这里面包含的记过的很多熟悉，类型，名称，对象的类型，等等。我们继续来看handleResultSets方法，组合好多个返回结果的list后，我们看最后一行代码，执行collapseSingleResultList方法：

![dd0da27c0d3f099da1a6ea0c4e1d1f25.png][]

从判断可以看出，在判断是不是只有一条结果，这样封装返回结果的对象就执行完了。我们再次返回前面的方法：

这里是前面的方法，返回的就是符合类型的结果的list，无论一条还是多条，继续debug：

继续往回执行：

![ae1cc1cb6d0df4c954b0ae3b1ee55a8d.png][]

这里把最终的查询结果放到了一级缓存中，然后继续往回执行：

> 1、String name = mapper.selectNameById(1);
> 
> 2、org.apache.ibatis.binding.MapperProxy\#invoke
> 
> 3、org.apache.ibatis.binding.MapperProxy\#cachedMapperMethod
> 
> 4、org.apache.ibatis.binding.MapperMethod\#execute
> 
> 5、org.apache.ibatis.session.defaults.DefaultSqlSession\#selectOne(java.lang.String, java.lang.Object)
> 
> 6、org.apache.ibatis.session.defaults.DefaultSqlSession\#selectList(java.lang.String, java.lang.Object)
> 
> 7、org.apache.ibatis.session.defaults.DefaultSqlSession\#selectList(java.lang.String, java.lang.Object, org.apache.ibatis.session.RowBounds)
> 
> 8、org.apache.ibatis.executor.CachingExecutor\#query(org.apache.ibatis.mapping.MappedStatement, java.lang.Object, org.apache.ibatis.session.RowBounds, org.apache.ibatis.session.ResultHandler)
> 
> 9、org.apache.ibatis.executor.CachingExecutor\#query(org.apache.ibatis.mapping.MappedStatement, java.lang.Object, org.apache.ibatis.session.RowBounds, org.apache.ibatis.session.ResultHandler, org.apache.ibatis.cache.CacheKey, org.apache.ibatis.mapping.BoundSql)
> 
> 10、org.apache.ibatis.executor.BaseExecutor\#query(org.apache.ibatis.mapping.MappedStatement, java.lang.Object, org.apache.ibatis.session.RowBounds, org.apache.ibatis.session.ResultHandler, org.apache.ibatis.cache.CacheKey, org.apache.ibatis.mapping.BoundSql)
> 
> 11、org.apache.ibatis.executor.BaseExecutor\#queryFromDatabase
> 
> 12、org.apache.ibatis.executor.SimpleExecutor\#doQuery
> 
> 13、org.apache.ibatis.executor.statement.RoutingStatementHandler\#query
> 
> 14、org.apache.ibatis.executor.statement.PreparedStatementHandler\#query
> 
> 15、org.apache.ibatis.executor.resultset.DefaultResultSetHandler\#handleResultSets
> 
> 16、org.apache.ibatis.executor.resultset.DefaultResultSetHandler\#collapseSingleResultList
> 
> 17、org.apache.ibatis.executor.statement.PreparedStatementHandler\#query
> 
> 18、org.apache.ibatis.executor.statement.RoutingStatementHandler\#query
> 
> 19、org.apache.ibatis.executor.SimpleExecutor\#doQuery
> 
> 20、org.apache.ibatis.executor.BaseExecutor\#queryFromDatabase
> 
> 21、org.apache.ibatis.executor.BaseExecutor\#query(org.apache.ibatis.mapping.MappedStatement, java.lang.Object, org.apache.ibatis.session.RowBounds, org.apache.ibatis.session.ResultHandler, org.apache.ibatis.cache.CacheKey, org.apache.ibatis.mapping.BoundSql)

这里面对缓存最后进行处理，继续往回看：

最后带着list回到了selectOne这里，

![db2a5ab40317d063b72d9c31163e36a2.png][]

查询成功以后，返回了第一个对象，下面是代理对象：

最终我们回到了调用的地方，返回了查询的name！

# 总结 #

来总结一下，通过debug看源码是一个不太会看源码的人的一个不错的方法，我们上面通过debug来查看了mybatis查询的整个过程，中间的一级缓存，涉及到的几种查询Executor，获取返回结果的ResultSetHandler，编译的StatementHandler，物理分页的RowBounds等等几个对象是如果对jdbc查询的整个过程进行润色的，查询的整个过程在这个源码分析中是最复杂的，正是由于这个复杂，我们才能轻松的使用mybatis！

[aa54937c5fb45e99dd659a22788d24fa.png]: /images/20221123/1d739007a7f34625b6d66b49ee638795.png
[8ea0171297d87874c13f3ebe05941f52.png]: /images/20221123/5d43f97de2104ce08a2f4223710d617b.png
[d08002c2b091e9e89cd0c0769d7b9620.png]: /images/20221123/0fca2d45f0a2443abf2594b29892c93a.png
[9f0b20e87f675312866ac6b8a758d075.png]: /images/20221123/8b2a2293d6f84f1aab4699c993e6480e.png
[d2a9c96e2c33a5ca58df975e754a79c4.png]: /images/20221123/54506b68eac64321b2e5cbcb2ff35435.png
[3d1eacf093ed5d12b9eb7ef035abdc50.png]: /images/20221123/3259516f82264495acefa4ecff3e9cfc.png
[cf45ec1bdee5b0f5888b0f8abf10d7d4.png]: /images/20221123/630d3652bca544c4916e9dcc30dc90eb.png
[0cd926e29f3a531d0a74c8c77ad19928.png]: /images/20221123/514686467585487aa2ef829392b52ea4.png
[af9e6846a16c43550df163a8f364598f.png]: /images/20221123/865cae4ff0cb4da99a671790f4469248.png
[31f7bb77a976742df174e9c81e7d33fa.png]: /images/20221123/26f4478d84274ac3bf28bb3594a664fa.png
[961594a56717e791a8426793130a8c3b.png]: /images/20221123/1f6c2a96a30543a6a2a79f83ab9db3fb.png
[8e8add3f960736da8b16198b0c5a4c23.png]: /images/20221123/c7fae9bc4c2c412cb79abea73c4c3fe9.png
[a634c7159261ebcad3d893cc824e7f19.png]: /images/20221123/2aec275fb6e647b6a2bff9b570aa9df1.png
[57656b628da8d90ef9520a2a4832ffd4.png]: /images/20221123/a7f19e1e006d42369a8a0a2fd7da2e4d.png
[72b621d43a2809e41e8433a119dcc437.png]: /images/20221123/8fe61c4c7bcb491e906d6ac6822fd78f.png
[a29dbad0e98ecb7219bf9ff44d2b07ee.png]: /images/20221123/44eda193e4a64247b2207b6bc5708aef.png
[3d54409d8713dd2e6dc7e026324efb99.png]: /images/20221123/88b4f7b87f2441f585ffad9be38516e3.png
[e0b7cdd9105c03884c3bf81da209ca8f.png]: /images/20221123/f832f3b9f679472faa3ae30b2e8345cb.png
[5f1dfecb4aa6cbdcff13bacc5fa94b75.png]: /images/20221123/f0c04f39a64f417da31aafc921af69ab.png
[843ba0ff2f87838d7e4f0a826042ff3e.png]: /images/20221123/f862e78b08a143bf9c4deb70d7894fe2.png
[150cbd3e38cc1e26b37526ac5f0d0e90.png]: /images/20221123/6df5cdb4ba1e4b3ab4e1028a8f1624a2.png
[947ac1315552de70ea83a2e306cee8c0.png]: /images/20221123/cbf438e3469f4181b5e7a29b2f8fda34.png
[436f95caa0fe905d7a71eb2617bea598.png]: /images/20221123/69d14cb0ad6e42909dcc9a64cf708719.png
[22133a227cbd2c5dff5fec578341a9a9.png]: /images/20221123/b599ed402c9446d09d35e1dc58ea4473.png
[e59d64eb8b5db5e45812c95e0d1942e7.png]: /images/20221123/793be5608616470fbd7d1cc3af99523f.png
[dd0da27c0d3f099da1a6ea0c4e1d1f25.png]: /images/20221123/8e18931df36140309a97e217ed944a32.png
[ae1cc1cb6d0df4c954b0ae3b1ee55a8d.png]: /images/20221123/37402ed312124f96a486f2d9b600ad15.png
[db2a5ab40317d063b72d9c31163e36a2.png]: /images/20221123/797a70e9a43a4defab5dc595c0297e16.png