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。

相关文章

JVM 的类初始化机制

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时，有没有考虑过 JVM 是如何把静态的字节码（byte code）转化为运行时对象的呢，这个问题看似简单，但清楚的同学相信也不会太多，这篇文章首先介绍 JVM 类初始化的机制，然后给出几个易出错的实例来分析，帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段，分别是：loading 、Linking、initialization
阅读更多...
Spring Security 基于表达式的权限控制

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权，允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true （Spring security默认会带有ROLE_前缀）,去
阅读更多...
浅析Spring Security认证过程

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程，特意画了如下的类图，包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口，接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti
阅读更多...
Spring Security--Architecture Overview

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类，它们之间的依赖，构建起了整个框架。想要理解整个架构，最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文（security context）的信息。当前操作的用户是谁，该用户是否已经被认证，他拥有哪些角色权限…这些都被保
阅读更多...
Spring Security基于数据库验证流程详解

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明（认真看哦） AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证，则会调用 #attemptAuthentica
阅读更多...
Spring Security 从入门到进阶系列教程

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门（一）：登录与退出》 《Spring-Security-入门（二）：基于数据库验证》 《Spring-Security-入门（三）：密码加密》 《Spring-Security-入门（四）：自定义-Filter》 《Spring-Security-入门（五）：在 Sprin
阅读更多...
Java架构师知识体认识

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物
阅读更多...
Java进阶13讲__第12讲_1/2

Java进阶13讲__第12讲_1/2

多线程、线程池 1.  线程概念 1.1  什么是线程 1.2  线程的好处 2.   创建线程的三种方式 注意事项 2.1  继承Thread类 2.1.1 认识  2.1.2  编码实现  package cn.hdc.oop10.Thread;import org.slf4j.Logger;import org.slf4j.LoggerFactory
阅读更多...
JAVA智听未来一站式有声阅读平台听书系统小程序源码

JAVA智听未来一站式有声阅读平台听书系统小程序源码

智听未来，一站式有声阅读平台听书系统 🌟&nbsp;开篇：遇见未来，从“智听”开始 在这个快节奏的时代，你是否渴望在忙碌的间隙，找到一片属于自己的宁静角落？是否梦想着能随时随地，沉浸在知识的海洋，或是故事的奇幻世界里？今天，就让我带你一起探索“智听未来”——这一站式有声阅读平台听书系统，它正悄悄改变着我们的阅读方式，让未来触手可及！ 📚&nbsp;第一站：海量资源，应有尽有 走进“智听
阅读更多...
在cscode中通过maven创建java项目

在cscode中通过maven创建java项目

在cscode中创建java项目 可以通过博客完成maven的导入 建立maven项目 使用快捷键 Ctrl + Shift + P 建立一个 Maven 项目 1 Ctrl + Shift + P 打开输入框2 输入 "> java create"3 选择 maven4 选择 No Archetype5 输入 域名6 输入项目名称7 建立一个文件目录存放项目，文件名一般为项目名8 确定
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2