使用ehcache三步搞定springboot缓存的方法示例

2023-08-24 21:41:05 193

本次内容主要介绍基于Ehcache3.0来快速实现SpringBoot应用程序的数据缓存功能。在SpringBoot应用程序中，我们可以通过SpringCaching来快速搞定数据缓存。接下来我们将介绍如何在三步之内搞定SpringBoot缓存。

1.创建一个SpringBoot工程并添加Maven依赖

你所创建的SpringBoot应用程序的maven依赖文件至少应该是下面的样子：



4.0.0

org.springframework.boot
spring-boot-starter-parent
2.1.3.RELEASE


com.ramostear
cache
0.0.1-SNAPSHOT
cache
DemoprojectforSpringBoot


1.8




org.springframework.boot
spring-boot-starter-cache


org.springframework.boot
spring-boot-starter-web


org.ehcache
ehcache


javax.cache
cache-api


org.springframework.boot
spring-boot-starter-test
test


org.projectlombok
lombok






org.springframework.boot
spring-boot-maven-plugin

依赖说明：

spring-boot-starter-cache为SpringBoot应用程序提供缓存支持
ehcache提供了Ehcache的缓存实现
cache-api提供了基于JSR-107的缓存规范

2.配置Ehcache缓存

现在，需要告诉SpringBoot去哪里找缓存配置文件，这需要在SpringBoot配置文件中进行设置：

spring.cache.jcache.config=classpath:ehcache.xml

然后使用@EnableCaching注解开启SpringBoot应用程序缓存功能，你可以在应用主类中进行操作：

packagecom.ramostear.cache;

importorg.springframework.boot.SpringApplication;
importorg.springframework.boot.autoconfigure.SpringBootApplication;
importorg.springframework.cache.annotation.EnableCaching;

@SpringBootApplication
@EnableCaching
publicclassCacheApplication{

publicstaticvoidmain(String[]args){
SpringApplication.run(CacheApplication.class,args);
}
}

接下来，需要创建一个ehcache的配置文件，该文件放置在类路径下，如resources目录下：







java.lang.Long
com.ramostear.cache.entity.Person

1



com.ramostear.cache.config.PersonCacheEventLogger
ASYNCHRONOUS
UNORDERED
CREATED
UPDATED
EXPIRED
REMOVED
EVICTED



2000
100

最后，还需要定义个缓存事件监听器，用于记录系统操作缓存数据的情况，最快的方法是实现CacheEventListener接口：

packagecom.ramostear.cache.config;

importorg.ehcache.event.CacheEvent;
importorg.ehcache.event.CacheEventListener;
importorg.slf4j.Logger;
importorg.slf4j.LoggerFactory;

/**
*@authorramostear
*@create-time2019/4/70007-0:48
*@modifyby:
*@since:
*/
publicclassPersonCacheEventLoggerimplementsCacheEventListener{

privatestaticfinalLoggerlogger=LoggerFactory.getLogger(PersonCacheEventLogger.class);

@Override
publicvoidonEvent(CacheEventcacheEvent){
logger.info("personcachingevent{}{}{}{}",
cacheEvent.getType(),
cacheEvent.getKey(),
cacheEvent.getOldValue(),
cacheEvent.getNewValue());
}
}

3.使用@Cacheable注解对方法进行注释

要让SpringBoot能够缓存我们的数据，还需要使用@Cacheable注解对业务方法进行注释，告诉SpringBoot该方法中产生的数据需要加入到缓存中：

packagecom.ramostear.cache.service;

importcom.ramostear.cache.entity.Person;
importorg.springframework.cache.annotation.Cacheable;
importorg.springframework.stereotype.Service;

/**
*@authorramostear
*@create-time2019/4/70007-0:51
*@modifyby:
*@since:
*/
@Service(value="personService")
publicclassPersonService{

@Cacheable(cacheNames="person",key="#id")
publicPersongetPerson(Longid){
Personperson=newPerson(id,"ramostear","ramostear@163.com");
returnperson;
}
}

通过以上三个步骤，我们就完成了SpringBoot的缓存功能。接下来，我们将测试一下缓存的实际情况。

4.缓存测试

为了测试我们的应用程序，创建一个简单的Restful端点，它将调用PersonService返回一个Person对象：

packagecom.ramostear.cache.controller;

importcom.ramostear.cache.entity.Person;
importcom.ramostear.cache.service.PersonService;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.http.HttpStatus;
importorg.springframework.http.ResponseEntity;
importorg.springframework.web.bind.annotation.GetMapping;
importorg.springframework.web.bind.annotation.PathVariable;
importorg.springframework.web.bind.annotation.RequestMapping;
importorg.springframework.web.bind.annotation.RestController;


/**
*@authorramostear
*@create-time2019/4/70007-0:54
*@modifyby:
*@since:
*/
@RestController
@RequestMapping("/persons")
publicclassPersonController{

@Autowired
privatePersonServicepersonService;

@GetMapping("/{id}")
publicResponseEntityperson(@PathVariable(value="id")Longid){
returnnewResponseEntity<>(personService.getPerson(id),HttpStatus.OK);
}
}

Person是一个简单的POJO类：

packagecom.ramostear.cache.entity;
importlombok.AllArgsConstructor;
importlombok.Getter;
importlombok.NoArgsConstructor;
importlombok.Setter;

importjava.io.Serializable;

/**
*@authorramostear
*@create-time2019/4/70007-0:45
*@modifyby:
*@since:
*/
@Getter
@Setter
@AllArgsConstructor
@NoArgsConstructor
publicclassPersonimplementsSerializable{

privateLongid;

privateStringusername;

privateStringemail;
}

以上准备工作都完成后，让我们编译并运行应用程序。项目成功启动后，使用浏览器打开：http://localhost:8080/persons/1,你将在浏览器页面中看到如下的信息：

{"id":1,"username":"ramostear","email":"ramostear@163.com"}

此时在观察控制台输出的日志信息：

2019-04-0701:08:01.001 INFO6704---[nio-8080-exec-1]o.s.web.servlet.DispatcherServlet :Completedinitializationin5ms
2019-04-0701:08:01.054 INFO6704---[e[_default_]-0]c.r.cache.config.PersonCacheEventLogger :personcachingeventCREATED1nullcom.ramostear.cache.entity.Person@ba8a729

由于我们是第一次请求API，没有任何缓存数据。因此，Ehcache创建了一条缓存数据，可以通过CREATED看一了解到。

我们在ehcache.xml文件中将缓存过期时间设置成了1分钟（1），因此在一分钟之内我们刷新浏览器，不会看到有新的日志输出，一分钟之后，缓存过期，我们再次刷新浏览器，将看到如下的日志输出：

2019-04-0701:09:28.612 INFO6704---[e[_default_]-1]c.r.cache.config.PersonCacheEventLogger :personcachingeventEXPIRED1com.ramostear.cache.entity.Person@a9f3c57null
2019-04-0701:09:28.612 INFO6704---[e[_default_]-1]c.r.cache.config.PersonCacheEventLogger :personcachingeventCREATED1nullcom.ramostear.cache.entity.Person@416900ce

第一条日志提示缓存已经过期，第二条日志提示Ehcache重新创建了一条缓存数据。

结束语

在本次案例中，通过简单的三个步骤，讲解了基于Ehcache的SpringBoot应用程序缓存实现。文章内容重在缓存实现的基本步骤与方法，简化了具体的业务代码，有兴趣的朋友可以自行扩展，期间遇到问题也可以随时与我联系。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持毛票票。

使用ehcache三步搞定springboot缓存的方法示例

热门推荐

随机推荐