springboot：缓存不止redis，学会使用本地缓存ehcache

本文介绍: ehcache是基于 java 开发的本地缓存组件，无需单独安装部署，只要引入 jar包就可利用它来实现缓存。所谓本地缓存，就是指存储在JVM堆内存中的临时缓存数据，当然e h cache本身也支持Off-He ap St o re 机制来使用堆外内存，本地缓存相较于redis 性能和响应速度更高。Ehcache的本地缓存还支持过期时间、最大容量、持久化等特性，使得它可以适用于各种不同的缓存场景。

随着redis的普及，更多的同学对redis 分布式缓存更加熟悉，但在一些实际场景中，其实并不需要用到 redis，使用更加简单的本地缓存即可实现我们的缓存需求。

今天，我们一起来看看本地缓存组件 ehcache

ehcache是基于 java 开发的本地缓存组件，无需单独安装部署，只要引入 jar包就可利用它来实现缓存。

所谓本地缓存，就是指存储在JVM堆内存中的临时缓存数据，当然ehcache本身也支持Off-Heap Store机制来使用堆外内存，本地缓存相较于redis 性能和响应速度更高。

Ehca ch e的本地缓存还支持过期时间、最大容量、持久化等特性，使得它可以适用于各种不同的缓存场景。

官方文档地址：https://www.ehcache.org/documentation/

1、创建一个 springboot 项目，这里我的springboot 版本为2.6.13

这里需要注意的是net.sf.ehcache是ehc a che2.X 与 org.ehcache是ec hc ac he3.X，两个版本配置有区别

        &lt;dependency&gt;
            &lt;groupId&gt;net.sf.ehcache&lt;/groupId&gt;
            <artifactId&gt;ehcache</artifactId&gt;
            <version&gt;2.10.9.2</version&gt;
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-cache</artifactId>
            <version>2.6.13</version>
        </dependency>

3、在启动类上添加@EnableCaching注解，开启缓存

@SpringBootApplication
@EnableCaching
public class LocalCacheDemoApplication {

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

}

4、在配置文件application.yml中添加配置

spring:
  profiles: 
  	active: dev
  cache:
    type: ehcache
    ehcache:
      config: classpath:ehcache.xml

5、在resources 文件夹下创建配置文件ehcache.xml，注意这里单独创建了一个 name为user的缓存，用于后续保存用户信息缓存。如果有不同的缓存需要使用不同的name的，需要单独创建cache标签

<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="http://ehcache.org/ehcache.xsd"
         updateCheck="false">
         
    <defaultCache
            eternal="false"
            maxElementsInMemory="10000"
            overflowToDisk="false"
            diskPersistent="false"
            timeToLiveSeconds="3600"
            timeToIdleSeconds="0"
            diskExpiryThreadIntervalSeconds="120"
            memoryStoreEvictionPolicy="LRU"/>

    <cache
            name="user"
            eternal="false"
            maxElementsInMemory="10000"
            overflowToDisk="false"
            diskPersistent="false"
            timeToLiveSeconds="3600"
            timeToIdleSeconds="0"
            diskExpiryThreadIntervalSeconds="120"
            memoryStoreEvictionPolicy="LRU"/>

<!--    存储到磁盘时的路径-->
    <diskStore path="/Users/wuhanxue/Downloads/ehcache" />

</ehcache>

6、缓存使用，在获取方法中使用@Cacheable注解，在更新方法中使用@CachePut注解。
我这里模拟就没有访问数据库查询数据了，大家在实际书写的时候可以连接上数据源测试

@RestController
@RequestMapping("user")
public class UserController {

    @GetMapping("get")
    @Cacheable(cacheNames = "user", key = "#id")
    public User getById(Integer id) {
        System.out.println("get第一次获取，不走缓存");
        User user = new User();
        user.setId(id);
        user.setAge(18);
        user.setName("benjamin_"+id);
        user.setSex(true);
        return user;
    }

    @PostMapping("update")
    @CachePut(cacheNames = "user", key = "#search.id")
    public User update(@RequestBody User search) {
        System.out.println("update更新缓存");
        User user = new User();
        Integer id = search.getId();
        user.setId(id);
        user.setAge(search.getAge() != null ? search.getAge()+1 : 0);
        user.setName("update_benjamin_"+id);
        user.setSex(true);
        return user;
    }

}

1、调用查询接口：localhost:8080/user/get?id=1

这个我们通过一个生成大数据量的接口来模拟，其中generateMemoryString方法可以在文末的源码仓库中

@GetMapping("build")
    @Cacheable(cacheNames = "user", key = "#id")
    public User build(Integer id) {
        System.out.println("get第一次获取，不走缓存");
        User user = new User();
        user.setId(id);
        user.setAge(18);
        // 生成指定大小的字符串
        user.setName(generateMemoryString(id));
        user.setSex(true);
        return user;
    }

3、调用接口localhost:8080/user/build?id=100，因为该接口会生成大数据，占用本地缓存，而JVM缓存又给的100M，所以调用会报错堆内存溢出，如图所示

4、因此该配置项要谨慎使用，可以通过maxBytesLocalHeap,maxBytesLocalDisk设置占用多少内存、磁盘来替代

<cache
            name="user"
            eternal="false"
            maxBytesLocalHeap="50M"
            maxBytesLocalDisk="200M"
            overflowToDisk="false"
            diskPersistent="false"
            timeToLiveSeconds="3600"
            timeToIdleSeconds="0"
            diskExpiryThreadIntervalSeconds="120"
            memoryStoreEvictionPolicy="LRU"
    />