配置缓存EhCache

说明

当前使用的缓存方式

配置方式

1、开启缓存配置

在启动类加入注解 @EnableCaching

@SpringBootApplication
@EnableCaching
public class EhcacheApplication {
    
    public static void main(String[] args) {
        SpringApplication.run(EhcacheApplication.class, args);
    }
}

2、引入jar包

        <!--开启 cache 缓存-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-cache</artifactId>
        </dependency>
        <!-- ehcache 缓存 -->
        <dependency>
            <groupId>net.sf.ehcache</groupId>
            <artifactId>ehcache</artifactId>
        </dependency>

3、添加配置

spring:
#  设置缓存类型和缓存配置文件
  cache:
    type: ehcache
    ehcache:
      config: classpath:/ehcache.xml

4、向 resources 中添加 ehcache 配置文件

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"
         updateCheck = "false">

    <!-- 指定一个文件目录，当EHCache把数据写到硬盘上时，将把数据写到这个文件目录下 -->
    <diskStore path = "java.io.tmpdir"/>

    <!-- 默认的管理策略 -->
    <defaultCache
            eternal = "false"
            maxElementsInMemory = "10000"
            overflowToDisk = "true"
            diskPersistent = "false"
            timeToIdleSeconds = "120"
            timeToLiveSeconds = "120"
            diskExpiryThreadIntervalSeconds = "120"
            memoryStoreEvictionPolicy = "LRU"/>

    <!--demo，10小时-->
    <cache
            name = "user"
            eternal = "false"
            maxElementsInMemory = "1000"
            overflowToDisk = "false"
            diskPersistent = "false"
            timeToIdleSeconds = "0"
            timeToLiveSeconds = "36000"
            memoryStoreEvictionPolicy = "FIFO"/>

    <!-- maxElementsInMemory 内存中最大缓存对象数，看着自己的heap大小来搞 -->
    <!-- eternal：true表示对象永不过期，此时会忽略timeToIdleSeconds和timeToLiveSeconds属性，默认为false -->
    <!-- maxElementsOnDisk：硬盘中最大缓存对象数，若是0表示无穷大 -->
    <!-- overflowToDisk：true表示当内存缓存的对象数目达到了maxElementsInMemory界限后，
    会把溢出的对象写到硬盘缓存中。注意：如果缓存的对象要写入到硬盘中的话，则该对象必须实现了Serializable接口才行。-->
    <!-- diskSpoolBufferSizeMB：磁盘缓存区大小，默认为30MB。每个Cache都应该有自己的一个缓存区。-->
    <!-- diskPersistent：是否缓存虚拟机重启期数据  -->
    <!-- diskExpiryThreadIntervalSeconds：磁盘失效线程运行时间间隔，默认为120秒 -->

    <!-- timeToIdleSeconds： 设定允许对象处于空闲状态的最长时间，以秒为单位。当对象自从最近一次被访问后，
    如果处于空闲状态的时间超过了timeToIdleSeconds属性值，这个对象就会过期，
    EHCache将把它从缓存中清空。只有当eternal属性为false，该属性才有效。如果该属性值为0，
    则表示对象可以无限期地处于空闲状态 -->

    <!-- timeToLiveSeconds：设定对象允许存在于缓存中的最长时间，以秒为单位。当对象自从被存放到缓存中后，
    如果处于缓存中的时间超过了 timeToLiveSeconds属性值，这个对象就会过期，
    EHCache将把它从缓存中清除。只有当eternal属性为false，该属性才有效。如果该属性值为0，
    则表示对象可以无限期地存在于缓存中。timeToLiveSeconds必须大于timeToIdleSeconds属性，才有意义 -->

    <!-- memoryStoreEvictionPolicy：当达到maxElementsInMemory限制时，
    Ehcache将会根据指定的策略去清理内存。可选策略有：LRU（最近最少使用，默认策略）、
    FIFO（先进先出）、LFU（最少访问次数）。-->

</ehcache>

5、添加测试实体类

/**
 * 测试实体类
 */
public class User {

    private String username;
    private String password;

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

6、添加核心service类

import com.liucz.ehcache.model.User;
import org.springframework.cache.annotation.CacheEvict;
import org.springframework.cache.annotation.CachePut;
import org.springframework.cache.annotation.Cacheable;
import org.springframework.stereotype.Service;

@Service
public class UserService {

    @CachePut(value = "user", key = "#user.username")
    public User save(User user) {
        System.out.println("@CachePut，为username、key为:" + user.getUsername() + "的数据做了缓存");
        return user;
    }

    @CacheEvict(value = "user")
    public void remove(String username) {
        System.out.println("@CacheEvict，删除username、key为" + username + "的数据缓存");
        //这里不做实际删除操作
    }

    @Cacheable(value = "user", key = "#user.username")//3
    public User findOne(User user) {
        System.out.println("@Cacheable，为username、key为:" + user.getUsername() + "的数据做了缓存");
        return user;
    }

}

7、手动缓存测试

import javax.annotation.Resource;

@RunWith(SpringRunner.class)
@SpringBootTest
public class UserServiceTest {

    @Resource
    private CacheManager cacheManager;

    @Test
    public void cacheTest() {
        // 显示所有的Cache空间
        System.out.println(cacheManager.getCacheNames());

        Cache cache = cacheManager.getCache("user");
        cache.put("key", "123");
        System.out.println("缓存成功");
        String res = cache.get("key", String.class);
        System.out.println(res);
    }

}

8、自动缓存测试

import com.liucz.ehcache.model.User;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.cache.Cache;
import org.springframework.cache.CacheManager;
import org.springframework.test.context.junit4.SpringRunner;

import javax.annotation.Resource;

@RunWith(SpringRunner.class)
@SpringBootTest
public class UserServiceTest {

    @Resource
    private CacheManager cacheManager;
    @Autowired
    UserService userService;

    @Test
    public void save() {

        User user = new User();
        user.setUsername("username1");
        user.setPassword("password1");
        userService.save(user);

        Cache cache = cacheManager.getCache("user");
        User res = cache.get(user.getUsername(), User.class);
        System.out.println("查询缓存数据："+res.toString());

    }

    @Test
    public void remove() {

        User user = new User();
        user.setUsername("username2");
        user.setPassword("password2");
        userService.save(user);

        Cache cache = cacheManager.getCache("user");
        User res1 = cache.get(user.getUsername(), User.class);
        System.out.println("查询缓存数据1："+res1.toString());

        //执行删除操作
        userService.remove(user.getUsername());

        User res2 = cache.get(user.getUsername(), User.class);
        System.out.println("查询缓存数据2："+res2);

    }

    @Test
    public void findOne() {

        User user = new User();
        user.setUsername("username3");
        user.setPassword("password3");
        userService.findOne(user);

        Cache cache = cacheManager.getCache("user");
        User res = cache.get(user.getUsername(), User.class);
        System.out.println("查询缓存数据："+res.toString());

    }

}