Java Mybatis架构设计深入了解

更新时间：2021年11月03日 11:10:38 作者：女友在高考

在本篇文章里小编给大家整理的是一篇关于Java Mybatis架构设计详解内容，对此有兴趣的朋友们可以参考下,希望能够给你带来帮助

架构设计

我们可以把Mybatis的功能架构分为三层：

1.API接口层：提供给外部使用的接口API，开发人员通过这些本地API来操纵数据库。接口层一接收到调用请求就会调用数据处理层来完成具体的数据处理。

Mybatis和数据库的交互有两种方式：

使用传统的Mybatis提供API
使用Mapper代理的方式

2.数据处理层：负责具体的SQL查找、SQL解析、SQL执行和执行结果映射处理等。他主要的目的是根据调用的请求完成一次数据库操作。

3.基础支撑层：负责最基础的功能支撑，包括连接管理、事务管理、配置加载和缓存处理，这些都是共用的东西，将他们抽取出来最为基础组件。为上层的数据处理层提供最基础的支撑。

Mybatis主要构件

构件	描述
SqlSession	作为Mybatis工作的主要顶层API，表示和数据库交互的会话，完成必要数据库增删查改功能
Executor	Mybatis执行器，是Mybatis调度的核心，负责SQL语句的生成和查询缓存的维护
StatementHandler	封装了JDBC Statement操作，负责对JDBC statement的操作，如设置参数、将Statement结果集转换为List集合
ParameterHandler	负责对用户传递的参数转换为JDBC Statement所需要的参数
ResultSetHandler	负责将JDBC返回的ResultSet结果集对象转换为List类型的集合
TypeHandler	负责java数据类型和jdbc数据类型之间的映射和转换
MappedStatement	MappedStatement维护了一条<select、 update 、 delete 、insert >节点的封装
SqlSource	负责根据用户传递的parameterObject，动态的生成SQL语句，将信息封装到BoundSql对象中
BoundSql	表示动态生成的SQL语句以及相应的参数信息

总体流程：

1.加载配置并初始化

配置来源于两个地方，一个是配置文件（conf.xml,mapper*.xml），一个是java代码中的注解，将配置文件内容封装到Configuration,将sql的配置信息加载成为一个mappedstatement对象，存储在内存中。

2. 接收调用请求

触发条件：调用Mybatis提供的API

传入参数：为SQL的ID和传入的参数

将请求传递给下层的请求处理层进行处理

3.处理操作请求

根据SQL的ID查找对应的MappedStatement对象
根据传入参数对象解析，得到最终要执行的SQL和执行传入参数
获取数据库连接，将最终SQL语句和参数给到数据库执行，并得到执行结果
根据MappedStatement对象中的结果映射配置对得到的执行结果进行转换处理，并得到最终的处理结果
释放连接资源

4.返回处理结果

Mybatis缓存

Mybatis有一级缓存和二级缓存。Mybatis收到查询请求后首先会查询二级缓存，若二级缓存未命中，再去查询一级缓存，一级缓存没有，再查询数据库。

一级缓存

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.");
    }
    if (queryStack == 0 && ms.isFlushCacheRequired()) {
      clearLocalCache();
    }
    List<E> list;
    try {
      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;
  }

这个localCache是BaseExecutor里面的一个属性

public abstract class BaseExecutor implements Executor {


  protected PerpetualCache localCache;

PerpetualCache类

public class PerpetualCache implements Cache {

  private final String id;

  private Map<Object, Object> cache = new HashMap<Object, Object>();

  public PerpetualCache(String id) {
    this.id = id;
  }

  @Override
  public String getId() {
    return id;
  }

  @Override
  public int getSize() {
    return cache.size();
  }

  @Override
  public void putObject(Object key, Object value) {
    cache.put(key, value);
  }

  @Override
  public Object getObject(Object key) {
    return cache.get(key);
  }

二级缓存

启用二级缓存步骤：

1.开启cacheEnabled（默认打开）

<settings>
<setting name="cacheEnabled" value="true"/>
</settings>

2.需要在二级缓存的Mapper配置文件中加入

<cache></cache>

3.注意，二级缓存要想生效，必须要调用sqlSession.commit或close方法

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

注意Cache cache = ms.getCache();，这个cache是从MappedStatement中获取到的，由于MappedStatement存在全局配置中，可以多个CachingExecutor获取到，这样就会出现线程安全问题。除此之外，若不加以控制，多个事务共用一个缓存实例，会导致脏读的存在。

那么mybatis是怎么解决脏读的呢？借用了上面的tcm这个变量，也就是TransactionalCacheManager类来解决的。

TransactionalCacheManager类维护了Cache，TransactionalCache的关系，真正的数据还是交由TransactionalCache处理的。

结构如图：

public class TransactionalCacheManager {

  private final Map<Cache, TransactionalCache> transactionalCaches = new HashMap<Cache, TransactionalCache>();

  public void clear(Cache cache) {
    getTransactionalCache(cache).clear();
  }

  public Object getObject(Cache cache, CacheKey key) {
    return getTransactionalCache(cache).getObject(key);
  }
  
  public void putObject(Cache cache, CacheKey key, Object value) {
    getTransactionalCache(cache).putObject(key, value);
  }

  public void commit() {
    for (TransactionalCache txCache : transactionalCaches.values()) {
      txCache.commit();
    }
  }

  public void rollback() {
    for (TransactionalCache txCache : transactionalCaches.values()) {
      txCache.rollback();
    }
  }

  private TransactionalCache getTransactionalCache(Cache cache) {
    TransactionalCache txCache = transactionalCaches.get(cache);
    if (txCache == null) {
      txCache = new TransactionalCache(cache);
      transactionalCaches.put(cache, txCache);
    }
    return txCache;
  }

}

接下来看一下TransactionalCache的代码

public class TransactionalCache implements Cache {

  private static final Log log = LogFactory.getLog(TransactionalCache.class);

  // 真正的缓存对象
  private final Cache delegate;
  private boolean clearOnCommit;
  //在事务被提交前，所有从数据库中查询的结果将缓存在此集合中
  private final Map<Object, Object> entriesToAddOnCommit;
  //在事务被提交前，当缓存未命中时，CacheKey 将会被存储在此集合中
  private final Set<Object> entriesMissedInCache;

  public TransactionalCache(Cache delegate) {
    this.delegate = delegate;
    this.clearOnCommit = false;
    this.entriesToAddOnCommit = new HashMap<Object, Object>();
    this.entriesMissedInCache = new HashSet<Object>();
  }

  @Override
  public String getId() {
    return delegate.getId();
  }

  @Override
  public int getSize() {
    return delegate.getSize();
  }

  @Override
  public Object getObject(Object key) {
    // issue #116
    //获取缓存的时候从delegate里获取的
    Object object = delegate.getObject(key);
    if (object == null) {
      //缓存未命中，将key存入entriesMissedInCache.
      entriesMissedInCache.add(key);
    }
    // issue #146
    if (clearOnCommit) {
      return null;
    } else {
      return object;
    }
  }

  @Override
  public ReadWriteLock getReadWriteLock() {
    return null;
  }

  @Override
  public void putObject(Object key, Object object) {
    //put的时候只是将数据库的数据放入到了entriesToAddOnCommit
    entriesToAddOnCommit.put(key, object);
  }

  @Override
  public Object removeObject(Object key) {
    return null;
  }

  @Override
  public void clear() {
    clearOnCommit = true;
    entriesToAddOnCommit.clear();
  }

  public void commit() {
    if (clearOnCommit) {
      delegate.clear();
    }
    //刷新未缓存的结果到delegate中去
    flushPendingEntries();
    reset();
  }

  public void rollback() {
    unlockMissedEntries();
    reset();
  }

  private void reset() {
    clearOnCommit = false;
    entriesToAddOnCommit.clear();
    entriesMissedInCache.clear();
  }

  private void flushPendingEntries() {
    for (Map.Entry<Object, Object> entry : entriesToAddOnCommit.entrySet()) {
      delegate.putObject(entry.getKey(), entry.getValue());
    }
    for (Object entry : entriesMissedInCache) {
      if (!entriesToAddOnCommit.containsKey(entry)) {
        delegate.putObject(entry, null);
      }
    }
  }

  private void unlockMissedEntries() {
    for (Object entry : entriesMissedInCache) {
      try {
        delegate.removeObject(entry);
      } catch (Exception e) {
        log.warn("Unexpected exception while notifiying a rollback to the cache adapter."
            + "Consider upgrading your cache adapter to the latest version.  Cause: " + e);
      }
    }
  }

}

我们存储二级缓存的时候是放入到TransactionalCache.entriesToAddOnCommit这个map中，但是每次查询的时候是从delegate查询的，所以这个二级缓存查询数据库后，缓存是没有立刻生效的。只有当执行了sqlSession的commit或close方法后，它会调用到tcm的commit，在调用到transactionlCache的commit，刷新缓存到delegate了。

总结：

二级缓存的设计上，大量运用了装饰器模式，如SynchronizedCache、LoggingCache。

二级缓存实现了Sqlsession之间的缓存数据共享，属于namespace级别

二级缓存的实现由CachingExecutor和一个事务型预缓存TransactionlCache完成。

本篇文章就到这里了，希望能够给你带来帮助，也希望您能够多多关注脚本之家的更多内容！

您可能感兴趣的文章:

Spring Security基于散列加密方案实现自动登录功能
为了提高项目的用户体验，我们可以在项目中添加自动登录功能，当然也要给用户提供退出登录的功能。接下来学习下Spring Security基于散列加密方案实现自动登录功能，一起看看吧
2021-09-09
Nacos注册中心的部署与用法示例详解
注册中心是微服务架构中的纽带，类似于“通讯录”，它记录了服务和服务地址的映射关系，本文通过示例代码给大家介绍Nacos注册中心的部署与用法，感兴趣的朋友跟随小编一起看看吧
2022-02-02
SpringMVC结合Jcrop实现图片裁剪
这篇文章主要介绍了SpringMVC结合Jcrop实现图片裁剪的相关资料，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2016-12-12
SpringMVC ModelAndView的用法使用详解
这篇文章主要介绍了SpringMVC ModelAndView的用法使用详解，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-12-12
Java下载Excel模板文件的简单实现方法
这篇文章主要给大家介绍了关于Java下载Excel模板文件的简单实现方法,日常工作中可能经常会涉及到用java开发报表,需求比较多的就是表格类的报表导出,单元格合并,图表的展现,需要的朋友可以参考下
2023-07-07
Java实战花店商城系统的实现流程
只学书上的理论是远远不够的，只有在实战中才能获得能力的提升，本篇文章手把手带你用java+Springboot+Maven+mybatis+Vue+Mysql实现一个花店商城系统,大家可以在过程中查缺补漏，提升水平
2022-01-01
springboot项目整合注册功能模块开发实战
这篇文章主要介绍了springboot项目整合注册功能模块开发实战,在用户的注册是首先需要查询当前的用户名是否存在，如果存在则不能进行注册，相当于一个查询语句，本文通过实例代码详细讲解，需要的朋友可以参考下
2022-11-11
Java基础知识之BufferedReader流的使用
这篇文章主要介绍了Java基础知识之BufferedReader流的使用，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-12-12
使用SpringBoot打jar包并部署到Tomcat详细步骤
今天带大家来学习怎么使用SpringBoot打jar包并部署到Tomcat,文中有非常详细的步骤及代码示例,对正在学习java的小伙伴们很有帮助,需要的朋友可以参考下
2021-05-05
Java 使用JdbcTemplate 中的queryForList发生错误解决办法
这篇文章主要介绍了Java 使用JdbcTemplate 中的queryForList发生错误解决办法的相关资料,需要的朋友可以参考下
2017-07-07

Java Mybatis架构设计深入了解

目录

架构设计

Mybatis主要构件

Mybatis缓存

总结：

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具