先来看一下MyBatis 的编程式使用的方法:html
public void testMapper() throws IOException { String resource = "mybatis-config.xml"; InputStream inputStream = Resources.getResourceAsStream(resource); SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream); SqlSession session = sqlSessionFactory.openSession(); try { BlogMapper mapper = session.getMapper(BlogMapper.class); Blog blog = mapper.selectBlogById(1); System.out.println(blog); } finally { session.close(); } }
咱们再来捋MyBatis 的主要工做流程:首先在MyBatis 启动的时候咱们要去解析配置文件,包括全局配置文件和映射器配置文件,这里面包含了咱们怎么控制MyBatis 的行为,和咱们要对数据库下达的指令,也就是咱们的SQL 信息。咱们会把它们解析成一个Configuration 对象。接下来就是咱们操做数据库的接口,它在应用程序和数据库中间,表明咱们跟数据库之间的一次链接:这个就是SqlSession 对象。咱们要得到一个会话, 必须有一个会话工厂SqlSessionFactory 。SqlSessionFactory 里面又必须包含咱们的全部的配置信息,因此咱们会经过一个Builder 来建立工厂类。sql
咱们知道,MyBatis 是对JDBC 的封装,也就是意味着底层必定会出现JDBC 的一些核心对象,好比执行SQL 的Statement,结果集ResultSet。在Mybatis 里面,SqlSession 只是提供给应用的一个接口,还不是SQL 的真正的执行对象。咱们经过查看SqlSession源码发现,SqlSession 持有了一个Executor 对象,用来封装对数据库的操做。在执行器Executor 执行query 或者update 操做的时候咱们建立一系列的对象,来处理参数、执行SQL、处理结果集,这里咱们把它简化成一个对象:StatementHandler,这个就是MyBatis 主要的工做流程,如图:数据库
在MyBatis 的主要工做流程里面,不一样的功能是由不少不一样的类协做完成的,它们分布在MyBatis jar 包的不一样的package 里面。咱们来看一下MyBatis 的jar 包(基于3.5.1)编程
跟Spring 同样,MyBatis 按照功能职责的不一样,全部的package 能够分红不一样的工做层次。咱们能够把MyBatis 的工做流程类比成餐厅的服务流程。缓存
第一个是跟客户打交道的服务员,它是用来接收程序的工做指令的,咱们把它叫作接口层。session
第二个是后台的厨师,他们根据客户的点菜单,把原材料加工成成品,而后传到窗口。这一层是真正去操做数据的,咱们把它叫作核心层。mybatis
最后就是餐厅也须要有人作后勤(好比清洁、采购、财务),来支持厨师的工做和整个餐厅的运营。咱们把它叫作基础层。架构
来看一下这张图,咱们根据刚才的分层,和大致的执行流程,作了这么一个总结。固然,从不一样的角度来描述,架构图的划分有所区别,这张图画起来也有不少形式。咱们先从整体上创建一个印象。app
首先接口层是咱们打交道最多的。核心对象是SqlSession,它是上层应用和MyBatis打交道的桥梁,SqlSession 上定义了很是多的对数据库的操做方法。接口层在接收到调用请求的时候,会调用核心处理层的相应模块来完成具体的数据库操做。ide
接下来是核心处理层。既然叫核心处理层,也就是跟数据库操做相关的动做都是在这一层完成的。核心处理层主要作了这几件事:
插件也属于核心层,这是由它的工做方式和拦截的对象决定的。
最后一个就是基础支持层。基础支持层主要是一些抽取出来的通用的功能(实现复用),用来支持核心处理层的功能。好比数据源、缓存(请点击跳转至缓存详解)、日志、xml 解析、反射、IO、事务等等这些功能。
这个就是MyBatis 的主要工做流程和架构分层。
从以上的编程式的例子来看,mybatis的工做流程大体能够分为一下四步:
定位资源位置,加载资源,将xml加载成流这里就不分析了。
String resource = "mybatis-config.xml"; InputStream inputStream = Resources.getResourceAsStream(resource);
首先咱们要清楚的是配置解析的过程所有只解析了两种文件。一个是mybatis-config.xml 全局配置文件。另外就是可能有不少个的Mapper.xml 文件,也包括在Mapper 接口类上面定义的注解。咱们从mybatis-config.xml 开始。在以前已经分析了核心配置了,大概明白了MyBatis 有哪些配置项,和这些配置项的大体含义。这里咱们再具体看一下这里面的标签都是怎么解析的,解析的时候作了什么。
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
首先咱们new 了一个SqlSessionFactoryBuilder,很是明显的建造者模式,它里面定义了不少个build 方法的重载,最终返回的是一个SqlSessionFactory 对象(单例模式)。咱们点进去build 方法。这里面建立了一个XMLConfigBuilder 对象(Configuration 对象也是这个时候建立的)。
public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) { SqlSessionFactory var5; try {
// 建立全局文件解析器 XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
// 调用解析,解析完构建默认的SessionFactory var5 = this.build(parser.parse()); } catch (Exception var14) { throw ExceptionFactory.wrapException("Error building SqlSession.", var14); } finally { ErrorContext.instance().reset(); try { inputStream.close(); } catch (IOException var13) { } } return var5; }
XMLConfigBuilder 是抽象类BaseBuilder 的一个子类,专门用来解析全局配置文件,针对不一样的构建目标还有其余的一些子类,好比:XMLMapperBuilder:解析Mapper 映射器,XMLStatementBuilder:解析增删改查标签。
根据咱们解析的文件流,这里后面两个参数都是空的,建立了一个parser。这里有两步,第一步是调用parser 的parse()方法,它会返回一个Configuration类。也就是配置文件里面全部的信息都会放在Configuration 里面。Configuration 类里面有不少的属性,有不少是跟config 里面的标签直接对应的。
public Configuration parse() {
// 判断是否已经解析过 if (this.parsed) { throw new BuilderException("Each XMLConfigBuilder can only be used once."); } else { this.parsed = true;
// 解析的开始 this.parseConfiguration(this.parser.evalNode("/configuration")); return this.configuration; } }
首先会检查是否是已经解析过,也就是说在应用的生命周期里面,config 配置文件只须要解析一次,生成的Configuration 对象也会存在应用的整个生命周期中。接下来就是parseConfiguration 方法:
这下面有十几个方法,对应着config 文件里面的全部一级标签。MyBatis 全局配置文件的顺序不能够颠倒。
private void parseConfiguration(XNode root) { try { this.propertiesElement(root.evalNode("properties")); Properties settings = this.settingsAsProperties(root.evalNode("settings")); this.loadCustomVfs(settings); this.loadCustomLogImpl(settings); this.typeAliasesElement(root.evalNode("typeAliases")); this.pluginElement(root.evalNode("plugins")); this.objectFactoryElement(root.evalNode("objectFactory")); this.objectWrapperFactoryElement(root.evalNode("objectWrapperFactory")); this.reflectorFactoryElement(root.evalNode("reflectorFactory"));
//解析settings标签 this.settingsElement(settings); this.environmentsElement(root.evalNode("environments")); this.databaseIdProviderElement(root.evalNode("databaseIdProvider")); this.typeHandlerElement(root.evalNode("typeHandlers")); this.mapperElement(root.evalNode("mappers")); } catch (Exception var3) { throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + var3, var3); } }
在settings标签的解析中,咱们就能够看到对应官网上介绍的各类配置,及其默认值,全部的值,都会赋值到Configuration 的属性里面去。简单的来看一下:
private void settingsElement(Properties props) { this.configuration.setAutoMappingBehavior(AutoMappingBehavior.valueOf(props.getProperty("autoMappingBehavior", "PARTIAL"))); this.configuration.setAutoMappingUnknownColumnBehavior(AutoMappingUnknownColumnBehavior.valueOf(props.getProperty("autoMappingUnknownColumnBehavior", "NONE"))); this.configuration.setCacheEnabled(this.booleanValueOf(props.getProperty("cacheEnabled"), true));//二级缓存 this.configuration.setProxyFactory((ProxyFactory)this.createInstance(props.getProperty("proxyFactory"))); this.configuration.setLazyLoadingEnabled(this.booleanValueOf(props.getProperty("lazyLoadingEnabled"), false)); this.configuration.setAggressiveLazyLoading(this.booleanValueOf(props.getProperty("aggressiveLazyLoading"), false)); this.configuration.setMultipleResultSetsEnabled(this.booleanValueOf(props.getProperty("multipleResultSetsEnabled"), true)); this.configuration.setUseColumnLabel(this.booleanValueOf(props.getProperty("useColumnLabel"), true)); this.configuration.setUseGeneratedKeys(this.booleanValueOf(props.getProperty("useGeneratedKeys"), false)); this.configuration.setDefaultExecutorType(ExecutorType.valueOf(props.getProperty("defaultExecutorType", "SIMPLE")));//默认执行器类型 this.configuration.setDefaultStatementTimeout(this.integerValueOf(props.getProperty("defaultStatementTimeout"), (Integer)null)); this.configuration.setDefaultFetchSize(this.integerValueOf(props.getProperty("defaultFetchSize"), (Integer)null)); this.configuration.setMapUnderscoreToCamelCase(this.booleanValueOf(props.getProperty("mapUnderscoreToCamelCase"), false)); this.configuration.setSafeRowBoundsEnabled(this.booleanValueOf(props.getProperty("safeRowBoundsEnabled"), false)); this.configuration.setLocalCacheScope(LocalCacheScope.valueOf(props.getProperty("localCacheScope", "SESSION")));//本地缓存级别 this.configuration.setJdbcTypeForNull(JdbcType.valueOf(props.getProperty("jdbcTypeForNull", "OTHER"))); this.configuration.setLazyLoadTriggerMethods(this.stringSetValueOf(props.getProperty("lazyLoadTriggerMethods"), "equals,clone,hashCode,toString")); this.configuration.setSafeResultHandlerEnabled(this.booleanValueOf(props.getProperty("safeResultHandlerEnabled"), true)); this.configuration.setDefaultScriptingLanguage(this.resolveClass(props.getProperty("defaultScriptingLanguage"))); this.configuration.setDefaultEnumTypeHandler(this.resolveClass(props.getProperty("defaultEnumTypeHandler"))); this.configuration.setCallSettersOnNulls(this.booleanValueOf(props.getProperty("callSettersOnNulls"), false)); this.configuration.setUseActualParamName(this.booleanValueOf(props.getProperty("useActualParamName"), true)); this.configuration.setReturnInstanceForEmptyRow(this.booleanValueOf(props.getProperty("returnInstanceForEmptyRow"), false)); this.configuration.setLogPrefix(props.getProperty("logPrefix")); this.configuration.setConfigurationFactory(this.resolveClass(props.getProperty("configurationFactory"))); }
最后就是<mappers>标签的解析,对应匹配以下四种方式:
<!-- 使用相对于类路径的资源引用 --> <mappers> <mapper resource="org/mybatis/builder/AuthorMapper.xml"/> <mapper resource="org/mybatis/builder/BlogMapper.xml"/> <mapper resource="org/mybatis/builder/PostMapper.xml"/> </mappers> <!-- 使用彻底限定资源定位符(URL) --> <mappers> <mapper url="file:///var/mappers/AuthorMapper.xml"/> <mapper url="file:///var/mappers/BlogMapper.xml"/> <mapper url="file:///var/mappers/PostMapper.xml"/> </mappers> <!-- 将包内的映射器接口实现所有注册为映射器 --> <mappers> <package name="org.mybatis.builder"/> </mappers>
<!-- 使用映射器接口实现类的彻底限定类名 -->
<mappers>
<mapper class="org.mybatis.builder.AuthorMapper"/>
<mapper class="org.mybatis.builder.BlogMapper"/>
<mapper class="org.mybatis.builder.PostMapper"/>
</mappers>
首先会判断是否是接口,只有接口才解析;而后判断是否是已经注册了,单个Mapper重复注册会抛出异常。若是是以资源位置及URL的配置方式,还须要建立Mapper解析器解析。
private void mapperElement(XNode parent) throws Exception { if (parent != null) { Iterator var2 = parent.getChildren().iterator(); while(true) { while(var2.hasNext()) { XNode child = (XNode)var2.next(); String resource;
//配置包的方式 if ("package".equals(child.getName())) { resource = child.getStringAttribute("name");
//解析完加入全局配置类,填充属性 this.configuration.addMappers(resource); } else { resource = child.getStringAttribute("resource"); String url = child.getStringAttribute("url"); String mapperClass = child.getStringAttribute("class"); XMLMapperBuilder mapperParser; InputStream inputStream;
//配置以资源的方式 if (resource != null && url == null && mapperClass == null) { ErrorContext.instance().resource(resource); inputStream = Resources.getResourceAsStream(resource); mapperParser = new XMLMapperBuilder(inputStream, this.configuration, resource, this.configuration.getSqlFragments()); mapperParser.parse();
//配置以URL的方式 } else if (resource == null && url != null && mapperClass == null) { ErrorContext.instance().resource(url); inputStream = Resources.getUrlAsStream(url); mapperParser = new XMLMapperBuilder(inputStream, this.configuration, url, this.configuration.getSqlFragments()); mapperParser.parse();
// 配置以class单个接口 方式 } else {//都没配置报异常 if (resource != null || url != null || mapperClass == null) { throw new BuilderException("A mapper element may only specify a url, resource or class, but not more than one."); } Class<?> mapperInterface = Resources.classForName(mapperClass); this.configuration.addMapper(mapperInterface); } } } return; } } }
XMLMapperBuilder.parse()方法,是对Mapper 映射器的解析。里面有两个方法:configurationElement()—— 解析全部的子标签, 其中 buildStatementFromContext()最终得到MappedStatement 对象。bindMapperForNamespace()——把namespace(接口类型)和工厂类绑定起来。
不管是按package 扫描,仍是按接口扫描,最后都会调用到MapperRegistry 的addMapper()方法。最后,MapperRegistry 也会放到Configuration 里面去。MapperRegistry 里面维护的实际上是一个Map 容器,存储接口和代理工厂的映射关系。
public <T> void addMapper(Class<T> type) { if (type.isInterface()) {//判断是否接口 if (this.hasMapper(type)) { //是否已经注册 throw new BindingException("Type " + type + " is already known to the MapperRegistry."); } boolean loadCompleted = false; try {//利用Map来维护mapper this.knownMappers.put(type, new MapperProxyFactory(type)); MapperAnnotationBuilder parser = new MapperAnnotationBuilder(this.config, type); parser.parse();//解析 loadCompleted = true; } finally { if (!loadCompleted) {//注册过程出现异常,移除 this.knownMappers.remove(type); } } } }
除了映射器文件,在这里也会去解析Mapper 接口方法上的注解。在addMapper()方法里面建立了一个MapperAnnotationBuilder,咱们点进去看一下parse()方法。parseCache() 和parseCacheRef() 方法实际上是对@CacheNamespace 和@CacheNamespaceRef 这两个注解的处理。parseStatement()方法里面的各类getAnnotation(),都是对注解的解析,好比@Options,@SelectKey,@ResultMap 等等。最后一样会解析成MappedStatement 对象,也就是说在XML 中配置,和使用注解配置,最后起到同样的效果。
public void parse() { String resource = this.type.toString(); if (!this.configuration.isResourceLoaded(resource)) { this.loadXmlResource();//加载XML资源 this.configuration.addLoadedResource(resource); this.assistant.setCurrentNamespace(this.type.getName()); this.parseCache();//解析@CacheNamespace注解 this.parseCacheRef();//解析@CacheNamespaceRef注解 Method[] methods = this.type.getMethods(); Method[] var3 = methods; int var4 = methods.length; for(int var5 = 0; var5 < var4; ++var5) { Method method = var3[var5]; try { if (!method.isBridge()) { this.parseStatement(method);//处理各类注解 } } catch (IncompleteElementException var8) { this.configuration.addIncompleteMethod(new MethodResolver(this, method)); } } } this.parsePendingMethods(); }
最后会将这些解析的结果填充倒Configuration中。在这一步,咱们主要完成了config 配置文件、Mapper 文件、Mapper 接口上的注解的解析。咱们获得了一个最重要的对象Configuration,这里面存放了所有的配置信息,它在属性里面还有各类各样的容器。最后,返回了一个DefaultSqlSessionFactory,里面持有了Configuration 的实例。以下是第一阶段的时序图:
这是第二步, 咱们跟数据库的每一次链接, 都须要建立一个会话, 咱们用openSession()方法来建立。
SqlSession session = sqlSessionFactory.openSession();
private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level, boolean autoCommit) {
Transaction tx = null;
DefaultSqlSession var8;
try {
//从先前所解析的配置中获取环境
Environment environment = this.configuration.getEnvironment();
//获取事务工厂类
TransactionFactory transactionFactory = this.getTransactionFactoryFromEnvironment(environment);
//建立事务
tx = transactionFactory.newTransaction(environment.getDataSource(), level, autoCommit);
//建立执行器类 默认SIMPLE
Executor executor = this.configuration.newExecutor(tx, execType);
//建立默认的SqlSession
var8 = new DefaultSqlSession(this.configuration, executor, autoCommit);
} catch (Exception var12) {
this.closeTransaction(tx);
throw ExceptionFactory.wrapException("Error opening session. Cause: " + var12, var12);
} finally {
ErrorContext.instance().reset();
}
return var8;
}
这个会话里面,须要包含一个Executor 用来执行SQL。Executor 又要指定事务类型和执行器的类型。因此咱们会先从Configuration 里面拿到Enviroment,Enviroment 里面就有事务工厂。建立事务会有如下两种选择:
若是配置的是JDBC,则会使用Connection 对象的commit()、rollback()、close()管理事务。若是配置成MANAGED,会把事务交给容器来管理,好比JBOSS,Weblogic。若是是Spring + MyBatis , 则没有必要配置, 由于咱们会直接在applicationContext.xml 里面配置数据源和事务管理器,覆盖MyBatis 的配置。
咱们知道,Executor 的基本类型有三种:SIMPLE、BATCH、REUSE,默认是SIMPLE(settingsElement()读取默认值),他们都继承了抽象类BaseExecutor。
public Executor newExecutor(Transaction transaction, ExecutorType executorType) {
//判断使用的执行器类型,之因此判断两次是防止手贱的人把执行器配置为空 executorType = executorType == null ? this.defaultExecutorType : executorType; executorType = executorType == null ? ExecutorType.SIMPLE : executorType; Object executor; if (ExecutorType.BATCH == executorType) { executor = new BatchExecutor(this, transaction); } else if (ExecutorType.REUSE == executorType) { executor = new ReuseExecutor(this, transaction); } else { executor = new SimpleExecutor(this, transaction); } if (this.cacheEnabled) {//是否启用二级缓存,启用了进行包装 executor = new CachingExecutor((Executor)executor); }
//插件包装,转换成拦截器链interceptorChain,对于插件我下一篇博客会详细介绍 Executor executor = (Executor)this.interceptorChain.pluginAll(executor); return executor; }
若是配置了cacheEnabled=ture,会用装饰器模式对executor 进行包装:newCachingExecutor(executor)。最终返回DefaultSqlSession,属性包括Configuration、Executor 对象。
总结:建立会话的过程,咱们得到了一个DefaultSqlSession,里面包含了一个Executor,它是SQL 的执行者。
如今咱们已经有一个DefaultSqlSession 了,必须找到Mapper.xml 里面定义的Statement ID,才能执行对应的SQL 语句。找到Statement ID 有两种方式:一种是直接调用session 的方法,在参数里面传入Statement ID,这种方式属于硬编码,咱们没办法知道有多少处调用,修改起来也很麻烦。另外一个问题是若是参数传入错误,在编译阶段也是不会报错的,不利于预先发现问题。
Blog blog = (Blog) session.selectOne("com.wuzz.mapper.BlogMapper.selectBlogById", 1);
因此在MyBatis 后期的版本提供了第二种方式,就是定义一个接口,而后再调用Mapper 接口的方法。因为咱们的接口名称跟Mapper.xml 的namespace 是对应的,接口的方法跟statement ID 也都是对应的,因此根据方法就能找到对应的要执行的SQL。
BlogMapper mapper = session.getMapper(BlogMapper.class);
在这里咱们主要研究一下Mapper 对象是怎么得到的,它的本质是什么。DefaultSqlSession 的getMapper()方法,调用了Configuration 的getMapper()方法。继而调到 MapperRegistry.getMapper:
public <T> T getMapper(Class<T> type, SqlSession sqlSession) { return this.mapperRegistry.getMapper(type, sqlSession); } public <T> T getMapper(Class<T> type, SqlSession sqlSession) { MapperProxyFactory<T> mapperProxyFactory = (MapperProxyFactory)this.knownMappers.get(type); if (mapperProxyFactory == null) { throw new BindingException("Type " + type + " is not known to the MapperRegistry."); } else { try { return mapperProxyFactory.newInstance(sqlSession); } catch (Exception var5) { throw new BindingException("Error getting mapper instance. Cause: " + var5, var5); } } }
咱们知道,在解析mapper 标签和Mapper.xml 的时候已经把接口类型和类型对应的MapperProxyFactory 放到了一个Map 中。获取Mapper 代理对象,其实是从Map 中获取对应的工厂类后,最终经过代理模式返回代理对象。
那么JDK 动态代理和MyBatis 用到的JDK 动态代理有什么区别呢?JDK 动态代理代理,在实现了InvocationHandler 的代理类里面,须要传入一个被代理对象的实现类。而在mybatis里面,咱们并无实现了InvocationHandler 的代理类。不须要实现类的缘由:咱们只须要根据接口类型+方法的名称,就能够找到Statement ID 了,而惟一要作的一件事情也是这件,因此不须要实现类。在MapperProxy里面直接执行逻辑(也就是执行SQL)就能够。
得到Mapper 对象的过程,实质上是获取了一个MapperProxy 的代理对象。MapperProxy 中有sqlSession、mapperInterface、methodCache。
因为全部的Mapper 都是MapperProxy 代理对象,因此任意的方法都是执行MapperProxy 的invoke()方法。
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { try {//首先判断是否须要去执行SQL,仍是直接执行方法。 if (Object.class.equals(method.getDeclaringClass())) { return method.invoke(this, args); } //Object 自己的方法和Java 8 中接口的默认方法不须要去执行SQL。 if (this.isDefaultMethod(method)) { return this.invokeDefaultMethod(proxy, method, args); } } catch (Throwable var5) { throw ExceptionUtil.unwrapThrowable(var5); } //获取缓存 这里加入缓存是为了提高MapperMethod 的获取速度 MapperMethod mapperMethod = this.cachedMapperMethod(method); return mapperMethod.execute(this.sqlSession, args); }
接下来又调用了mapperMethod 的execute 方法,咱们debug来看一下:
MapperMethod 里面主要有两个属性, 一个是SqlCommand (SQL命令), 一个是MethodSignature(方法签名),这两个都是MapperMethod 的内部类。另外定义了多个execute()方法。
public Object execute(SqlSession sqlSession, Object[] args) { Object result; Object param;//根据不一样的type 和返回类型 调用sqlSession 的insert()、update()、delete()、selectOne ()方法 switch(this.command.getType()) { case INSERT:
// 调用convertArgsToSqlCommandParam()将参数转换为SQL 的参数。 param = this.method.convertArgsToSqlCommandParam(args); result = this.rowCountResult(sqlSession.insert(this.command.getName(), param)); break; case UPDATE: param = this.method.convertArgsToSqlCommandParam(args); result = this.rowCountResult(sqlSession.update(this.command.getName(), param)); break; case DELETE: param = this.method.convertArgsToSqlCommandParam(args); result = this.rowCountResult(sqlSession.delete(this.command.getName(), param)); break; case SELECT://查询的方法又要根据返回类型进行区分执行 if (this.method.returnsVoid() && this.method.hasResultHandler()) { this.executeWithResultHandler(sqlSession, args); result = null; } else if (this.method.returnsMany()) { result = this.executeForMany(sqlSession, args); } else if (this.method.returnsMap()) { result = this.executeForMap(sqlSession, args); } else if (this.method.returnsCursor()) { result = this.executeForCursor(sqlSession, args); } else { param = this.method.convertArgsToSqlCommandParam(args); result = sqlSession.selectOne(this.command.getName(), param); if (this.method.returnsOptional() && (result == null || !this.method.getReturnType().equals(result.getClass()))) { result = Optional.ofNullable(result); } } break; case FLUSH://刷新statement result = sqlSession.flushStatements(); break; default: throw new BindingException("Unknown execution method for: " + this.command.getName()); } if (result == null && this.method.getReturnType().isPrimitive() && !this.method.returnsVoid()) { throw new BindingException("Mapper method '" + this.command.getName() + " attempted to return null from a method with a primitive return type (" + this.method.getReturnType() + ")."); } else { return result; } }
咱们以查询 (mapper1.selectBlogById(1002)) 为例 会走以下代码,会走到selectOne()方法。
public <T> T selectOne(String statement, Object parameter) { List<T> list = this.selectList(statement, parameter); if (list.size() == 1) { return list.get(0); } else if (list.size() > 1) { throw new TooManyResultsException("Expected one result (or null) to be returned by selectOne(), but found: " + list.size()); } else { return null; } }
这里抛得异常是否是很熟悉,常常有小伙伴在开发过程当中会发现sql执行报这个异常,是由于定义的sql是查询的一个结果,但是返回了多个,这里会执行selectList(statement, parameter):
public <E> List<E> selectList(String statement, Object parameter, RowBounds rowBounds) { List var5; try {//获取初始化阶段所封装的对象先根据command name(Statement ID)从Configuration中拿到MappedStatement MappedStatement ms = this.configuration.getMappedStatement(statement); var5 = this.executor.query(ms, this.wrapCollection(parameter), rowBounds, Executor.NO_RESULT_HANDLER); } catch (Exception var9) { throw ExceptionFactory.wrapException("Error querying database. Cause: " + var9, var9); } finally { ErrorContext.instance().reset(); } return var5; }
这个ms 上面有咱们在xml 中配置的全部属性,包括id、statementType、sqlSource、useCache、入参、出参等等。
而后执行了Executor 的query()方法。前面咱们说到了Executor 有三种基本类型,SIMPLE/REUSE/BATCH,还有一种包装类型,CachingExecutor。那么在这里到底会选择哪种执行器呢?咱们要回过头去看看DefaultSqlSession 在初始化的时候是怎么赋值的,这个就是咱们的会话建立过程。若是启用了二级缓存,就会先调用CachingExecutor 的query()方法,里面有缓存相关的操做,而后才是再调用基本类型的执行器,好比默认的SimpleExecutor。在没有开启二级缓存的状况下,先会走到BaseExecutor 的query()方法(不然会先走到CachingExecutor)。
BaseExecutor:
public <E> List<E> query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler) throws SQLException { BoundSql boundSql = ms.getBoundSql(parameter); CacheKey key = this.createCacheKey(ms, parameter, rowBounds, boundSql); return this.query(ms, parameter, rowBounds, resultHandler, key, boundSql); }
从Configuration 中获取MappedStatement, 而后从BoundSql 中获取SQL 信息,建立CacheKey。这个CacheKey 就是缓存的Key。而后再调用另外一个query()方法。
public <E> List<E> query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql) throws SQLException { ErrorContext.instance().resource(ms.getResource()).activity("executing a query").object(ms.getId()); if (this.closed) { throw new ExecutorException("Executor was closed."); } else {//queryStack 用于记录查询栈,防止递归查询重复处理缓存。flushCache=true 的时候,会先清理本地缓存(一级缓存) if (this.queryStack == 0 && ms.isFlushCacheRequired()) {
//清除缓存 this.clearLocalCache(); } List list; try { ++this.queryStack; list = resultHandler == null ? (List)this.localCache.getObject(key) : null; if (list != null) {//从缓存中获取数据 this.handleLocallyCachedOutputParameters(ms, key, parameter, boundSql); } else {//若是没有缓存,会从数据库查询:queryFromDatabase() list = this.queryFromDatabase(ms, parameter, rowBounds, resultHandler, key, boundSql); } } finally { --this.queryStack; } if (this.queryStack == 0) { Iterator var8 = this.deferredLoads.iterator(); while(var8.hasNext()) { BaseExecutor.DeferredLoad deferredLoad = (BaseExecutor.DeferredLoad)var8.next(); deferredLoad.load(); } this.deferredLoads.clear();
//若是LocalCacheScope == STATEMENT,会清理本地缓存。 if (this.configuration.getLocalCacheScope() == LocalCacheScope.STATEMENT) { this.clearLocalCache(); } } return list; } }
从数据库查询(queryFromDatabase):
private <E> List<E> queryFromDatabase(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql) throws SQLException {
// 先在缓存用占位符占位。执行查询后,移除占位符,放入数据。 this.localCache.putObject(key, ExecutionPlaceholder.EXECUTION_PLACEHOLDER); List list; try {//执行Executor 的doQuery();默认是SimpleExecutor。 list = this.doQuery(ms, parameter, rowBounds, resultHandler, boundSql); } finally { this.localCache.removeObject(key); } this.localCache.putObject(key, list); if (ms.getStatementType() == StatementType.CALLABLE) { this.localOutputParameterCache.putObject(key, parameter); } return list; }
SimpleExecutor.doQuery(ms, parameter, rowBounds, resultHandler, boundSql);
public <E> List<E> doQuery(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException { Statement stmt = null; List var9; try { Configuration configuration = ms.getConfiguration(); StatementHandler handler = configuration.newStatementHandler(this.wrapper, ms, parameter, rowBounds, resultHandler, boundSql); stmt = this.prepareStatement(handler, ms.getStatementLog()); var9 = handler.query(stmt, resultHandler); } finally { this.closeStatement(stmt); } return var9; }
在configuration.newStatementHandler()中,new 一个StatementHandler,先获得RoutingStatementHandler。RoutingStatementHandler 里面没有任何的实现, 是用来建立基本的StatementHandler 的。这里会根据MappedStatement 里面的statementType 决定StatementHandler 的类型。默认是PREPARED ( STATEMENT 、PREPARED 、CALLABLE)。
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 里面包含了处理参数的ParameterHandler 和处理结果集的ResultSetHandler。这两个对象都是在上面new 的时候建立的。
this.parameterHandler = this.configuration.newParameterHandler(mappedStatement, parameterObject, boundSql);
this.resultSetHandler = this.configuration.newResultSetHandler(executor, mappedStatement, rowBounds, this.parameterHandler, resultHandler, boundSql);
这三个对象都是能够被插件拦截的四大对象之一,因此在建立以后都要用拦截器进行包装的方法。(对于详细的插件机制将在下篇博客中详细介绍)
StatementHandler statementHandler = (StatementHandler)this.interceptorChain.pluginAll(statementHandler); parameterHandler = (ParameterHandler)this.interceptorChain.pluginAll(parameterHandler); ResultSetHandler resultSetHandler = (ResultSetHandler)this.interceptorChain.pluginAll(resultSetHandler);
四大对象还有一个是谁?在何时建立的?(Executor)在第二步建立会话的时候建立的。用new 出来的StatementHandler 建立Statement 对象——prepareStatement()方法对语句进行预编译,处理参数。执行的StatementHandler 的query()方法,RoutingStatementHandler 的query()方法。
delegate 委派,最终执行PreparedStatementHandler 的query()方法。
public <E> List<E> query(Statement statement, ResultHandler resultHandler) throws SQLException { PreparedStatement ps = (PreparedStatement)statement; ps.execute(); return this.resultSetHandler.handleResultSets(ps); }
执行PreparedStatement 的execute()方法,后面就是JDBC 包中的PreparedStatement 的执行了。
最后经过 resultSetHandler.handleResultSets(ps) 处理结果集。
最后总结一下整个源码的过程所涉及的核心类: