通過源碼分析MyBatis的緩存

MyBatis緩存介紹

MyBatis支持聲明式數(shù)據(jù)緩存(declarative data caching)。當(dāng)一條SQL語句被標(biāo)記為“可緩存”后,首次執(zhí)行它時從數(shù)據(jù)庫獲取的所有數(shù)據(jù)會被存儲在一段高速緩存中,今后執(zhí)行這條語句時就會從高速緩存中讀取結(jié)果,而不是再次命中數(shù)據(jù)庫。MyBatis提供了默認(rèn)下基于Java HashMap的緩存實現(xiàn),以及用于與OSCache、Ehcache、Hazelcast和Memcached連接的默認(rèn)連接器。MyBatis還提供API供其他緩存實現(xiàn)使用。

重點的那句話就是:MyBatis執(zhí)行SQL語句之后,這條語句就是被緩存,以后再執(zhí)行這條語句的時候,會直接從緩存中拿結(jié)果,而不是再次執(zhí)行SQL

這也就是大家常說的MyBatis一級緩存,一級緩存的作用域scope是SqlSession。

MyBatis同時還提供了一種全局作用域global scope的緩存,這也叫做二級緩存,也稱作全局緩存。

一級緩存

測試

同個session進行兩次相同查詢:

@Test

public void test() {

????SqlSession sqlSession = sqlSessionFactory.openSession();

????try {

????????User user = (User)sqlSession.selectOne("org.format.mybatis.cache.UserMapper.getById", 1);

????????log.debug(user);

????????User user2 = (User)sqlSession.selectOne("org.format.mybatis.cache.UserMapper.getById", 1);

????????log.debug(user2);

????} finally {

????????sqlSession.close();

????}

}

MyBatis只進行1次數(shù)據(jù)庫查詢:

==>? Preparing: select * from USERS WHERE ID = ?

==> Parameters: 1(Integer)

<==????? Total: 1

User{id=1, name='format', age=23, birthday=Sun Oct 12 23:20:13 CST 2014}

User{id=1, name='format', age=23, birthday=Sun Oct 12 23:20:13 CST 2014}

同個session進行兩次不同的查詢:

@Test

public void test() {

????SqlSession sqlSession = sqlSessionFactory.openSession();

????try {

????????User user = (User)sqlSession.selectOne("org.format.mybatis.cache.UserMapper.getById", 1);

????????log.debug(user);

????????User user2 = (User)sqlSession.selectOne("org.format.mybatis.cache.UserMapper.getById", 2);

????????log.debug(user2);

????} finally {

????????sqlSession.close();

????}

}

MyBatis進行兩次數(shù)據(jù)庫查詢:

==>? Preparing: select * from USERS WHERE ID = ?

==> Parameters: 1(Integer)

<==????? Total: 1

User{id=1, name='format', age=23, birthday=Sun Oct 12 23:20:13 CST 2014}

==>? Preparing: select * from USERS WHERE ID = ?

==> Parameters: 2(Integer)

<==????? Total: 1

User{id=2, name='FFF', age=50, birthday=Sat Dec 06 17:12:01 CST 2014}

不同session,進行相同查詢:

@Test

public void test() {

????SqlSession sqlSession = sqlSessionFactory.openSession();

????SqlSession sqlSession2 = sqlSessionFactory.openSession();

????try {

????????User user = (User)sqlSession.selectOne("org.format.mybatis.cache.UserMapper.getById", 1);

????????log.debug(user);

????????User user2 = (User)sqlSession2.selectOne("org.format.mybatis.cache.UserMapper.getById", 1);

????????log.debug(user2);

????} finally {

????????sqlSession.close();

????????sqlSession2.close();

????}

}

MyBatis進行了兩次數(shù)據(jù)庫查詢:

==>? Preparing: select * from USERS WHERE ID = ?

==> Parameters: 1(Integer)

<==????? Total: 1

User{id=1, name='format', age=23, birthday=Sun Oct 12 23:20:13 CST 2014}

==>? Preparing: select * from USERS WHERE ID = ?

==> Parameters: 1(Integer)

<==????? Total: 1

User{id=1, name='format', age=23, birthday=Sun Oct 12 23:20:13 CST 2014}

同個session,查詢之后更新數(shù)據(jù),再次查詢相同的語句:

@Test

public void test() {

????SqlSession sqlSession = sqlSessionFactory.openSession();

????try {

????????User user = (User)sqlSession.selectOne("org.format.mybatis.cache.UserMapper.getById", 1);

????????log.debug(user);

????????user.setAge(100);

????????sqlSession.update("org.format.mybatis.cache.UserMapper.update", user);

????????User user2 = (User)sqlSession.selectOne("org.format.mybatis.cache.UserMapper.getById", 1);

????????log.debug(user2);

????????sqlSession.commit();

????} finally {

????????sqlSession.close();

????}

}

更新操作之后緩存會被清除:

==>? Preparing: select * from USERS WHERE ID = ?

==> Parameters: 1(Integer)

<==????? Total: 1

User{id=1, name='format', age=23, birthday=Sun Oct 12 23:20:13 CST 2014}

==>? Preparing: update USERS SET NAME = ? , AGE = ? , BIRTHDAY = ? where ID = ?

==> Parameters: format(String), 23(Integer), 2014-10-12 23:20:13.0(Timestamp), 1(Integer)

<==??? Updates: 1

==>? Preparing: select * from USERS WHERE ID = ?

==> Parameters: 1(Integer)

<==????? Total: 1

User{id=1, name='format', age=23, birthday=Sun Oct 12 23:20:13 CST 2014}

很明顯,結(jié)果驗證了一級緩存的概念,在同個SqlSession中,查詢語句相同的sql會被緩存,但是一旦執(zhí)行新增或更新或刪除操作,緩存就會被清除

源碼分析

在分析MyBatis的一級緩存之前,我們先簡單看下MyBatis中幾個重要的類和接口:

org.apache.ibatis.session.Configuration類:MyBatis全局配置信息類

org.apache.ibatis.session.SqlSessionFactory接口:操作SqlSession的工廠接口,具體的實現(xiàn)類是DefaultSqlSessionFactory

org.apache.ibatis.session.SqlSession接口:執(zhí)行sql,管理事務(wù)的接口,具體的實現(xiàn)類是DefaultSqlSession

org.apache.ibatis.executor.Executor接口:sql執(zhí)行器,SqlSession執(zhí)行sql最終是通過該接口實現(xiàn)的,常用的實現(xiàn)類有SimpleExecutor和CachingExecutor

一級緩存的作用域是SqlSession,那么我們就先看一下SqlSession的select過程:

這是DefaultSqlSession(SqlSession接口實現(xiàn)類,MyBatis默認(rèn)使用這個類)的selectList源碼(我們例子上使用的是selectOne方法,調(diào)用selectOne方法最終會執(zhí)行selectList方法):

public <E> List<E> selectList(String statement, Object parameter, RowBounds rowBounds) {

????try {

??????MappedStatement ms = configuration.getMappedStatement(statement);

??????List<E> result = executor.query(ms, wrapCollection(parameter), rowBounds, Executor.NO_RESULT_HANDLER);

??????return result;

????} catch (Exception e) {

??????throw ExceptionFactory.wrapException("Error querying database.? Cause: " + e, e);

????} finally {

??????ErrorContext.instance().reset();

????}

}

我們看到SqlSession最終會調(diào)用Executor接口的方法。

接下來我們看下DefaultSqlSession中的executor接口屬性具體是哪個實現(xiàn)類。

DefaultSqlSession的構(gòu)造過程(DefaultSqlSessionFactory內(nèi)部):

private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level, boolean autoCommit) {

????Transaction tx = null;

????try {

??????final Environment environment = configuration.getEnvironment();

??????final TransactionFactory transactionFactory = getTransactionFactoryFromEnvironment(environment);

??????tx = transactionFactory.newTransaction(environment.getDataSource(), level, autoCommit);

??????final Executor executor = configuration.newExecutor(tx, execType, autoCommit);

??????return new DefaultSqlSession(configuration, executor);

????} catch (Exception e) {

??????closeTransaction(tx); // may have fetched a connection so lets call close()

??????throw ExceptionFactory.wrapException("Error opening session.? Cause: " + e, e);

????} finally {

??????ErrorContext.instance().reset();

????}

}

我們看到DefaultSqlSessionFactory構(gòu)造DefaultSqlSession的時候,Executor接口的實現(xiàn)類是由Configuration構(gòu)造的:

public Executor newExecutor(Transaction transaction, ExecutorType executorType, boolean autoCommit) {

????executorType = executorType == null ? defaultExecutorType : executorType;

????executorType = executorType == null ? ExecutorType.SIMPLE : executorType;

????Executor 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 (cacheEnabled) {

??????executor = new CachingExecutor(executor, autoCommit);

????}

????executor = (Executor) interceptorChain.pluginAll(executor);

????return executor;

}

Executor根據(jù)ExecutorType的不同而創(chuàng)建,最常用的是SimpleExecutor,本文的例子也是創(chuàng)建這個實現(xiàn)類。 最后我們發(fā)現(xiàn)如果cacheEnabled這個屬性為true的話,那么executor會被包一層裝飾器,這個裝飾器是CachingExecutor。其中cacheEnabled這個屬性是mybatis總配置文件中settings節(jié)點中cacheEnabled子節(jié)點的值,默認(rèn)就是true,也就是說我們在mybatis總配置文件中不配cacheEnabled的話,它也是默認(rèn)為打開的。

現(xiàn)在,問題就剩下一個了,CachingExecutor執(zhí)行sql的時候到底做了什么?

帶著這個問題,我們繼續(xù)走下去(CachingExecutor的query方法):

public <E> List<E> query(MappedStatement ms, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql) throws SQLException {

????Cache cache = ms.getCache();

????if (cache != null) {

??????flushCacheIfRequired(ms);

??????if (ms.isUseCache() && resultHandler == null) {

????????ensureNoOutParams(ms, parameterObject, boundSql);

????????if (!dirty) {

??????????cache.getReadWriteLock().readLock().lock();

??????????try {

????????????@SuppressWarnings("unchecked")

????????????List<E> cachedList = (List<E>) cache.getObject(key);

????????????if (cachedList != null) return cachedList;

??????????} finally {

????????????cache.getReadWriteLock().readLock().unlock();

??????????}

????????}

????????List<E> list = delegate.<E> query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);

????????tcm.putObject(cache, key, list); // issue #578. Query must be not synchronized to prevent deadlocks

????????return list;

??????}

????}

????return delegate.<E>query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);

}

其中Cache cache = ms.getCache();這句代碼中,這個cache實際上就是個二級緩存,由于我們沒有開啟二級緩存(二級緩存的內(nèi)容下面會分析),因此這里執(zhí)行了最后一句話。這里的delegate也就是SimpleExecutor,SimpleExecutor沒有Override父類的query方法,因此最終執(zhí)行了SimpleExecutor的父類BaseExecutor的query方法。

所以一級緩存最重要的代碼就是BaseExecutor的query方法!

BaseExecutor的屬性localCache是個PerpetualCache類型的實例,PerpetualCache類是實現(xiàn)了MyBatis的Cache緩存接口的實現(xiàn)類之一,內(nèi)部有個Map類型的屬性用來存儲緩存數(shù)據(jù)。 這個localCache的類型在BaseExecutor內(nèi)部是寫死的。 這個localCache就是一級緩存!

接下來我們看下為何執(zhí)行新增或更新或刪除操作,一級緩存就會被清除這個問題。

首先MyBatis處理新增或刪除的時候,最終都是調(diào)用update方法,也就是說新增或者刪除操作在MyBatis眼里都是一個更新操作。

我們看下DefaultSqlSession的update方法:

public int update(String statement, Object parameter) {

????try {

??????dirty = true;

??????MappedStatement ms = configuration.getMappedStatement(statement);

??????return executor.update(ms, wrapCollection(parameter));

????} catch (Exception e) {

??????throw ExceptionFactory.wrapException("Error updating database.? Cause: " + e, e);

????} finally {

??????ErrorContext.instance().reset();

????}

}

很明顯,這里調(diào)用了CachingExecutor的update方法:

public int update(MappedStatement ms, Object parameterObject) throws SQLException {

????flushCacheIfRequired(ms);

????return delegate.update(ms, parameterObject);

}

這里的flushCacheIfRequired方法清除的是二級緩存,我們之后會分析。 CachingExecutor委托給了(之前已經(jīng)分析過)SimpleExecutor的update方法,SimpleExecutor沒有Override父類BaseExecutor的update方法,因此我們看BaseExecutor的update方法:

public int update(MappedStatement ms, Object parameter) throws SQLException {

????ErrorContext.instance().resource(ms.getResource()).activity("executing an update").object(ms.getId());

????if (closed) throw new ExecutorException("Executor was closed.");

????clearLocalCache();

????return doUpdate(ms, parameter);

}

我們看到了關(guān)鍵的一句代碼: clearLocalCache(); 進去看看:

public void clearLocalCache() {

????if (!closed) {

??????localCache.clear();

??????localOutputParameterCache.clear();

????}

}

沒錯,就是這條,sqlsession沒有關(guān)閉的話,進行新增、刪除、修改操作的話就是清除一級緩存,也就是SqlSession的緩存。

二級緩存

二級緩存的作用域是全局,換句話說,二級緩存已經(jīng)脫離SqlSession的控制了。

在測試二級緩存之前,我先把結(jié)論說一下:

二級緩存的作用域是全局的,二級緩存在SqlSession關(guān)閉或提交之后才會生效。

在分析MyBatis的二級緩存之前,我們先簡單看下MyBatis中一個關(guān)于二級緩存的類(其他相關(guān)的類和接口之前已經(jīng)分析過):

org.apache.ibatis.mapping.MappedStatement:

MappedStatement類在Mybatis框架中用于表示XML文件中一個sql語句節(jié)點,即一個<select />、<update />或者<insert />標(biāo)簽。Mybatis框架在初始化階段會對XML配置文件進行讀取,將其中的sql語句節(jié)點對象化為一個個MappedStatement對象。

配置

二級緩存跟一級緩存不同,一級緩存不需要配置任何東西,且默認(rèn)打開。 二級緩存就需要配置一些東西。

本文就說下最簡單的配置,在mapper文件上加上這句配置即可:

<cache/>

其實二級緩存跟3個配置有關(guān):

mybatis全局配置文件中的setting中的cacheEnabled需要為true(默認(rèn)為true,不設(shè)置也行)

mapper配置文件中需要加入<cache>節(jié)點

mapper配置文件中的select節(jié)點需要加上屬性useCache需要為true(默認(rèn)為true,不設(shè)置也行)

測試

不同SqlSession,查詢相同語句,第一次查詢之后commit SqlSession:

@Test

public void testCache2() {

????SqlSession sqlSession = sqlSessionFactory.openSession();

????SqlSession sqlSession2 = sqlSessionFactory.openSession();

????try {

????????String sql = "org.format.mybatis.cache.UserMapper.getById";

????????User user = (User)sqlSession.selectOne(sql, 1);

????????log.debug(user);

????????// 注意,這里一定要提交。 不提交還是會查詢兩次數(shù)據(jù)庫

????????sqlSession.commit();

????????User user2 = (User)sqlSession2.selectOne(sql, 1);

????????log.debug(user2);

????} finally {

????????sqlSession.close();

????????sqlSession2.close();

????}

}

MyBatis僅進行了一次數(shù)據(jù)庫查詢:

==>? Preparing: select * from USERS WHERE ID = ?

==> Parameters: 1(Integer)

<==????? Total: 1

User{id=1, name='format', age=23, birthday=Sun Oct 12 23:20:13 CST 2014}

User{id=1, name='format', age=23, birthday=Sun Oct 12 23:20:13 CST 2014}

不同SqlSession,查詢相同語句,第一次查詢之后close SqlSession:

@Test

public void testCache2() {

????SqlSession sqlSession = sqlSessionFactory.openSession();

????SqlSession sqlSession2 = sqlSessionFactory.openSession();

????try {

????????String sql = "org.format.mybatis.cache.UserMapper.getById";

????????User user = (User)sqlSession.selectOne(sql, 1);

????????log.debug(user);

????????sqlSession.close();

????????User user2 = (User)sqlSession2.selectOne(sql, 1);

????????log.debug(user2);

????} finally {

????????sqlSession2.close();

????}

}

MyBatis僅進行了一次數(shù)據(jù)庫查詢:

==>? Preparing: select * from USERS WHERE ID = ?

==> Parameters: 1(Integer)

<==????? Total: 1

User{id=1, name='format', age=23, birthday=Sun Oct 12 23:20:13 CST 2014}

User{id=1, name='format', age=23, birthday=Sun Oct 12 23:20:13 CST 2014}

不同SqlSesson,查詢相同語句。 第一次查詢之后SqlSession不提交:

@Test

public void testCache2() {

????SqlSession sqlSession = sqlSessionFactory.openSession();

????SqlSession sqlSession2 = sqlSessionFactory.openSession();

????try {

????????String sql = "org.format.mybatis.cache.UserMapper.getById";

????????User user = (User)sqlSession.selectOne(sql, 1);

????????log.debug(user);

????????User user2 = (User)sqlSession2.selectOne(sql, 1);

????????log.debug(user2);

????} finally {

????????sqlSession.close();

????????sqlSession2.close();

????}

}

MyBatis執(zhí)行了兩次數(shù)據(jù)庫查詢:

==>? Preparing: select * from USERS WHERE ID = ?

==> Parameters: 1(Integer)

<==????? Total: 1

User{id=1, name='format', age=23, birthday=Sun Oct 12 23:20:13 CST 2014}

==>? Preparing: select * from USERS WHERE ID = ?

==> Parameters: 1(Integer)

<==????? Total: 1

User{id=1, name='format', age=23, birthday=Sun Oct 12 23:20:13 CST 2014}

源碼分析

我們從在mapper文件中加入的<cache/>中開始分析源碼,接下來我們看下這個cache的解析:

XMLMappedBuilder(解析每個mapper配置文件的解析類,每一個mapper配置都會實例化一個XMLMapperBuilder類)的解析方法:

private void configurationElement(XNode context) {

????try {

??????String namespace = context.getStringAttribute("namespace");

??????if (namespace.equals("")) {

??????????throw new BuilderException("Mapper's namespace cannot be empty");

??????}

??????builderAssistant.setCurrentNamespace(namespace);

??????cacheRefElement(context.evalNode("cache-ref"));

??????cacheElement(context.evalNode("cache"));

??????parameterMapElement(context.evalNodes("/mapper/parameterMap"));

??????resultMapElements(context.evalNodes("/mapper/resultMap"));

??????sqlElement(context.evalNodes("/mapper/sql"));

??????buildStatementFromContext(context.evalNodes("select|insert|update|delete"));

????} catch (Exception e) {

??????throw new BuilderException("Error parsing Mapper XML. Cause: " + e, e);

????}

}

我們看到了解析cache的那段代碼:

private void cacheElement(XNode context) throws Exception {

????if (context != null) {

??????String type = context.getStringAttribute("type", "PERPETUAL");

??????Class<? extends Cache> typeClass = typeAliasRegistry.resolveAlias(type);

??????String eviction = context.getStringAttribute("eviction", "LRU");

??????Class<? extends Cache> evictionClass = typeAliasRegistry.resolveAlias(eviction);

??????Long flushInterval = context.getLongAttribute("flushInterval");

??????Integer size = context.getIntAttribute("size");

??????boolean readWrite = !context.getBooleanAttribute("readOnly", false);

??????Properties props = context.getChildrenAsProperties();

??????builderAssistant.useNewCache(typeClass, evictionClass, flushInterval, size, readWrite, props);

????}

}

解析完cache標(biāo)簽之后會使用builderAssistant的userNewCache方法,這里的builderAssistant是一個MapperBuilderAssistant類型的幫助類,每個XMLMappedBuilder構(gòu)造的時候都會實例化這個屬性,MapperBuilderAssistant類內(nèi)部有個Cache類型的currentCache屬性,這個屬性也就是mapper配置文件中cache節(jié)點所代表的值:

public Cache useNewCache(Class<? extends Cache> typeClass,

??Class<? extends Cache> evictionClass,

??Long flushInterval,

??Integer size,

??boolean readWrite,

??Properties props) {

????typeClass = valueOrDefault(typeClass, PerpetualCache.class);

????evictionClass = valueOrDefault(evictionClass, LruCache.class);

????Cache cache = new CacheBuilder(currentNamespace)

????????.implementation(typeClass)

????????.addDecorator(evictionClass)

????????.clearInterval(flushInterval)

????????.size(size)

????????.readWrite(readWrite)

????????.properties(props)

????????.build();

????configuration.addCache(cache);

????currentCache = cache;

????return cache;

}

ok,現(xiàn)在mapper配置文件中的cache節(jié)點被解析到了XMLMapperBuilder實例中的builderAssistant屬性中的currentCache值里。

接下來XMLMapperBuilder會解析select節(jié)點,解析select節(jié)點的時候使用XMLStatementBuilder進行解析(也包括其他insert,update,delete節(jié)點):

public void parseStatementNode() {

????String id = context.getStringAttribute("id");

????String databaseId = context.getStringAttribute("databaseId");


????if (!databaseIdMatchesCurrent(id, databaseId, this.requiredDatabaseId)) return;


????Integer fetchSize = context.getIntAttribute("fetchSize");

????Integer timeout = context.getIntAttribute("timeout");

????String parameterMap = context.getStringAttribute("parameterMap");

????String parameterType = context.getStringAttribute("parameterType");

????Class<?> parameterTypeClass = resolveClass(parameterType);

????String resultMap = context.getStringAttribute("resultMap");

????String resultType = context.getStringAttribute("resultType");

????String lang = context.getStringAttribute("lang");

????LanguageDriver langDriver = getLanguageDriver(lang);


????Class<?> resultTypeClass = resolveClass(resultType);

????String resultSetType = context.getStringAttribute("resultSetType");

????StatementType statementType = StatementType.valueOf(context.getStringAttribute("statementType", StatementType.PREPARED.toString()));

????ResultSetType resultSetTypeEnum = resolveResultSetType(resultSetType);


????String nodeName = context.getNode().getNodeName();

????SqlCommandType sqlCommandType = SqlCommandType.valueOf(nodeName.toUpperCase(Locale.ENGLISH));

????boolean isSelect = sqlCommandType == SqlCommandType.SELECT;

????boolean flushCache = context.getBooleanAttribute("flushCache", !isSelect);

????boolean useCache = context.getBooleanAttribute("useCache", isSelect);

????boolean resultOrdered = context.getBooleanAttribute("resultOrdered", false);


????// Include Fragments before parsing

????XMLIncludeTransformer includeParser = new XMLIncludeTransformer(configuration, builderAssistant);

????includeParser.applyIncludes(context.getNode());


????// Parse selectKey after includes and remove them.

????processSelectKeyNodes(id, parameterTypeClass, langDriver);


????// Parse the SQL (pre: <selectKey> and <include> were parsed and removed)

????SqlSource sqlSource = langDriver.createSqlSource(configuration, context, parameterTypeClass);

????String resultSets = context.getStringAttribute("resultSets");

????String keyProperty = context.getStringAttribute("keyProperty");

????String keyColumn = context.getStringAttribute("keyColumn");

????KeyGenerator keyGenerator;

????String keyStatementId = id + SelectKeyGenerator.SELECT_KEY_SUFFIX;

????keyStatementId = builderAssistant.applyCurrentNamespace(keyStatementId, true);

????if (configuration.hasKeyGenerator(keyStatementId)) {

??????keyGenerator = configuration.getKeyGenerator(keyStatementId);

????} else {

??????keyGenerator = context.getBooleanAttribute("useGeneratedKeys",

??????????configuration.isUseGeneratedKeys() && SqlCommandType.INSERT.equals(sqlCommandType))

??????????? new Jdbc3KeyGenerator() : new NoKeyGenerator();

????}

????builderAssistant.addMappedStatement(id, sqlSource, statementType, sqlCommandType,

????????fetchSize, timeout, parameterMap, parameterTypeClass, resultMap, resultTypeClass,

????????resultSetTypeEnum, flushCache, useCache, resultOrdered,

????????keyGenerator, keyProperty, keyColumn, databaseId, langDriver, resultSets);

}

這段代碼前面都是解析一些標(biāo)簽的屬性,我們看到了最后一行使用builderAssistant添加MappedStatement,其中builderAssistant屬性是構(gòu)造XMLStatementBuilder的時候通過XMLMappedBuilder傳入的,我們繼續(xù)看builderAssistant的addMappedStatement方法:

進入setStatementCache:

private void setStatementCache(

??boolean isSelect,

??boolean flushCache,

??boolean useCache,

??Cache cache,

??MappedStatement.Builder statementBuilder) {

????flushCache = valueOrDefault(flushCache, !isSelect);

????useCache = valueOrDefault(useCache, isSelect);

????statementBuilder.flushCacheRequired(flushCache);

????statementBuilder.useCache(useCache);

????statementBuilder.cache(cache);

}

最終mapper配置文件中的<cache/>被設(shè)置到了XMLMapperBuilder的builderAssistant屬性中,XMLMapperBuilder中使用XMLStatementBuilder遍歷CRUD節(jié)點,遍歷CRUD節(jié)點的時候?qū)⑦@個cache節(jié)點設(shè)置到這些CRUD節(jié)點中,這個cache就是所謂的二級緩存!

接下來我們回過頭來看查詢的源碼,CachingExecutor的query方法:

進入TransactionalCacheManager的putObject方法:

public void putObject(Cache cache, CacheKey key, Object value) {

????getTransactionalCache(cache).putObject(key, value);

}


private TransactionalCache getTransactionalCache(Cache cache) {

????TransactionalCache txCache = transactionalCaches.get(cache);

????if (txCache == null) {

??????txCache = new TransactionalCache(cache);

??????transactionalCaches.put(cache, txCache);

????}

????return txCache;

}

TransactionalCache的putObject方法:

public void putObject(Object key, Object object) {

????entriesToRemoveOnCommit.remove(key);

????entriesToAddOnCommit.put(key, new AddEntry(delegate, key, object));

}

我們看到,數(shù)據(jù)被加入到了entriesToAddOnCommit中,這個entriesToAddOnCommit是什么東西呢,它是TransactionalCache的一個Map屬性:

private Map<Object, AddEntry> entriesToAddOnCommit;

AddEntry是TransactionalCache內(nèi)部的一個類:

private static class AddEntry {

????private Cache cache;

????private Object key;

????private Object value;


????public AddEntry(Cache cache, Object key, Object value) {

??????this.cache = cache;

??????this.key = key;

??????this.value = value;

????}


????public void commit() {

??????cache.putObject(key, value);

????}

}

好了,現(xiàn)在我們發(fā)現(xiàn)使用二級緩存之后:查詢數(shù)據(jù)的話,先從二級緩存中拿數(shù)據(jù),如果沒有的話,去一級緩存中拿,一級緩存也沒有的話再查詢數(shù)據(jù)庫。有了數(shù)據(jù)之后在丟到TransactionalCache這個對象的entriesToAddOnCommit屬性中。

接下來我們來驗證為什么SqlSession commit或close之后,二級緩存才會生效這個問題。

DefaultSqlSession的commit方法:

public void commit(boolean force) {

????try {

??????executor.commit(isCommitOrRollbackRequired(force));

??????dirty = false;

????} catch (Exception e) {

??????throw ExceptionFactory.wrapException("Error committing transaction.? Cause: " + e, e);

????} finally {

??????ErrorContext.instance().reset();

????}

}

CachingExecutor的commit方法:

public void commit(boolean required) throws SQLException {

????delegate.commit(required);

????tcm.commit();

????dirty = false;

}

tcm.commit即 TransactionalCacheManager的commit方法:

public void commit() {

????for (TransactionalCache txCache : transactionalCaches.values()) {

??????txCache.commit();

????}

}

TransactionalCache的commit方法:

public void commit() {

????delegate.getReadWriteLock().writeLock().lock();

????try {

??????if (clearOnCommit) {

????????delegate.clear();

??????} else {

????????for (RemoveEntry entry : entriesToRemoveOnCommit.values()) {

??????????entry.commit();

????????}

??????}

??????for (AddEntry entry : entriesToAddOnCommit.values()) {

????????entry.commit();

??????}

??????reset();

????} finally {

??????delegate.getReadWriteLock().writeLock().unlock();

????}

}

發(fā)現(xiàn)調(diào)用了AddEntry的commit方法:

public void commit() {

??cache.putObject(key, value);

}

發(fā)現(xiàn)了! AddEntry的commit方法會把數(shù)據(jù)丟到cache中,也就是丟到二級緩存中!

關(guān)于為何調(diào)用close方法后,二級緩存才會生效,因為close方法內(nèi)部會調(diào)用commit方法。本文就不具體說了。 讀者有興趣的話看一看源碼就知道為什么了。

其他

Cache接口簡介

org.apache.ibatis.cache.Cache是MyBatis的緩存接口,想要實現(xiàn)自定義的緩存需要實現(xiàn)這個接口。

MyBatis中關(guān)于Cache接口的實現(xiàn)類也使用了裝飾者設(shè)計模式

我們看下它的一些實現(xiàn)類

簡單說明:

LRU – 最近最少使用的:移除最長時間不被使用的對象。

FIFO – 先進先出:按對象進入緩存的順序來移除它們。

SOFT – 軟引用:移除基于垃圾回收器狀態(tài)和軟引用規(guī)則的對象。

WEAK – 弱引用:更積極地移除基于垃圾收集器狀態(tài)和弱引用規(guī)則的對象。

<cache

??eviction="FIFO"

??flushInterval="60000"

??size="512"

??readOnly="true"/>

可以通過cache節(jié)點的eviction屬性設(shè)置,也可以設(shè)置其他的屬性。

cache-ref節(jié)點

mapper配置文件中還可以加入cache-ref節(jié)點,它有個屬性namespace。

如果每個mapper文件都是用cache-ref,且namespace都一樣,那么就代表著真正意義上的全局緩存。

如果只用了cache節(jié)點,那僅代表這個這個mapper內(nèi)部的查詢被緩存了,其他mapper文件的不起作用,這并不是所謂的全局緩存。

總結(jié)

總體來說,MyBatis的源碼看起來還是比較輕松的,本文從實踐和源碼方面深入分析了MyBatis的緩存原理,希望對讀者有幫助

歡迎學(xué)Java和大數(shù)據(jù)的朋友們加入java架構(gòu)交流: 855835163

加群鏈接:https://jq.qq.com/?_wv=1027&k=5dPqXGI???????

群內(nèi)提供免費的架構(gòu)資料還有:Java工程化、高性能及分布式、高性能、深入淺出。高架構(gòu)。性能調(diào)優(yōu)、Spring,MyBatis,Netty源碼分析和大數(shù)據(jù)等多個知識點高級進階干貨的免費直播講解 ?可以進來一起學(xué)習(xí)交流哦

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

推薦閱讀更多精彩內(nèi)容