SpringBoot整合Ehcache3

2024-09-06 13:18
文章标签 java springboot spring 整合 ehcache3

本文主要是介绍SpringBoot整合Ehcache3，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

前言

公司部门老项目要迁移升级java版本，需要进行缓存相关操作，原框架未支持这部分，经过调研java相关缓存方案大致分为ehcache和redis两种，redis的value最大值为500mb且超过1mb会对存取有性能影响，业务系统需要支持列表查询缓存就不可避免的涉及到大量的数据存取过滤，ehcache支持内存+磁盘缓存不用担心缓存容量问题，所以框架初步版本决定集成ehcache3，设计流程结构如下图所示

缓存配置

maven引用

        <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-cache</artifactId></dependency><dependency><groupId>org.ehcache</groupId><artifactId>ehcache</artifactId></dependency>

个性化配置

  #缓存配置cache:ehcache:heap: 1000offheap: 100disk: 500diskDir: tempfiles/cache/

@Component
@ConfigurationProperties("frmae.cache.ehcache")
public class EhcacheConfiguration {/*** ehcache heap大小* jvm内存中缓存的key数量*/private int heap;/*** ehcache offheap大小* 堆外内存大小, 单位: MB*/private int offheap;/*** 磁盘持久化目录*/private String diskDir;/*** ehcache disk* 持久化到磁盘的大小, 单位: MB* diskDir有效时才生效*/private int disk;public EhcacheConfiguration(){heap = 1000;offheap = 100;disk = 500;diskDir = "tempfiles/cache/";}
}

代码注入配置

因为springboot默认缓存优先注入redis配置，所以需要手动声明bean进行注入，同时ehcache的value值必须支持序列化接口，不能使用Object代替，这里声明一个缓存基类，所有缓存value对象必须继承该类

public class BaseSystemObject implements Serializable {}

@Configuration
@EnableCaching
public class EhcacheConfig {@Autowiredprivate EhcacheConfiguration ehcacheConfiguration;@Autowiredprivate ApplicationContext context;@Bean(name = "ehCacheManager")public CacheManager getCacheManager() {//资源池生成器配置持久化ResourcePoolsBuilder resourcePoolsBuilder = 				  ResourcePoolsBuilder.newResourcePoolsBuilder()// 堆内缓存大小.heap(ehcacheConfiguration.getHeap(), EntryUnit.ENTRIES)// 堆外缓存大小.offheap(ehcacheConfiguration.getOffheap(), MemoryUnit.MB)// 文件缓存大小.disk(ehcacheConfiguration.getDisk(), MemoryUnit.MB);//生成配置ExpiryPolicy expiryPolicy = ExpiryPolicyBuilder.noExpiration();CacheConfiguration config = CacheConfigurationBuilder.newCacheConfigurationBuilder(String.class, BaseSystemObject.class, resourcePoolsBuilder)//设置永不过期.withExpiry(expiryPolicy).build();CacheManagerBuilder cacheManagerBuilder = CacheManagerBuilder.newCacheManagerBuilder().with(CacheManagerBuilder.persistence(ehcacheConfiguration.getDiskDir()));return cacheManagerBuilder.build(true);}
}

缓存操作

缓存预热

针对缓存框架选择的双写策略，即数据库和缓存同时写入，所以在系统启动时需要预先将数据库数据加载到缓存中

针对单表声明自定义注解，个性化缓存定义自定义接口

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface HPCache {}
public interface IHPCacheInitService {String getCacheName();void initCache();
}

系统初始化时同步进行缓存初始化，扫描注解实体类与接口实现Bean

@Asyncpublic void initCache(Class runtimeClass, List<String> extraPackageNameList) {List<Class<?>> cacheEntityList = new ArrayList<>();if (!runtimeClass.getPackage().getName().equals(Application.class.getPackage().getName())) {cacheEntityList.addAll(ScanUtil.getAllClassByPackageName_Annotation(runtimeClass.getPackage(), HPCache.class));}for (String packageName : extraPackageNameList) {cacheEntityList.addAll(ScanUtil.getAllClassByPackageName_Annotation(packageName, HPCache.class));}for (Class clazz : cacheEntityList) {TableName tableName = (TableName) clazz.getAnnotation(TableName.class);List<LinkedHashMap<String, Object>> resultList = commonDTO.selectList(tableName.value(), "*", "1=1", "", new HashMap<>(), false);for (LinkedHashMap<String, Object> map : resultList) {Cache cache = cacheManager.getCache(clazz.getName(), String.class, BaseSystemObject.class);String unitguid = ConvertOp.convert2String(map.get("UnitGuid"));try {Object obj = clazz.newInstance();obj = ConvertOp.convertLinkHashMapToBean(map, obj);cache.put(unitguid, obj);} catch (Exception e) {e.printStackTrace();}}}//自定义缓存Map<String, IHPCacheInitService> res = context.getBeansOfType(IHPCacheInitService.class);for (Map.Entry en : res.entrySet()) {IHPCacheInitService service = (IHPCacheInitService) en.getValue();service.initCache();}System.out.println("缓存初始化完毕");}

需要注意，在EhcacheConfig配置类中需要进行缓存名称的提前注册，否则会导致操作缓存时空指针异常

    Map<String, Object> annotatedBeans = context.getBeansWithAnnotation(SpringBootApplication.class);Class runtimeClass = annotatedBeans.values().toArray()[0].getClass();//do，dao扫描List<String> extraPackageNameList = new ArrayList<String>();extraPackageNameList.add(Application.class.getPackage().getName());List<Class<?>> cacheEntityList = new ArrayList<>();if (!runtimeClass.getPackage().getName().equals(Application.class.getPackage().getName())) {cacheEntityList.addAll(ScanUtil.getAllClassByPackageName_Annotation(runtimeClass.getPackage(), HPCache.class));}for (String packageName : extraPackageNameList) {cacheEntityList.addAll(ScanUtil.getAllClassByPackageName_Annotation(packageName, HPCache.class));}for (Class clazz : cacheEntityList) {cacheManagerBuilder = cacheManagerBuilder.withCache(clazz.getName(), config);}//自定义缓存Map<String, IHPCacheInitService> res = context.getBeansOfType(IHPCacheInitService.class);for (Map.Entry en :res.entrySet()) {IHPCacheInitService service = (IHPCacheInitService)en.getValue();cacheManagerBuilder = cacheManagerBuilder.withCache(service.getCacheName(), config);}

更新操作

手动获取ehcache的bean对象，调用put，repalce，delete方法进行操作

   	private  CacheManager cacheManager = (CacheManager) SpringBootBeanUtil.getBean("ehCacheManager");public void executeUpdateOperation(String cacheName, String key, BaseSystemObject value) {Cache cache = cacheManager.getCache(cacheName, String.class, BaseSystemObject.class);if (cache.containsKey(key)) {cache.replace(key, value);} else {cache.put(key, value);}}public void executeDeleteOperation(String cacheName, String key) {Cache cache = cacheManager.getCache(cacheName, String.class, BaseSystemObject.class);cache.remove(key);}

查询操作

缓存存储单表以主键—object形式存储，个性化缓存为key-object形式存储，单条记录可以通过getCache方法查询，列表查询需要取出整个缓存按条件进行过滤

 public Object getCache(String cacheName, String key){Cache cache = cacheManager.getCache(cacheName, String.class, BaseSystemObject.class);return cache.get(key);}public List<Object> getAllCache(String cacheName){List result = new ArrayList<>();Cache cache = cacheManager.getCache(cacheName, String.class, BaseSystemObject.class);Iterator iter = cache.iterator();while (iter.hasNext()) {Cache.Entry entry = (Cache.Entry) iter.next();result.add(entry.getValue());}return result;}

缓存与数据库数据一致性

数据库数据操作与缓存操作顺序为先操作数据后操作缓存，在开启数据库事务的情况下针对单条数据单次操作是没有问题的，如果是组合操作一旦数据库操作发生异常回滚，缓存并没有回滚就会导致数据的不一致，比如执行顺序为dbop1=》cacheop1=》dbop2=》cacheop2，dbop2异常，cacheop1的操作已经更改了缓存

这里选择的方案是在数据库全部执行完毕后统一操作缓存，这个方案有一个***缺点是如果缓存操作发生异常还是会出现上述问题***，实际过程中缓存只是对内存的操作异常概率较小，对缓存操作持乐观状态，同时我们提供手动重置缓存的功能，算是一个折中方案，下面概述该方案的一个实现

声明自定义缓存事务注解

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface CacheTransactional {}

声明切面监听，在标记了CacheTransactional注解的方法执行前进行Redis标识，统一执行完方法体后执行缓存操作

@Aspect
@Component
@Order(value = 101)
public class CacheExecuteAspect {@Autowiredprivate CacheExecuteUtil cacheExecuteUtil;/*** 切面点 指定注解*/@Pointcut("@annotation(com.haopan.frame.common.annotation.CacheTransactional) " +"|| @within(com.haopan.frame.common.annotation.CacheTransactional)")public void cacheExecuteAspect() {}/*** 拦截方法指定为 repeatSubmitAspect*/@Around("cacheExecuteAspect()")public Object around(ProceedingJoinPoint point) throws Throwable {MethodSignature signature = (MethodSignature) point.getSignature();Method method = signature.getMethod();CacheTransactional cacheTransactional = method.getAnnotation(CacheTransactional.class);if (cacheTransactional != null) {cacheExecuteUtil.putCacheIntoTransition();try{Object obj = point.proceed();cacheExecuteUtil.executeOperation();return obj;}catch (Exception e){e.printStackTrace();throw  e;}} else {return point.proceed();}}
}

将缓存操作以线程id区分放入待执行队列中序列化到redis，提供方法统一操作

public class CacheExecuteModel implements Serializable {private String obejctClazzName;private String cacheName;private String key;private BaseSystemObject value;private String executeType;
}

private  CacheManager cacheManager = (CacheManager) SpringBootBeanUtil.getBean("ehCacheManager");@Autowiredprivate RedisUtil redisUtil;public void putCacheIntoTransition(){String threadID = Thread.currentThread().getName();System.out.println("init threadid:"+threadID);CacheExecuteModel cacheExecuteModel = new CacheExecuteModel();cacheExecuteModel.setExecuteType("option");redisUtil.redisTemplateSetForCollection(threadID,cacheExecuteModel, GlobalEnum.RedisDBNum.Cache.get_value());redisUtil.setExpire(threadID,5, TimeUnit.MINUTES, GlobalEnum.RedisDBNum.Cache.get_value());}public void putCache(String cacheName, String key, BaseSystemObject value) {if(checkCacheOptinionInTransition()){String threadID = Thread.currentThread().getName();CacheExecuteModel cacheExecuteModel = new CacheExecuteModel("update", cacheName, key, value.getClass().getName(),value);redisUtil.redisTemplateSetForCollection(threadID,cacheExecuteModel, GlobalEnum.RedisDBNum.Cache.get_value());redisUtil.setExpire(threadID,5, TimeUnit.MINUTES, GlobalEnum.RedisDBNum.Cache.get_value());}else{executeUpdateOperation(cacheName,key,value);}}public void deleteCache(String cacheName, String key) {if(checkCacheOptinionInTransition()){String threadID = Thread.currentThread().getName();CacheExecuteModel cacheExecuteModel = new CacheExecuteModel("delete", cacheName, key);redisUtil.redisTemplateSetForCollection(threadID,cacheExecuteModel, GlobalEnum.RedisDBNum.Cache.get_value());redisUtil.setExpire(threadID,5, TimeUnit.MINUTES, GlobalEnum.RedisDBNum.Cache.get_value());}else{executeDeleteOperation(cacheName,key);}}public void executeOperation(){String threadID = Thread.currentThread().getName();if(checkCacheOptinionInTransition()){List<LinkedHashMap> executeList =  redisUtil.redisTemplateGetForCollectionAll(threadID, GlobalEnum.RedisDBNum.Cache.get_value());for (LinkedHashMap obj:executeList) {String executeType = ConvertOp.convert2String(obj.get("executeType"));if(executeType.contains("option")){continue;}String obejctClazzName = ConvertOp.convert2String(obj.get("obejctClazzName"));String cacheName = ConvertOp.convert2String(obj.get("cacheName"));String key = ConvertOp.convert2String(obj.get("key"));LinkedHashMap valueMap = (LinkedHashMap)obj.get("value");String valueMapJson =  JSON.toJSONString(valueMap);try{Object valueInstance = JSON.parseObject(valueMapJson,Class.forName(obejctClazzName));if(executeType.equals("update")){executeUpdateOperation(cacheName,key,(BaseSystemObject)valueInstance);}else if(executeType.equals("delete")){executeDeleteOperation(cacheName,key);}}catch (Exception e){e.printStackTrace();}}redisUtil.redisTemplateRemove(threadID,GlobalEnum.RedisDBNum.Cache.get_value());}}public boolean checkCacheOptinionInTransition(){String threadID = Thread.currentThread().getName();System.out.println("check threadid:"+threadID);return redisUtil.isValid(threadID, GlobalEnum.RedisDBNum.Cache.get_value());}

这篇关于SpringBoot整合Ehcache3的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1142107。

相关文章

springboot集成easypoi导出word换行处理过程

springboot集成easypoi导出word换行处理过程

《springboot集成easypoi导出word换行处理过程》SpringBoot集成Easypoi导出Word时,换行符n失效显示为空格,解决方法包括生成段落或替换模板中n为回车,同时需确... 目录项目场景问题描述解决方案第一种：生成段落的方式第二种：替换模板的情况，换行符替换成回车总结项目场景s
阅读更多...
SpringBoot集成redisson实现延时队列教程

SpringBoot集成redisson实现延时队列教程

《SpringBoot集成redisson实现延时队列教程》文章介绍了使用Redisson实现延迟队列的完整步骤,包括依赖导入、Redis配置、工具类封装、业务枚举定义、执行器实现、Bean创建、消费... 目录1、先给项目导入Redisson依赖2、配置redis3、创建 RedissonConfig 配
阅读更多...
SpringBoot中@Value注入静态变量方式

SpringBoot中@Value注入静态变量方式

《SpringBoot中@Value注入静态变量方式》SpringBoot中静态变量无法直接用@Value注入,需通过setter方法,@Value(${})从属性文件获取值,@Value(#{})用... 目录项目场景解决方案注解说明1、@Value("${}")使用示例2、@Value("#{}"php
阅读更多...
SpringBoot分段处理List集合多线程批量插入数据方式

SpringBoot分段处理List集合多线程批量插入数据方式

《SpringBoot分段处理List集合多线程批量插入数据方式》文章介绍如何处理大数据量List批量插入数据库的优化方案：通过拆分List并分配独立线程处理,结合Spring线程池与异步方法提升效率... 目录项目场景解决方案1.实体类2.Mapper3.spring容器注入线程池bejsan对象4.创建
阅读更多...
线上Java OOM问题定位与解决方案超详细解析

线上Java OOM问题定位与解决方案超详细解析

《线上JavaOOM问题定位与解决方案超详细解析》OOM是JVM抛出的错误,表示内存分配失败,：本文主要介绍线上JavaOOM问题定位与解决方案的相关资料,文中通过代码介绍的非常详细,需要的朋... 目录一、OOM问题核心认知1.1 OOM定义与技术定位1.2 OOM常见类型及技术特征二、OOM问题定位工具
阅读更多...
基于 Cursor 开发 Spring Boot 项目详细攻略

基于 Cursor 开发 Spring Boot 项目详细攻略

《基于Cursor开发SpringBoot项目详细攻略》Cursor是集成GPT4、Claude3.5等LLM的VSCode类AI编程工具,支持SpringBoot项目开发全流程,涵盖环境配... 目录cursor是什么？基于 Cursor 开发 Spring Boot 项目完整指南1. 环境准备2. 创建
阅读更多...
Spring Security简介、使用与最佳实践

Spring Security简介、使用与最佳实践

《SpringSecurity简介、使用与最佳实践》SpringSecurity是一个能够为基于Spring的企业应用系统提供声明式的安全访问控制解决方案的安全框架,本文给大家介绍SpringSec... 目录一、如何理解 Spring Security？—— 核心思想二、如何在 Java 项目中使用？——
阅读更多...
SpringBoot+RustFS 实现文件切片极速上传的实例代码

SpringBoot+RustFS 实现文件切片极速上传的实例代码

《SpringBoot+RustFS实现文件切片极速上传的实例代码》本文介绍利用SpringBoot和RustFS构建高性能文件切片上传系统,实现大文件秒传、断点续传和分片上传等功能,具有一定的参考... 目录一、为什么选择 RustFS + SpringBoot？二、环境准备与部署2.1 安装 RustF
阅读更多...
springboot中使用okhttp3的小结

springboot中使用okhttp3的小结

《springboot中使用okhttp3的小结》OkHttp3是一个JavaHTTP客户端,可以处理各种请求类型,比如GET、POST、PUT等,并且支持高效的HTTP连接池、请求和响应缓存、以及异... 在 Spring Boot 项目中使用 OkHttp3 进行 HTTP 请求是一个高效且流行的方式。
阅读更多...
java.sql.SQLTransientConnectionException连接超时异常原因及解决方案

java.sql.SQLTransientConnectionException连接超时异常原因及解决方案

《java.sql.SQLTransientConnectionException连接超时异常原因及解决方案》：本文主要介绍java.sql.SQLTransientConnectionExcep... 目录一、引言二、异常信息分析三、可能的原因3.1 连接池配置不合理3.2 数据库负载过高3.3 连接泄漏
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2