Mybatis一級キャッシュとSpring Fraamewarkを結合した後に失効したソースの探究

1.次のケースでは、二回の照会コンソールを実行すると一回のSQLクエリしか出力されません。

mybatis-config.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/xxx?useUnicode=true&characterEncoding=utf-8&autoReconnect=true"/>
                <property name="username" value="xxx"/>
                <property name="password" value="xxx"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com/hrh/mapper/PersonMapper.xml"/>
    </mappers>
</configuration>

PersonMapper.xml
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="com.hrh.mapper.PersonMapper">
    <resultMap id="BaseResultMap" type="com.hrh.bean.Person">
        <id column="id" property="id" jdbcType="BIGINT"/>
        <result column="name" property="name" jdbcType="VARCHAR"/>
        <result column="age" property="age" jdbcType="BIGINT"/>
    </resultMap>
    <sql id="Base_Column_List">
    id, name, age
    </sql>
    <select id="list" resultType="com.hrh.bean.Person">
        select
        <include refid="Base_Column_List"/>
        from tab_person
    </select>
</mapper>

public interface PersonMapper {
     List<Person> list();
}

String resource = "mybatis-config2.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        SqlSessionFactory sqlSessionFactory =
                new SqlSessionFactoryBuilder().build(inputStream);
        SqlSession sqlSession = sqlSessionFactory.openSession();//    
        PersonMapper mapper = sqlSession.getMapper(PersonMapper.class);
        mapper.list();
        mapper.list();

なぜこのような状況になったかというと、Mybatisには一級キャッシュが存在していますので、次のdebugで内部フローを調べてみます。

（1）mapper.list（）はMapperProxy((zhi invoke)：パラメータproxyは代理対象です。（Mapperインターフェースごとに代理対象に変換されます。）セッションsql Session、インターフェース情報、方法情報が含まれます。methodは、ターゲット方法（現在実行される方法）であり、どのタイプ（インターフェース）、方法名、戻りタイプ（List、Map、voidまたは他）、パラメータタイプなどが含まれていますか？argsはパラメータです

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);
    }
    //     methodCache         ：     、  （select、update ）、    
    //       MapperMethod，        methodCache 
    final MapperMethod mapperMethod = cachedMapperMethod(method);
    //    SQL     
    return mapperMethod.execute(sqlSession, args);
  }

cacheMapperMethod：MapperMethodは、メソッド名、タイプ（select、udateなど）、戻りタイプなどの情報を含みます。

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;
  }

（2）MapperMethod((zhi execute)(SQLタイプによって、異なる照会方法に入る

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;
          //  List   
        } else if (method.returnsMany()) {
          result = executeForMany(sqlSession, args);
          //  Map   
        } 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;
  }

（3）上記の例はselect文で、返ってきた結果はList集合となりますので、MapperMethod((zhi executeForMany)：

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
    //  list            ，    
    if (!method.getReturnType().isAssignableFrom(result.getClass())) {
      if (method.getReturnType().isArray()) {
        return convertToArray(result);
      } else {
        return convertToDeclaredCollection(sqlSession.getConfiguration(), result);
      }
    }
    return result;
  }

(4)selectListはDefault Sql Session((zhi selectList)：

 public <E> List<E> selectList(String statement, Object parameter) {
    return this.selectList(statement, parameter, RowBounds.DEFAULT);
  }

public <E> List<E> selectList(String statement, Object parameter, RowBounds rowBounds) {
    try {
      //SQL     ：resource（xxMapper.xml）、id、sql、     
      MappedStatement ms = configuration.getMappedStatement(statement);
      //    
      return executor.query(ms, wrapCollection(parameter), rowBounds, Executor.NO_RESULT_HANDLER);
    } catch (Exception e) {
      throw ExceptionFactory.wrapException("Error querying database.  Cause: " + e, e);
    } finally {
      ErrorContext.instance().reset();
    }
  }

（5）次にキャッシュアクチュエータを呼び出す方法：CachingExector啢query()

public <E> List<E> query(MappedStatement ms, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler) throws SQLException {
    //     SQL
    BoundSql boundSql = ms.getBoundSql(parameterObject);
    // SQL          ，                  ，                   
    //createCacheKey：  BaseExecutor#createCacheKey
    CacheKey key = createCacheKey(ms, parameterObject, rowBounds, boundSql);
    return query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
  }

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, boundSql);
        @SuppressWarnings("unchecked")
        List<E> list = (List<E>) tcm.getObject(cache, key);
        if (list == null) {
          list = delegate.<E> query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
          tcm.putObject(cache, key, list); // issue #578 and #116
        }
        return list;
      }
    }
    //        
    return delegate.<E> query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
  }

（6）次はBaseExector铅query（）を実行します。結果は下記からlocacacacheにキャッシュされていることが分かります。

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 (closed) {
      throw new ExecutorException("Executor was closed.");
    }
    //        （   0），  <select>   flushCache=true      
    if (queryStack == 0 && ms.isFlushCacheRequired()) {
      clearLocalCache();
    }
    List<E> list;
    try {
     //      +1
      queryStack++;
      // localCache     
      list = resultHandler == null ? (List<E>) localCache.getObject(key) : null;
      if (list != null) {
        handleLocallyCachedOutputParameters(ms, key, parameter, boundSql);
      } else {
        //    
        list = queryFromDatabase(ms, parameter, rowBounds, resultHandler, key, boundSql);
      }
    } finally {
      queryStack--;
    }
    //         
    if (queryStack == 0) {
      for (DeferredLoad deferredLoad : deferredLoads) {
        deferredLoad.load();
      }
      // issue #601
      deferredLoads.clear();
      if (configuration.getLocalCacheScope() == LocalCacheScope.STATEMENT) {
        // issue #482
        clearLocalCache();
      }
    }
    return list;
  }

private <E> List<E> queryFromDatabase(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql) throws SQLException {
    List<E> list;
    //        
    localCache.putObject(key, EXECUTION_PLACEHOLDER);
    try {
      //               
      list = doQuery(ms, parameter, rowBounds, resultHandler, boundSql);
    } finally {
      //     
      localCache.removeObject(key);
    }
    //       
    localCache.putObject(key, list);
    //      
    if (ms.getStatementType() == StatementType.CALLABLE) {
      localOutputParameterCache.putObject(key, parameter);
    }
    return list;
  }

2.しかし、Spring Frame ewark+Mybatisの場合、状況は違っています。毎回検索するたびにデータベースに接続して調べて、コンソールはSQLを印刷してきます。

@Service
public class PersonService  {
    @Autowired
    PersonMapper personMapper;

    public List<Person> getList() {
        personMapper.list();
        personMapper.list();
        return personMapper.list();
    }
}

@Configuration
@ComponentScan("com.hrh")
@MapperScan("com.hrh.mapper")
public class MyBatisConfig {
    @Bean
    public SqlSessionFactoryBean sqlSessionFactory() throws Exception {
        SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
        factoryBean.setDataSource(dataSource());
        factoryBean.setMapperLocations(resolveMapperLocations());
        return factoryBean;
    }

    public Resource[] resolveMapperLocations() {
        ResourcePatternResolver resourceResolver = new PathMatchingResourcePatternResolver();
        List<String> mapperLocations = new ArrayList<>();
        mapperLocations.add("classpath*:com/hrh/mapper/*Mapper*.xml");
        List<Resource> resources = new ArrayList();
        if (mapperLocations != null) {
            for (String mapperLocation : mapperLocations) {
                try {
                    Resource[] mappers = resourceResolver.getResources(mapperLocation);
                    resources.addAll(Arrays.asList(mappers));
                } catch (IOException e) {
                    // ignore
                }
            }
        }
        return resources.toArray(new Resource[resources.size()]);
    }

    @Bean
    public DataSource dataSource() {
        DriverManagerDataSource driverManagerDataSource = new DriverManagerDataSource();
        driverManagerDataSource.setDriverClassName("com.mysql.jdbc.Driver");
        driverManagerDataSource.setUsername("xxx");
        driverManagerDataSource.setPassword("xxx");
        driverManagerDataSource.setUrl("jdbc:mysql://localhost:3306/xxx?useUnicode=true&characterEncoding=utf-8&autoReconnect=true");
        return driverManagerDataSource;
    }
}

  AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(MyBatisConfig.class);
        PersonService bean = context.getBean(PersonService.class);
        bean.getList();

以下のdebugは上の（1）、（2）、（3）と一致していますが、第4ステップはSql Session Templateに進んでいます。上記のDefault Sql Session Templateはmybatis-spring-X.jarに属しています。

  public <E> List<E> selectList(String statement, Object parameter) {
    return this.selectList(statement, parameter, RowBounds.DEFAULT);
  }

次のselectList（）は、Default Sql Session((zhi selectList)(zhi select List)に実行され、上記の第4ステップに戻って続きます。つまり、前の(1)～(6)に前文を挿入し、閉会話の操作をしました。

private class SqlSessionInterceptor implements InvocationHandler {
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
      //    
      SqlSession sqlSession = getSqlSession(
          SqlSessionTemplate.this.sqlSessionFactory,
          SqlSessionTemplate.this.executorType,
          SqlSessionTemplate.this.exceptionTranslator);
      try {
        //      
        Object result = method.invoke(sqlSession, args);
        if (!isSqlSessionTransactional(sqlSession, SqlSessionTemplate.this.sqlSessionFactory)) {
          // force commit even on non-dirty sessions because some databases require
          // a commit/rollback before calling close()
          sqlSession.commit(true);//           
        }
        return result;
        
      } catch (Throwable t) {//            
        Throwable unwrapped = unwrapThrowable(t);
        if (SqlSessionTemplate.this.exceptionTranslator != null && unwrapped instanceof PersistenceException) {
          // release the connection to avoid a deadlock if the translator is no loaded. See issue #22
          closeSqlSession(sqlSession, SqlSessionTemplate.this.sqlSessionFactory);
          sqlSession = null;
          Throwable translated = SqlSessionTemplate.this.exceptionTranslator.translateExceptionIfPossible((PersistenceException) unwrapped);
          if (translated != null) {
            unwrapped = translated;
          }
        }
        throw unwrapped;
      } finally {
        //    
        if (sqlSession != null) {
          closeSqlSession(sqlSession, SqlSessionTemplate.this.sqlSessionFactory);
        }
      }
    }
  }

まとめ:
Mybatisの一級キャッシュはセッションレベルのキャッシュであり、MybatisはSql Sessionセッションオブジェクトを作成するごとに、データベースセッションを開くという意味であり、一回のセッションでは、アプリケーションは短い時間で同じクエリ文を繰り返し実行する可能性があります。データをキャッシュしないと、検索するたびにデータベースクエリを実行します。これはデータベースの無駄をもたらします。また、Sql Sessionによる操作により、実際にExectorによってデータベース操作が行われるため、Exectorには簡単なキャッシュ、すなわち、一級キャッシュが作成されます。毎回の検索結果をキャッシュして、再度クエリーを実行すると、先に一級キャッシュ（デフォルトで開いている）を調べて、ヒットしたらそのまま返します。そうでなければ、データベースを調べてキャッシュに入れます。
一級キャッシュのライフサイクルはSql Sessionのライフサイクルと同じであるため、MybatisとSpring Frame eworkの統合パッケージにSql Session Template類が拡張されています。すべてのクエリはSql Session TemplateエージェントによってブロックされてからDefaultSlselctionに入ります。クエリを終了してセッションSql Sessionをオフにしたので、キャッシュが無効になりました。
なぜこのように操作しますか？
元のMybatisはSql Sessionインターフェイスを暴露していますので、クローズド方法が露出して、あなたが選択して使うことができます。オフとオフを選択できますが、MybatisとSpring Frame ewarkのインテグレーションバッグの中で、Sql SessionはSpring Frame ework管理に任せています。
ここで、Mybatis一級キャッシュとSpring Fraamewarkを結合した後に失効したソースコードの探究の記事を紹介します。これに関連して、Mybatis一級キャッシュSpring Frame eworkの失効内容を紹介します。以前の文章を検索してください。または以下の関連記事を引き続きご覧ください。これからもよろしくお願いします。