Три шага, чтобы получить кеширование Spring Boot
Этот контент в основном знакомит с функцией кэширования данных приложения Spring Boot на основе Ehcache 3.0. В приложениях Spring Boot мы можем быстро получить кэширование данных с помощью Spring Caching. Далее мы расскажем, как получить кэширование Spring Boot за три шага.
1. Создайте проект Spring Boot и добавьте зависимости Maven.
Зависимости maven вашего приложения Spring Boot должны выглядеть как минимум так:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.3.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.ramostear</groupId>
<artifactId>cache</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>cache</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-cache</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.ehcache</groupId>
<artifactId>ehcache</artifactId>
</dependency>
<dependency>
<groupId>javax.cache</groupId>
<artifactId>cache-api</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
Описание зависимости:
- spring-boot-starter-cache обеспечивает поддержку кэширования для приложений Spring Boot.
- ehcache обеспечивает кеш-реализацию Ehcache.
- cache-api предоставляет спецификацию кэша на основе JSR-107.
2. Настройте кеш Ehcache
Теперь вам нужно указать Spring Boot, где искать файл конфигурации кеша, который необходимо установить в файле конфигурации Spring Boot:
spring.cache.jcache.config=classpath:ehcache.xml
Затем используйте аннотацию @EnableCaching, чтобы включить кэширование приложений Spring Boot, что вы можете сделать в основном классе приложения:
package com.ramostear.cache;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cache.annotation.EnableCaching;
@SpringBootApplication
@EnableCaching
public class CacheApplication {
public static void main(String[] args) {
SpringApplication.run(CacheApplication.class, args);
}
}
Затем вам нужно создать файл конфигурации ehcache, который помещается в путь к классам, например, в каталог ресурсов:
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.ehcache.org/v3"
xmlns:jsr107="http://www.ehcache.org/v3/jsr107"
xsi:schemaLocation="
http://www.ehcache.org/v3 http://www.ehcache.org/schema/ehcache-core-3.0.xsd
http://www.ehcache.org/v3/jsr107 http://www.ehcache.org/schema/ehcache-107-ext-3.0.xsd">
<service>
<jsr107:defaults enable-statistics="true"/>
</service>
<cache alias="person">
<key-type>java.lang.Long</key-type>
<value-type>com.ramostear.cache.entity.Person</value-type>
<expiry>
<ttl unit="minutes">1</ttl>
</expiry>
<listeners>
<listener>
<class>com.ramostear.cache.config.PersonCacheEventLogger</class>
<event-firing-mode>ASYNCHRONOUS</event-firing-mode>
<event-ordering-mode>UNORDERED</event-ordering-mode>
<events-to-fire-on>CREATED</events-to-fire-on>
<events-to-fire-on>UPDATED</events-to-fire-on>
<events-to-fire-on>EXPIRED</events-to-fire-on>
<events-to-fire-on>REMOVED</events-to-fire-on>
<events-to-fire-on>EVICTED</events-to-fire-on>
</listener>
</listeners>
<resources>
<heap unit="entries">2000</heap>
<offheap unit="MB">100</offheap>
</resources>
</cache>
</config>
Наконец, вам также необходимо определить прослушиватель событий кеша для записи операций системы с кэшированными данными.Самый быстрый способ — реализовать интерфейс CacheEventListener:
package com.ramostear.cache.config;
import org.ehcache.event.CacheEvent;
import org.ehcache.event.CacheEventListener;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author ramostear
* @create-time 2019/4/7 0007-0:48
* @modify by :
* @since:
*/
public class PersonCacheEventLogger implements CacheEventListener<Object,Object>{
private static final Logger logger = LoggerFactory.getLogger(PersonCacheEventLogger.class);
@Override
public void onEvent(CacheEvent cacheEvent) {
logger.info("person caching event {} {} {} {}",
cacheEvent.getType(),
cacheEvent.getKey(),
cacheEvent.getOldValue(),
cacheEvent.getNewValue());
}
}
3. Аннотируйте метод аннотацией @Cacheable.
Чтобы Spring Boot мог кэшировать наши данные, нам также необходимо аннотировать бизнес-метод аннотацией @Cacheable, чтобы сообщить Spring Boot, что данные, сгенерированные в этом методе, необходимо добавить в кеш:
package com.ramostear.cache.service;
import com.ramostear.cache.entity.Person;
import org.springframework.cache.annotation.Cacheable;
import org.springframework.stereotype.Service;
/**
* @author ramostear
* @create-time 2019/4/7 0007-0:51
* @modify by :
* @since:
*/
@Service(value = "personService")
public class PersonService {
@Cacheable(cacheNames = "person",key = "#id")
public Person getPerson(Long id){
Person person = new Person(id,"ramostear","ramostear@163.com");
return person;
}
}
Выполнив три вышеуказанных шага, мы выполнили функцию кэширования Spring Boot. Далее проверим кеш в действии.
4. Тест кеша
Чтобы протестировать наше приложение, создайте простую конечную точку Restful, которая будет вызывать PersonService и возвращать объект Person:
package com.ramostear.cache.controller;
import com.ramostear.cache.entity.Person;
import com.ramostear.cache.service.PersonService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* @author ramostear
* @create-time 2019/4/7 0007-0:54
* @modify by :
* @since:
*/
@RestController
@RequestMapping("/persons")
public class PersonController {
@Autowired
private PersonService personService;
@GetMapping("/{id}")
public ResponseEntity<Person> person(@PathVariable(value = "id") Long id){
return new ResponseEntity<>(personService.getPerson(id), HttpStatus.OK);
}
}
Person — это простой класс POJO:
package com.ramostear.cache.entity;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import java.io.Serializable;
/**
* @author ramostear
* @create-time 2019/4/7 0007-0:45
* @modify by :
* @since:
*/
@Getter
@Setter
@AllArgsConstructor
@NoArgsConstructor
public class Person implements Serializable{
private Long id;
private String username;
private String email;
}
После того, как вышеуказанные приготовления завершены, давайте скомпилируем и запустим приложение. После успешного запуска проекта откройте его в браузере:http://localhost:8080/persons/1, вы увидите следующую информацию на странице браузера:
{"id":1,"username":"ramostear","email":"ramostear@163.com"}
На этом этапе наблюдайте за информацией журнала, выводимой консолью:
2019-04-07 01:08:01.001 INFO 6704 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet : Completed initialization in 5 ms
2019-04-07 01:08:01.054 INFO 6704 --- [e [_default_]-0] c.r.cache.config.PersonCacheEventLogger : person caching event CREATED 1 null com.ramostear.cache.entity.Person@ba8a729
Поскольку мы запрашиваем API в первый раз, кэшированных данных нет. Поэтому Ehcache создает кешированные данные, к которым могут обращатьсяCREATEDПосмотрите, чтобы понять.
В файле ehcache.xml мы устанавливаем время истечения кеша на 1 минуту (1), поэтому в течение минуты мы обновим браузер и не увидим никаких новых выходных данных журнала.Через минуту срок действия кеша истекает, и мы снова обновляем ваш браузер, и вы увидите следующий вывод журнала:
2019-04-07 01:09:28.612 INFO 6704 --- [e [_default_]-1] c.r.cache.config.PersonCacheEventLogger : person caching event EXPIRED 1 com.ramostear.cache.entity.Person@a9f3c57 null
2019-04-07 01:09:28.612 INFO 6704 --- [e [_default_]-1] c.r.cache.config.PersonCacheEventLogger : person caching event CREATED 1 null com.ramostear.cache.entity.Person@416900ce
Первый журнал указывает, что срок действия кеша истек, а второй журнал указывает, что Ehcache воссоздал кэшированные данные.
заключительные замечания
В этом случае реализация кэша приложений Spring Boot на основе Ehcache объясняется тремя простыми шагами. Содержание статьи сосредоточено на основных шагах и методах реализации кеша, что упрощает конкретный бизнес-код.Заинтересованные друзья могут расшириться сами, и вы можете связаться со мной в любое время, если у вас возникнут проблемы в течение периода.
оригинал:Используйте EHCACHE, чтобы получить кеш SPRING BOOT в три этапа.автор:Тан Чаохонг