Spring Boot - 实用功能14 - Ehcache缓存加持

Ehcache缓存加持

一：概述

在如今高并发的互联网应用中，缓存的地位举足轻重，对提升程序性能帮助不小。

而3.x开始的 Spring 也引入了对 Cache 的支持，那对于如今发展得如火如荼的 Spring Boot 来说自然也是支持缓存特性的。

Spring Boot默认使用的是 SimpleCacheConfiguration，即使用ConcurrentMapCacheManager 来实现的缓存。

而「Ehcache」 是一个基于Java实现的开源缓存管理库，提供了用内存、磁盘文件存储、以及分布式存储等多种灵活的管理方案。

使用方式和原理都有点类似于 Spring 事务管理，配合各项注解可以很容易的上手。

二：准备工作

准备好数据库和数据表并插入相应的数据，数据表的名称叫做tbl_user，有如下的数据

user_id	user_name	user_age
1	codesheep.cn	25
2	haosonwang99	30
3	刘能	35
4	赵四	38

将通过模拟数据库的存取操作来看看 Ehcache缓存加入后的效果。

1：引入对应的依赖

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

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

    <!--for mybatis-->
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>1.3.2</version>
    </dependency>

    <!--for Mysql-->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>

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

    <!--for ehcache-->
    <dependency>
        <groupId>net.sf.ehcache</groupId>
        <artifactId>ehcache</artifactId>
    </dependency>

</dependencies>

2：配置文件properties

server.port=80

# Mysql 数据源配置
spring.datasource.url=jdbc:mysql://xxx.xxx.xxx.xxx:3306/demo?useUnicode=true&characterEncoding=utf-8&useSSL=false
spring.datasource.username=root
spring.datasource.password=xxxxxx
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

# mybatis配置
mybatis.type-aliases-package=cn.codesheep.springbt_ehcache.entity
mybatis.mapper-locations=classpath:mapper/*.xml
mybatis.configuration.map-underscore-to-camel-case=true

# 配置ehcache
spring.cache.ehcache.config=classpath:ehcache.xml

3：编写ehcache.xml

<?xml version="1.0" encoding="UTF-8"?>
<ehcache>

    <diskStore path="java.io.tmpdir"/>

    <!-- 设定缓存的默认数据过期策略 -->
    <defaultCache
            maxElementsInMemory="10000"
            eternal="false"
            timeToIdleSeconds="120"
            timeToLiveSeconds="120"
            overflowToDisk="true"
            maxElementsOnDisk="10000000"
            diskPersistent="false"
            diskExpiryThreadIntervalSeconds="120"
            memoryStoreEvictionPolicy="LRU"/>

    <cache name="user"
           maxElementsInMemory="1000"
           eternal="false"
           timeToIdleSeconds="10"/>

</ehcache>

4：主启动类配置

添加@EnableCaching注解

/**
 * @author cuihaida
 */
@SpringBootApplication
@MapperScan("cn.codesheep.springbt_ehcache")
@EnableCaching
public class SpringbtEhcacheApplication {

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

5：业务代码

user实体类

/**
 * @author cuihaida
 */
@Setter
@Getter
public class User {
    private Long userId;
    private String userName;
    private Integer userAge;
}

userMapper & xml

public interface UserMapper {
    List<User> getUsers();
    
    int addUser(User user);
    
    List<User> getUsersByName( String userName );
}

<!-- UserMapper.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="cn.codesheep.springbt_ehcache.mapper.UserMapper">


    <select id="getUsers" resultType="User">
        SELECT * FROM tbl_user
    </select>

    <insert id="addUser" parameterType="User">
        insert into tbl_user(user_id, user_name, user_age) values(#{userId}, #{userName}, #{userAge})
    </insert>

    <select id="getUsersByName" resultType="User">
        select * from tbl_user where user_name=#{userName}
    </select>

</mapper>

UserService

@Service
public class UserService {

    @Resource
    private UserMapper userMapper;

    public List<User> getUsers() {
        return userMapper.getUsers();
    }

    public int addUser( User user ) {
        return userMapper.addUser(user);
    }

    @Cacheable(value = "user", key = "#userName")
    public List<User> getUsersByName( String userName ) {
        List<User> users = userMapper.getUsersByName( userName );
        System.out.println( "从数据库读取，而非读取缓存！" );
        return users;
    }
}

在 getUsersByName接口上添加了注解： @Cacheable。这是 Ehcache的使用注解之一，除此之外常用的还有 @CachePut 和 @CacheEvit，分别简单介绍一下：

• @Cacheable：配置在 getUsersByName方法上表示其返回值将被加入缓存。同时在查询时，会先从缓存中获取，若不存在才再发起对数据库的访问
• @CachePut：配置于方法上时，能够根据参数定义条件来进行缓存，其与 @Cacheable不同的是使用 @CachePut标注的方法在执行前不会去检查缓存中是否存在之前执行过的结果，而是每次都会执行该方法，并将执行结果以键值对的形式存入指定的缓存中，所以主要用于数据新增和修改操作上
• @CacheEvict：配置于方法上时，表示从缓存中移除相应数据。

UserController

@RestController
public class UserController {

    @Autowired
    private UserService userService;

    @Autowired
    CacheManager cacheManager;

    @GetMapping("/users")
    public List<User> getUsers() {
        return userService.getUsers();
    }

    @GetMapping("/adduser")
    public int addSser() {
        User user = new User();
        user.setUserId(4l);
        user.setUserName("赵四");
        user.setUserAge(38);
        return userService.addUser(user);
    }

    @RequestMapping( value = "/getusersbyname", method = RequestMethod.POST)
    public List<User> geUsersByName( @RequestBody User user ) {
        System.out.println( "-------------------------------------------" );
        System.out.println("call /getusersbyname");
        System.out.println(cacheManager.toString());
        List<User> users = userService.getUsersByName( user.getUserName() );
        return users;
    }

}

三：试验

通过多次向接口 localhost/getusersbynamePOST 数据来观察效果：

可以看到缓存的启用和失效时的效果（上文ehcache的配置文件中设置了缓存user的实效时间为10s）：