MyBatis 缓存模块

2023-09-21 10:14:34

文章目录

前言

MyBatis作为一个强大的持久层框架，缓存是其必不可少的功能之一，Mybatis中的缓存分为一级缓存和二级缓存。但本质上是一样的，都是使用Cache接口实现的。

缓存的实现

Cache接口

Cache接口是缓存模块中最核心的接口，它定义了所有缓存的基本行为。其实现类很多，但是大部分都是装饰器，只有PerpetualCache提供了Cache接口的基本实现。

image.png

PerpetualCache

PerpetualCache在缓存模块中扮演了ConcreteComponent的角色，其实现比较简单，底层使用HashMap记录缓存项，具体的实现如下：

/**
 * 在装饰器模式用 用来被装饰的对象
 * 缓存中的  基本缓存处理的实现
 * 其实就是一个 HashMap 的基本操作
 * @author Clinton Begin
 */
public class PerpetualCache implements Cache {

  private final String id; // Cache 对象的唯一标识

  // 用于记录缓存的Map对象
  private final Map<Object, Object> cache = new HashMap<>();

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

  @Override
  public Object removeObject(Object key) {
    return cache.remove(key);
  }

  @Override
  public void clear() {
    cache.clear();
  }

  @Override
  public boolean equals(Object o) {
    if (getId() == null) {
      throw new CacheException("Cache instances require an ID.");
    }
    if (this == o) {
      return true;
    }
    if (!(o instanceof Cache)) {
      return false;
    }

    Cache otherCache = (Cache) o;
    // 只关心ID
    return getId().equals(otherCache.getId());
  }

  @Override
  public int hashCode() {
    if (getId() == null) {
      throw new CacheException("Cache instances require an ID.");
    }
    // 只关心ID
    return getId().hashCode();
  }

}

cache.decorators包下提供的装饰器，他们都实现了Cache接口。这些装饰器都在PerpetualCache的基础上提供了一些额外的功能，通过多个组合实现一些特殊的需求。

其他的具体实现类，可以自行查阅。

缓存实现类描述作用装饰条件
基本缓存缓存基本实现类默认是PerpetualCache，也可以自定义比如RedisCache、EhCache等，具备基本功能的缓存类无
LruCacheLRU策略的缓存当缓存到达上限时候，删除最近最少使用的缓存（Least Recently Use）eviction=“LRU”（默认）
FifoCacheFIFO策略的缓存当缓存到达上限时候，删除最先入队的缓存eviction=“FIFO”
SoftCacheWeakCache带清理策略的缓存通过JVM的软引用和弱引用来实现缓存，当JVM内存不足时，会自动清理掉这些缓存，基于SoftReference和WeakReferenceeviction="SOFT"eviction=“WEAK”
LoggingCache带日志功能的缓存比如：输出缓存命中率基本
SynchronizedCache同步缓存基于synchronized关键字实现，解决并发问题基本
BlockingCache阻塞缓存通过在get/put方式中加锁，保证只有一个线程操作缓存，基于Java重入锁实现blocking=true
SerializedCache支持序列化的缓存将对象序列化以后存到缓存中，取出时反序列化readOnly=false（默认）
ScheduledCache定时调度的缓存在进行get/put/remove/getSize等操作前，判断缓存时间是否超过了设置的最长缓存时间（默认是一小时），如果是则清空缓存–即每隔一段时间清空一次缓存flushInterval不为空
TransactionalCache事务缓存在二级缓存中使用，可一次存入多个缓存，移除多个缓存在TransactionalCacheManager中用Map维护对应关系

缓存的应用

缓存对应的初始化

在Configuration初始化的时候会为各种Cache实现注册对应的别名

image.png

在解析settings标签的时候，设置的默认值有如下

image.png

cacheEnabled默认为true，localCacheScope默认为 SESSION

在解析映射文件的时候会解析相关的cache标签

image.png

然后解析映射文件的cache标签后会在Configuration对象中添加对应的数据

  private void cacheElement(XNode context) {
    // 只有 cache 标签不为空才解析
    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);
      boolean blocking = context.getBooleanAttribute("blocking", false);
      Properties props = context.getChildrenAsProperties();
      builderAssistant.useNewCache(typeClass, evictionClass, flushInterval, size, readWrite, blocking, props);
    }
  }

image.png

如果存储 cache 标签，那么对应的 Cache对象会被保存在 currentCache 属性中，保存在了 MapperStatement 对象的 cache 属性中。

在openSession的时创建对应的执行器的时候会有缓存的操作

  public Executor newExecutor(Transaction transaction, ExecutorType executorType) {
    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 {
      // 默认 SimpleExecutor
      executor = new SimpleExecutor(this, transaction);
    }
    // 二级缓存开关，settings 中的 cacheEnabled 默认是 true
    if (cacheEnabled) {
      executor = new CachingExecutor(executor);
    }
    // 植入插件的逻辑，至此，四大对象已经全部拦截完毕
    executor = (Executor) interceptorChain.pluginAll(executor);
    return executor;
  }

如果 cacheEnabled 为 true 就会通过 CachingExecutor 来装饰executor 对象，在执行SQL操作的时候会涉及到缓存的具体使用。这个就分为一级缓存和二级缓存.

一级缓存

一级缓存也叫本地缓存（Local Cache），MyBatis的一级缓存是在会话（SqlSession）层面进行缓存的。MyBatis的一级缓存是默认开启的，不需要任何的配置（如果要关闭，localCacheScope设置为STATEMENT）。在BaseExecutor对象的query方法中有关闭一级缓存的逻辑

image.png

因为一级缓存是Session级别的缓存，肯定需要在Session范围内创建，其实PerpetualCache的实例化是在BaseExecutor的构造方法中创建的

  protected BaseExecutor(Configuration configuration, Transaction transaction) {
    this.transaction = transaction;
    this.deferredLoads = new ConcurrentLinkedQueue<>();
    this.localCache = new PerpetualCache("LocalCache");
    this.localOutputParameterCache = new PerpetualCache("LocalOutputParameterCache");
    this.closed = false;
    this.configuration = configuration;
    this.wrapper = this;
  }

一级缓存的具体实现也是在BaseExecutor的query方法中来实现的

public <E> List<E> query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql) throws SQLException {
    // 异常体系之 ErrorContext
    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()) {
      // flushCache="true"时，即使是查询，也清空一级缓存
      clearLocalCache();
    }
    List<E> list;
    try {
      // 防止递归查询重复处理缓存
      queryStack++;
      // 查询一级缓存
      // ResultHandler 和 ResultSetHandler的区别
      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;
  }

一级缓存的验证：

同一个Session中的多个相同操作

    @Test
    public void test1() throws  Exception{
        // 1.获取配置文件
        InputStream in = Resources.getResourceAsStream("mybatis-config.xml");
        // 2.加载解析配置文件并获取SqlSessionFactory对象
        SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);
        // 3.根据SqlSessionFactory对象获取SqlSession对象
        SqlSession sqlSession = factory.openSession();
        // 4.通过SqlSession中提供的 API方法来操作数据库
        List<User> list = sqlSession.selectList("com.mapper.UserMapper.selectUserList");
        System.out.println(list.size());
        // 一级缓存测试
        System.out.println("---------");
        list = sqlSession.selectList("com.mapper.UserMapper.selectUserList");
        System.out.println(list.size());
        // 5.关闭会话
        sqlSession.close();
    }

通过日志的输出结果会看到第二次selectList没有进行sql查询。不同的Session中的相同操作，一级缓存是没有起作用的。

二级缓存

二级缓存是用来解决一级缓存不能跨会话共享的问题的，范围是namespace级别的，可以被多个SqlSession共享。

二级缓存的设置，首先是settings中的cacheEnabled要设置为true，默认的就是为true，这个步骤决定了在创建Executor对象的时候是否通过CachingExecutor来装饰。

image.png

设置了cacheEnabled标签为true后还需要在对应的映射文件中添加 cache 标签才行。

<!-- 声明这个namespace使用二级缓存 -->
<cache type="org.apache.ibatis.cache.impl.PerpetualCache"
      size="1024"  <!—最多缓存对象个数，默认1024-->
      eviction="LRU" <!—回收策略-->
      flushInterval="120000" <!—自动刷新时间 ms，未配置时只有调用时刷新-->
      readOnly="false"/> <!—默认是false（安全），改为true可读写时，对象必须支持序列化 -->

cache属性详解：

属性含义取值
type缓存实现类需要实现Cache接口，默认是PerpetualCache，可以使用第三方缓存
size最多缓存对象个数默认1024
eviction回收策略（缓存淘汰算法）LRU – 最近最少使用的：移除最长时间不被使用的对象（默认）。FIFO – 先进先出：按对象进入缓存的顺序来移除它们。SOFT – 软引用：移除基于垃圾回收器状态和软引用规则的对象。WEAK – 弱引用：更积极地移除基于垃圾收集器状态和弱引用规则的对象。
flushInterval定时自动清空缓存间隔自动刷新时间，单位 ms，未配置时只有调用时刷新
readOnly是否只读true：只读缓存；会给所有调用者返回缓存对象的相同实例。因此这些对象不能被修改。这提供了很重要的性能优势。false：读写缓存；会返回缓存对象的拷贝（通过序列化），不会共享。这会慢一些，但是安全，因此默认是 false。改为false可读写时，对象必须支持序列化。
blocking启用阻塞缓存通过在get/put方式中加锁，保证只有一个线程操作缓存，基于Java重入锁实现

这样的设置表示当前的映射文件中的相关查询操作都会触发二级缓存，但如果某些个别方法我们不希望走二级缓存可以在标签中添加一个 useCache=false 来实现的设置不使用二级缓存。

image.png

当执行的对应的DML操作，在MyBatis中会清空对应的二级缓存和一级缓存。

  private void flushCacheIfRequired(MappedStatement ms) {
    Cache cache = ms.getCache();
    // 增删改查的标签上有属性：flushCache="true" （select语句默认是false）
    // 一级二级缓存都会被清理
    if (cache != null && ms.isFlushCacheRequired()) {
      tcm.clear(cache);
    }
  }

第三方缓存

在实际开发的时候我们一般也很少使用MyBatis自带的二级缓存，这时我们会使用第三方的缓存工具Ehcache或者Redis来实现。

实现步骤：

添加依赖

<dependency>
   <groupId>org.mybatis.caches</groupId>
   <artifactId>mybatis-redis</artifactId>
   <version>1.0.0-beta2</version>
</dependency>

添加redis的属性文件

host=192.168.0.10
port=6379
connectionTimeout=5000
soTimeout=5000
database=0

加上Cache标签的配置

  <cache type="org.mybatis.caches.redis.RedisCache"
         eviction="FIFO" 
         flushInterval="60000" 
         size="512" 
         readOnly="true"/>
更多推荐

【Verilog 教程】3.1 Verilog 连续赋值

关键词：assign，全加器连续赋值语句是Verilog数据流建模的基本语句，用于对wire型变量进行赋值。：格式如下assignLHS_target=RHS_expression；LHS（lefthandside）指赋值操作的左侧，RHS（righthandside）指赋值操作的右侧。assign为关键词，任何已经声

Redis面试二“缓存击穿是什么”

条件缓存击穿是应为Redis某个缓存数据设置了过期时间，而刚好有大并发数据请求这个数据，导致DB有大量请求，引发DB崩溃。第一种方法就是设置互称锁当缓存失效时不立即删除缓存而是用setnx设置一个互斥锁，当操作完成后在loaddb，并回设缓存，否则重试get缓存方法，这样就减少了直接大量访问DB的请求。实现@Servi

Java高级-动态代理

动态代理1.介绍2.案例1.介绍publicinterfaceStar{Stringsing(Stringname);voiddance();}publicclassBigStarimplementsStar{privateStringname;publicBigStar(Stringname){this.name=n

关于ClickHouse的SQL操作

目录clickhouse和mysql的比较5.1create5.2Insert1.标准INSERT2.从表到表的插入5.3Update和Delete1.删除操作2.修改操作clickhouse和mysql的比较共同点：都是关系型数据库，支持SQL查询语言；支持事务处理，具备ACID特性（原子性、一致性、隔离性、持久性）

【多尺度无监督:Pansharpening】

Mun-GAN:AMultiscaleUnsupervisedNetworkforRemoteSensingImagePansharpening(Mun-GAN：一种多尺度无监督遥感图像泛锐化网络)在遥感图像融合中，全色锐化是一种遥感图像融合方法，旨在融合全色（PAN）图像和多光谱（MS）图像，以产生高分辨率的MS（H

ClickHouse(15)ClickHouse合并树MergeTree家族表引擎之GraphiteMergeTree详细解析

GraphiteMergeTree该引擎用来对Graphite数据(图数据)进行瘦身及汇总。对于想使用ClickHouse来存储Graphite数据的开发者来说可能有用。如果不需要对Graphite数据做汇总，那么可以使用任意的ClickHouse表引擎；但若需要，那就采用GraphiteMergeTree引擎。它能减

主打低功耗物联网国产替代，纵行科技ZT1826芯片以速率和灵敏度出圈

在低功耗物联网领域，国产替代的趋势越演越烈。9月20日，纵行科技在“IOTE2023深圳·物联网通信技术与应用高峰论坛”发表了“自主原创AdvancedM-FSK®调制技术助力国产替代和泛在物联”的演讲，并推出了ZT1826芯片，以“更低功耗、更低成本、更高性能”为差异化优势，想在低功耗物联网赛道上开辟出一条“国产替代

C4BUILDER—用于构建C4模型图的Web项目

c4builder是什么？c4builder：字面理解是产生C4架构图的构建器。c4builder是一个轻量级的nodejscli工具，用于仅使用文本构建、维护和共享软件体系结构项目。c4builder是一种架构设计工具，可以帮助开发人员和架构师描述和可视化软件系统的架构，包括系统的组件、关系、依赖和交互。它基于C4模

Git错误解决：如何处理“could not determine hash algorithm“问题

🌷🍁博主猫头虎（🐅🐾）带您GotoNewWorld✨🍁🦄博客首页——🐅🐾猫头虎的博客🎐🐳《面试题大全专栏》🦕文章图文并茂🦖生动形象🐅简单易学！欢迎大家来踩踩~🌺🌊《IDEA开发秘籍专栏》🐾学会IDEA常用操作，工作效率翻倍~💐🌊《100天精通Golang(基础入门篇）》🐅学会Gol

帆软BI开发-Day2-趋势图的多种变形

前言：在BI数据展示中，条形图、趋势图无疑是使用场景非常多的两种图形。与条形图不同的是，趋势图更能反馈出一定的客观规律和未来的趋势走向，因此用于作为预警和判异的业务场景，但实际业务场景的趋势图可没你想的那么简单，今天我们一起来讨论下怎么在帆软上实现复杂的趋势图的需求吧。一、自我介绍-趋势图1、自我介绍帆软趋势图是一种基

CSS的var()函数用法与JS获取css函数变量值的方法

项目场景我们常在项目里见到这种写法。<template><divid="dashboardLayout":style="styleCSSVariable"></div></template>可以看到，根元素这里使用了一个名为styleCSSVariable的CSS集。这里的实现是：getstyleCSSVariable

热文推荐
  1. WebGL 初始化着色器

    目录前言初始化着色器的7个步骤创建着色器对象（gl.createShader（））gl.createShader（）规范gl.deleteShader（）规范指定着色器对象的代码（gl.shaderSource（））gl.shaderSource（）规范编译着色器（gl.compileShader（））gl.compi

  2. 动力节点老杜JavaWeb笔记(全)

    Servlet关于系统架构系统架构包括什么形式？C/S架构B/S架构C/S架构？Client/Server（客户端/服务器）C/S架构的软件或者说系统有哪些呢？QQ（先去腾讯官网下载一个QQ软件，几十MB，然后把这个客户端软件安装上去，然后输入QQ号以及密码，登录之后，就可以和你的朋友聊天了，就可以使用这个软件了。）C

  3. 为何学linux及用处

    为何学linux及用处目前企业使用的操作系统无非就是国产类的，windows和linux类。我们要提升自己的技能，需要学习这两款。我记得在大学时期，学习过windows以及linux，但当时觉得又不常用，就学的模棱两可。毕业之后，你会发现，其实这两种操作系统是很主流的。为什么学？下面就是一些工作中遇到的例子分享一下。我

  4. golang 结合 cobra 使用 chatgpt qdrant 实现 ai知识库 cli

    golang结合cobra使用chatgptqdrant实现ai知识库cli流程将数据集通过openaiembedding得到向量+组装payload,存入qdrant用户进行问题搜索,通过openaiembedding得到向量,从qdrant中搜索相似度大于0.8的数据从qdrant中取出数据得到参考答案将问题标题+

  5. js兼容性的汇总

    js兼容问题大多是在ie浏览器低版本以及ie浏览器和不同普通浏览器的差异事件对象document.onclick=function(ev){//谷歌火狐的写法，IE9以上支持，往下不支持；vare=ev;console.log(e);}document.onclick=function(){//谷歌和IE支持，火狐不支

  6. css3动画基础详解（@keyframes和animation）

    动画是使元素从一种样式逐渐变化为另外一种效果，CSS3动画的生成，主要依赖@keyframes定义动画，animation执行动画。@keyframes通过@keyframes规则创建动画。@keyframeskeyframes-name{keyframes-selector{css-styles;}}keyframe

  7. 【数据结构】哈希表（详）

    文章目录前言正文一、基本概念二、基本原理1.哈希函数1.1直接定址法（常用）1.2除留余数法（常用）1.3平方取中法（了解）1.4折叠法(了解)1.5随机数法(了解)1.6数学分析法(了解)2.哈希冲突2.1平均查找长度2.2负载因子2.3闭散列(开放定制法)2.1.1线性探测2.1.2二次探测2.1.3二重哈希2.4

  8. MySQL 8.0 OCP (1Z0-908) 考点精析-架构考点5：数据字典(Data Dictionary)

    文章目录MySQL8.0OCP(1Z0-908)考点精析-架构考点5：数据字典(DataDictionary)File-basedMetadataStorage（基于文件的元数据存储）TransactionalDataDictionary（事务数据字典）SerializedDictionaryInformation(S

  9. 相机One Shot标定

    1原理说明原理部分网上其他文章[1][2]也已经说的比较明白了，这里不再赘述。2总体流程参考论文作者开源的Matlab代码[3]和github上的C++代码[4]进行说明（不得不说还是Matlab代码更优雅）论文方法总体分两部，第一部是在画面中找到所有的类棋盘格角点，第二步是角点的基础上构建出棋盘格形状。3模块说明3.