具体在Springboot中使用缓存如下:
1.在pom.xml中引入cache依赖,添加如下内容:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-cache</artifactId>
</dependency>
2.在Spring Boot主类中增加@EnableCaching注解开启缓存功能,如下:
@SpringBootApplication
@EnableCaching
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
3.在数据访问接口中,增加缓存配置注解,如:
@CacheConfig(cacheNames = "users")
public interface UserRepository extends JpaRepository<User, Long> {
@Cacheable
User findByName(String name);
}
SpringBoot支持很多种缓存方式:redis、guava、ehcahe、jcache等等。
说明下redis和ehcache的区别:
Redis:属于独立的运行程序,需要单独安装后,使用Java中的Jedis来操纵。因为它是独立,所以如果你写个单元测试程序,放一些数据在Redis中,然后又写一个程序去拿数据,那么是可以拿到这个数据的。,
ehcache:与Redis明显不同,它与java程序是绑在一起的,java程序活着,它就活着。譬如,写一个独立程序放数据,再写一个独立程序拿数据,那么是拿不到数据的。只能在独立程序中才能拿到数据。
如果使用Ehcache,只需要在工程中加入ehcache.xml配置文件并在pom.xml中增加ehcache依赖,框架只要发现该文件,就会创建EhCache的缓存管理器。
1、在src/main/resources目录下创建:ehcache.xml
<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="ehcache.xsd">
<cache name="users" maxEntriesLocalHeap="200" timeToLiveSeconds="600">
</cache>
</ehcache>
对于EhCache的配置文件也可以通过application.properties文件中使用spring.cache.ehcache.config属性来指定,比如:
spring.cache.ehcache.config=classpath:config/another-config.xml
2、在pom.xml中加入
<dependency>
<groupId>net.sf.ehcache</groupId>
<artifactId>ehcache</artifactId>
</dependency>
Cache注解详解
@CacheConfig
:主要用于配置该类中会用到的一些共用的缓存配置。在这里@CacheConfig(cacheNames = "users")
:配置了该数据访问对象中返回的内容将存储于名为users的缓存对象中,我们也可以不使用该注解,直接通过@Cacheable
自己配置缓存集的名字来定义。-
@Cacheable
:配置了findByName函数的返回值将被加入缓存。同时在查询时,会先从缓存中获取,若不存在才再发起对数据库的访问。该注解主要有下面几个参数:-
value
、cacheNames
:两个等同的参数(cacheNames
为Spring 4新增,作为value
的别名),用于指定缓存存储的集合名。由于Spring 4中新增了@CacheConfig
,因此在Spring 3中原本必须有的value
属性,也成为非必需项了 -
key
:缓存对象存储在Map集合中的key值,非必需,缺省按照函数的所有参数组合作为key值,若自己配置需使用SpEL表达式,比如:@Cacheable(key = "#p0")
:使用函数第一个参数作为缓存的key值,更多关于SpEL表达式的详细内容可参考官方文档 -
condition
:缓存对象的条件,非必需,也需使用SpEL表达式,只有满足表达式条件的内容才会被缓存,比如:@Cacheable(key = "#p0", condition = "#p0.length() < 3")
,表示只有当第一个参数的长度小于3的时候才会被缓存,若做此配置上面的AAA用户就不会被缓存,读者可自行实验尝试。 -
unless
:另外一个缓存条件参数,非必需,需使用SpEL表达式。它不同于condition
参数的地方在于它的判断时机,该条件是在函数被调用之后才做判断的,所以它可以通过对result进行判断。 -
keyGenerator
:用于指定key生成器,非必需。若需要指定一个自定义的key生成器,我们需要去实现org.springframework.cache.interceptor.KeyGenerator
接口,并使用该参数来指定。需要注意的是:该参数与key
是互斥的 -
cacheManager
:用于指定使用哪个缓存管理器,非必需。只有当有多个时才需要使用 -
cacheResolver
:用于指定使用那个缓存解析器,非必需。需通过org.springframework.cache.interceptor.CacheResolver
接口来实现自己的缓存解析器,并用该参数指定。
-
除了这里用到的两个注解之外,还有下面几个核心注解:
-
@CachePut
:配置于函数上,能够根据参数定义条件来进行缓存,它与@Cacheable
不同的是,它每次都会真是调用函数,所以主要用于数据新增和修改操作上。它的参数与@Cacheable
类似,具体功能可参考上面对@Cacheable
参数的解析 -
@CacheEvict
:配置于函数上,通常用在删除方法上,用来从缓存中移除相应数据。除了同@Cacheable
一样的参数之外,它还有下面两个参数:-
allEntries
:非必需,默认为false。当为true时,会移除所有数据 -
beforeInvocation
:非必需,默认为false,会在调用方法之后移除数据。当为true时,会在调用方法之前移除数据。
-
【设定过期时间】
@Cacheable(value = "example#${select.cache.timeout:1000}", key = "")
//example 是cache容器名字 #后边的是SpEL表达式
更多
- 如果需要使用SpringBoot缓存,首先需要开启基于注解的缓存。
- 第二步是给需要缓存的方法加上相应的注解,表示将方法的运行结果进行缓存,以后查询相同的数据直接从缓存中获取,不需要查询数据库。
- 在缓存中CacheManager管理多个Cache组件,对缓存的真正CRUD操作在Cache组件中,每一个缓存组件有自己唯一一个名字;我们通过cacheNames指定名字。
- 我们可以通过指定缓存条件,只有当条件满足的时候才缓存。
-
我们可以使用unless来否定缓存,当指定的条件为true,方法的返回值就不会缓存,这个可以以获取的结果进行判断。
如果返回的结果为空,我们不进行缓存。
-
配置完成之后,我们查询控制台日志的打印情况。
执行连续刷新,控制台上只打印了一次SQL语句。
测试缓存
【以下内容摘自】
【作者:dalaoyang 】
【链接:https://www.jianshu.com/p/20975889cf15】
还是和以往一样,使用Controller做测试,先展示一下代码:
package com.dalaoyang.controller;
import com.dalaoyang.entity.House;
import com.dalaoyang.repository.HouseRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cache.annotation.CacheEvict;
import org.springframework.cache.annotation.CachePut;
import org.springframework.cache.annotation.Cacheable;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* @author dalaoyang
* @Description
* @project springboot_learn
* @package com.dalaoyang.controller
* @email yangyang@dalaoyang.cn
* @date 2018/5/28
*/
@RestController
public class HouseController {
@Autowired
private HouseRepository houseRepository;
//http://localhost:8888/saveHouse?id=1&houseName=别墅&houseSize=1220平方米
@GetMapping("/saveHouse")
@CachePut(value = "house", key = "#id")
public House saveHouse(Integer id,String houseName,String houseSize){
House house = new House(id,houseName, houseSize);
houseRepository.save(house);
return house;
}
//http://localhost:8888/queryHouse?id=1
@GetMapping("/queryHouse")
@Cacheable(value = "house", key = "#id")
public House queryHouse(Integer id){
House house = houseRepository.findOne(id);
return house;
}
//http://localhost:8888/deleteHouse?id=1
@GetMapping("/deleteHouse")
@CacheEvict(value = "house", key = "#id")
public String deleteHouse(Integer id){
houseRepository.delete(id);
return "success";
}
//http://localhost:8888/deleteCache
@GetMapping("/deleteCache")
@CacheEvict(value = "house", allEntries = true)
public void deleteCache() {
}
}
解释测试方法
1.saveHouse方法
方法中使用到了@CachePut注解,这个注解直接将返回值放入缓存中,通常用于保存和修改方法中
2.queryHouse方法
方法中使用到了@Cacheable注解,这个注解在执行前先查看缓存中是不是已经存在了,如果存在,直接返回。如果不存在,将方法的返回值放入缓存。
3.deleteHouse方法
方法中使用到了@CacheEvict注解,这个注解在执行方法执行成功后会从缓存中移除
4.deleteCache方法
这个方法的也是使用的@CacheEvict注解,不同的是使用了allEntries熟悉,默认为false,true的时候移除所有缓存。