Springboot應用快取實踐之：Ehcache加持

CodeSheep發表於2019-03-01

注：本文首發於 部落格 CodeSheep · 程式羊，歡迎光臨小站！

本文共 851字，閱讀大約需要 3分鐘！

本文內容腦圖如下：

概述

在如今高併發的網際網路應用中，快取的地位舉足輕重，對提升程式效能幫助不小。而3.x開始的 Spring也引入了對 Cache的支援，那對於如今發展得如火如荼的 Spring Boot來說自然也是支援快取特性的。當然 Spring Boot預設使用的是 SimpleCacheConfiguration，即使用ConcurrentMapCacheManager 來實現的快取。但本文將講述如何將 Ehcache快取應用到Spring Boot應用中。

「Ehcache」是一個基於Java實現的開源快取管理庫，提供了用記憶體、磁碟檔案儲存、以及分散式儲存等多種靈活的管理方案。使用方式和原理都有點類似於 Spring事務管理，配合各項註解可以很容易的上手。

下文就上手來摸一摸它，結合對資料庫的操作，我們讓 Ehcache作為本地快取來看一下效果！

準備工作

準備好資料庫和資料表並插入相應的資料（MySQL）

比如我這裡準備了一張使用者表，包含幾條記錄：

我們將通過模擬資料庫的存取操作來看看 Ehcache快取加入後的效果。

搭建工程：Springboot + MyBatis + MySQL + Ehcache

pom.xml 中新增如下依賴：

    <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>
複製程式碼

建立 Ehcache配置檔案

建立Ehcache的配置檔案 ehcache.xml並置於專案 classpath下：

<?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>
複製程式碼

配置 application.properties

server.port=80

# Mysql 資料來源配置
spring.datasource.url=jdbc:mysql://121.196.213.251: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
複製程式碼

編寫運算元據庫和 Ehcache快取的業務程式碼

編寫entity

public class User {

    private Long userId;
    private String userName;
    private Integer userAge;

    public Long getUserId() {
        return userId;
    }

    public void setUserId(Long userId) {
        this.userId = userId;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public Integer getUserAge() {
        return userAge;
    }

    public void setUserAge(Integer userAge) {
        this.userAge = userAge;
    }
}
複製程式碼

編寫mapper

public interface UserMapper {

    List<User> getUsers();

    int addUser(User user);

    List<User> getUsersByName( String userName );
}
複製程式碼

編寫service

@Service
public class UserService {

    @Autowired
    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：配置於方法上時，表示從快取中移除相應資料。

編寫controller

@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;
    }

}
複製程式碼

改造SpringBoot應用主類

主要是在啟動類上通過 @EnableCaching註解來顯式地開啟 Ehcache快取

@SpringBootApplication
@MapperScan("cn.codesheep.springbt_ehcache")
@EnableCaching
public class SpringbtEhcacheApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringbtEhcacheApplication.class, args);
    }
}
複製程式碼

最終完工的整個工程的結構如下：