SpringBoot Ehcache初步使用

最新推荐文章于 2024-10-06 11:20:13 发布

原创最新推荐文章于 2024-10-06 11:20:13 发布 · 405 阅读

CC 4.0 BY-SA版权

本文介绍了如何在SpringBoot项目中使用Ehcache作为缓存工具，包括导入Ehcache jar包，启用缓存功能，配置Ehcache，创建ehcache.xml配置文件，使用@Cacheable和@CacheEvict注解实现缓存操作，并解决因key生成问题可能导致的错误。通过重写KeyGenerator接口确保缓存的正确性。

由于缓存是在单机使用的，因此根据文章https://www.cnblogs.com/qlqwjy/p/7788912.html的提示，使用的Ehcache，而不使用Redis作为缓存工具。

第一步，导入jar包。

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

第二步，让SpringBoot知道你打算用缓存了，即增加EnableCaching注解。

@SpringBootApplication
@EnableCaching
public class ManualSpringbootApplication {
	public static void main(String[] args) {
		SpringApplication.run(ManualSpringbootApplication.class, args);
	}
}

第三步，让spring知道你想用的是Ehcache缓存，而不是其他的缓存，在springboot的配置文件中增加缓存配置。

###############ehcache配置##################
# 配置ehcache缓存
spring.cache.type=ehcache
# 指定ehcache配置文件路径
spring.cache.ehcache.config=classpath:/ehcache.xml

第四步，你看第三步里面指定了ehcache的配置文件为classpath:/ehcache.xml，那就在classpath中增加这个文件吧！我的classpath没变，还是在resources下面，配置文件的内容如下。

<?xml version="1.0" encoding="UTF-8"?>

<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:noNamespaceSchemaLocation="http://ehcache.org/ehcache.xsd"
	updateCheck="false">
	<defaultCache eternal="false" maxElementsInMemory="1000"
		overflowToDisk="false" diskPersistent="false" timeToIdleSeconds="0"
		timeToLiveSeconds="600" memoryStoreEvictionPolicy="LRU" />
	<cache name="temp1" eternal="false"
		maxElementsInMemory="100" overflowToDisk="false"
		diskPersistent="false" timeToIdleSeconds="0" timeToLiveSeconds="300"
		memoryStoreEvictionPolicy="LRU" />
</ehcache>

第五步，告诉SpringBoot，你要存什么。在你需要将结果存入缓存的方法上增加注解。注解有@Cacheable ,@CacheEvict等等，各个注解的使用可以百度一下，到处都是。由于我的方法对数据库只作查询，所以只用了@Cacheable注解。并且在此方法的类上使用了@CacheConfig注解。由于springBoot自带了key的生成方式，至此，就可以使用缓存了。

@CacheConfig(cacheNames ="temp1")
public class SaleAmountService {

	@Autowired
	SaleAmountMapper saleAmountMapper;
        
        @Cacheable
        someResult getResult(SomeParameter param){
            return someResult;
        }
}

类上注明的cacheNames一定在配置文件cache标签内出现了，否则会出现Cannot find cache named ‘temp1’ for Builder的错误。

第六步，重新定义缓存的key生成方式。由于类的方法挺多，难免出现了不同的方法名，相同的参数。为了防止出现在查询缓存时出错，重写KeyGenerator接口，代码参加博客https://www.jianshu.com/p/2a584aaafad3。