4、spring-boot使用cache

spring cache

cache

缓存就是数据交换的缓冲区（称作Cache），当某一硬件要读取数据时，会首先从缓存中查找需要的数据，如果找到了则直接执行，找不到的话则从内存中找。为什么使用缓存？究其原因就是缓存的读写速度远快与磁盘，从减轻I/O开销和加快运行速度方便都有很好的效果。那么我们缓存什么？哪些经常读取而又不经常修改的数据，那些数据量较大又很少修改的数据。

缓存更新策略

1. FIFO（First In First Out） 队列，先进先出
2. LFU（Least Frequently Used）：最近最少使用算法，一定时间段内使用次数（频率）最少的那个被移除，借助计数器实现；
3. LRU（Least Recently Used）：最久未使用算法，使用时间距离现在最久的那个被移除，借助计数器和队列实现；
4. TTL（Time To Live ）：存活期，即从缓存中创建时间点开始直到它到期的一个时间段（不管在这个时间段内有没有访问都将过期）
5. TTI（Time To Idle）：空闲期，即一个数据多久没被访问将从缓存中移除的时间。

搭建cache

1. 添加项目maven依赖

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

2.启动类开启缓存功能

/**
 * 注解 @EnableCaching    开启缓存功能，放在配置类或启动类上
 *
 * @author hui.wang09
 * @since 14 November 2018
 */
@SpringBootApplication
@EnableCaching
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

3.使用cache注解添加缓存

/**
 * 使用spring cache
 *
 * 常用注解含义
 * 注解@CacheConfig，在类上设置当前缓存的一些公共设置，比如缓存名称；
 * 注解@Cacheable，作用在方法上，触发缓存读取操作。表明该方法的结果是可以缓存的，如果缓存存在，则目标方法不会被调用，直接取出缓存。
 * 注解@CacheEvice，作用在方法上，触发缓存失效操作，删除缓存项或者清空缓存；
 * 注解@CachePut，作用在方法上，触发缓存更新操作
 * 注解@Caching，作用在方法上，综合上面的各种操作，在有些场景上，调用业务会触发多种缓存操作。
 *
 *
 * @author hui.wang09
 * @since 14 November 2018
 */
@RestController
public class HelloController {

    private static Logger LOGGER = LoggerFactory.getLogger(HelloController.class);

    /**
     * 注解@Cacheable可以标记在一个方法上，也可以标记在一个类上。当标记在一个方法上时表示该方法是支持缓存的，
     * 当标记在一个类上时则表示该类所有的方法都是支持缓存的。@Cacheable可以指定三个属性，value、key和condition。
     *
     * value：缓存的名称，在 spring 配置文件中定义，必须指定至少一个。如@Cacheable(value=”mycache”)
     * key：缓存的 key，可以为空，如果指定要按照SpEL表达式编写，如果不指定，则缺省按照方法的所有参数进行组合。
     *      如@Cacheable(value=”mycache”,key=”#request”)
     * condition：缓存的条件，可以为空，使用 SpEL 编写，返回 true 或者 false，只有为 true 才进行缓存。
     *      如@Cacheable(value=”mycache”,condition=”#request.length()>2”)
     *
     */
    @RequestMapping("/hello")
    @Cacheable(value = "myEhCache", key = "#request")
    public String hello(@RequestParam String request) {
        LOGGER.info("==========================");
        LOGGER.info("执行hello方法");
        LOGGER.info("==========================");
        return request;
    }

    /**
     * 注解@CachePut使用方式和@Cacheable是一样的
     * Spring在每次执行前都会检查Cache中是否存在相同key的缓存元素，如果存在就不再执行该方法，
     * 而是直接从缓存中获取结果进行返回，否则才会执行并将返回结果存入指定的缓存中。
     *
     */
    @RequestMapping("/put")
    @CachePut(value = "mycache", key = "#request")
    public String put(@RequestParam String request) {
        LOGGER.info("==========================");
        LOGGER.info("执行put方法");
        LOGGER.info("==========================");
        return request + 1;
    }
}

• 此时访问hello接口第一次会执行方法，打印日志，并将返回值缓存到缓存中，当第二次调用hello方法，传递相同值的时候，不会执行方法，会直接调用spring cache返回缓存中的值
• 调用put方法，会执行方法，打印日志，并将相同key的缓存值更新

注解详解

• @CacheConfig：在类上设置当前缓存的一些公共设置，比如缓存名称；
• @Cacheable：作用在方法上，触发缓存读取操作。表明该方法的结果是可以缓存的，如果缓存存在，则目标方法不会被调用，直接取出缓存。@Cacheable可以指定三个属性：value、key和condition。
  value:缓存的名称，在 spring 配置文件中定义，必须指定至少一个。如@Cacheable(value=”mycache”)
  key:缓存的 key，可以为空，如果指定要按照SpEL表达式编写，如果不指定，则缺省按照方法的所有参数进行组合。如@Cacheable(value=”mycache”,key=”#request”)
  condition:缓存的条件，可以为空，使用 SpEL 编写，返回 true 或者 false，只有为 true 才进行缓存。如@Cacheable(value=”mycache”,condition=”#request.length()>2”)
• @CacheEvice：作用在方法上，触发缓存失效操作，删除缓存项或者清空缓存；
• @CachePut：作用在方法上，触发缓存更新操作
• @Caching：作用在方法上，综合上面的各种操作，在有些场景上，调用业务会触发多种缓存操作

整合EhCache

1.添加maven依赖

        <dependency>
            <groupId>net.sf.ehcache</groupId>
            <artifactId>ehcache</artifactId>
        </dependency>

2. 在application配置文件配置项目的缓存类型，并指定ehcache配置文件路径

# 缓存类型（ehcache、redis）
spring.cache.type=ehcache
# ehcache 配置文件
spring.cache.ehcache.config=classpath:ehcache.xml

3. 配置ehcache，在classpath路径下创建ehcache.xml

<?xml version="1.0" encoding="UTF-8"?>
<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="http://ehcache.org/ehcache.xsd">

    <!-- 磁盘缓存位置 -->
    <diskStore path="java.io.tmpdir/ehcache"/>
    <!--
            磁盘存储:将缓存中暂时不使用的对象,转移到硬盘,类似于Windows系统的虚拟内存
            path:指定在硬盘上存储对象的路径
            path可以配置的目录有：
                user.home（用户的家目录）
                user.dir（用户当前的工作目录）
                java.io.tmpdir（默认的临时目录）
                ehcache.disk.store.dir（ehcache的配置目录）
                绝对路径（如：d:\\ehcache）
            查看路径方法：String tmpDir = System.getProperty("java.io.tmpdir");
    -->

    <!-- 默认缓存 -->
    <defaultCache
            maxEntriesLocalHeap="10000"
            eternal="false"
            timeToIdleSeconds="120"
            timeToLiveSeconds="120"
            maxEntriesLocalDisk="10000000"
            diskExpiryThreadIntervalSeconds="120"
            memoryStoreEvictionPolicy="LRU">
        <persistence strategy="localTempSwap"/>
    </defaultCache>

    <!--
    name：Cache 的唯一标识
    maxElementsInMemory：内存中允许存储的最大的元素个数
    maxElementsOnDisk：硬盘最大缓存个数，0代表无限个
    clearOnFlush：内存数量最大时是否清除
    eternal：缓存对象是否永久有效，如果是，超时设置将被忽略
    overflowToDisk：内存不足（超过 maxElementsInMemory）时，是否启用磁盘缓存
    timeToIdleSeconds：设置对象在失效前的允许闲置时间（单位：秒）。仅当eternal=false对象不是永久有效时使用，可选属性，默认值是0，也就是可闲置时间无穷大
    timeToLiveSeconds：缓存数据的生存时间（TTL），也就是一个元素从构建到消亡的最大时间间隔值，这只能在元素不是永久驻留时有效，如果该值是0就意味着元素可以停顿无穷长的时间
    diskPersistent：是否将缓存数据持久化到磁盘上，如果为 true，JVM 重启数据依然存在。默认值是false
    diskSpoolBufferSizeMB：这个参数设置DiskStore（磁盘缓存）的缓存区大小。默认是30MB。每个Cache都应该有自己的一个缓冲区
    diskExpiryThreadIntervalSeconds：磁盘失效线程运行时间间隔，默认是120秒
    memoryStoreEvictionPolicy：当达到 maxElementsInMemory 限制时，Ehcache 将根据指定策略清除内存。默认为 LRU（最近最少使用），其他策略有 FIFO（先进先出），LFU（较少使用）
    -->

    <!-- 自定义缓存 -->
    <cache name="myEhCache"
           maxElementsInMemory="1000"
           eternal="false"
           timeToIdleSeconds="50"
           timeToLiveSeconds="50"
           overflowToDisk="false"
           memoryStoreEvictionPolicy="LRU"/>
</ehcache>

4. 使用ehcache

/**
 * @author hui.wang09
 * @since 14 November 2018
 */
@RestController
@CacheConfig(cacheNames = "myEhCache")
public class EhCacheController {

    private static Logger LOGGER = LoggerFactory.getLogger(EhCacheController.class);

    @RequestMapping("/ehcache")
    @Cacheable(key = "#request")
    public String ehcacahe(@RequestParam String request) {
        LOGGER.info("==========================");
        LOGGER.info("执行ehcache方法");
        LOGGER.info("==========================");
        return request;
    }
}

需要注意代码中@CacheConfig写的cacheNames需要和ehcache配置的cache name一致
github连接