詳解Guava Cache本地緩存在Spring Boot應用中的實踐

更新時間：2019年01月08日 10:23:45 作者：CodeSheep

Guava Cache是一個全內存的本地緩存實現(xiàn)，本文將講述如何將 Guava Cache緩存應用到 Spring Boot應用中。具有一定的參考價值，感興趣的小伙伴們可以參考一下

概述

在如今高并發(fā)的互聯(lián)網(wǎng)應用中，緩存的地位舉足輕重，對提升程序性能幫助不小。而 3.x開始的 Spring也引入了對 Cache的支持，那對于如今發(fā)展得如火如荼的 Spring Boot來說自然也是支持緩存特性的。當然 Spring Boot默認使用的是 SimpleCacheConfiguration，即使用 ConcurrentMapCacheManager 來實現(xiàn)的緩存。但本文將講述如何將 Guava Cache緩存應用到 Spring Boot應用中。

Guava Cache是一個全內存的本地緩存實現(xiàn)，而且提供了線程安全機制，所以特別適合于代碼中已經(jīng)預料到某些值會被多次調用的場景

下文就上手來摸一摸它，結合對數(shù)據(jù)庫的操作，我們讓 Guava Cache作為本地緩存來看一下效果！

準備工作

準備好數(shù)據(jù)庫和數(shù)據(jù)表并插入相應實驗數(shù)據(jù)（MySQL）

比如我這里準備了一張用戶表，包含幾條記錄：

我們將通過模擬數(shù)據(jù)庫的存取操作來看看 Guava Cache緩存加入后的效果。

搭建工程：Springboot + MyBatis + MySQL + Guava Cache

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 guava cache-->
    <dependency>
      <groupId>com.google.guava</groupId>
      <artifactId>guava</artifactId>
      <version>27.0.1-jre</version>
    </dependency>

  </dependencies>

建立 Guava Cache配置類

引入 Guava Cache的配置文件 GuavaCacheConfig

@Configuration
@EnableCaching
public class GuavaCacheConfig {

  @Bean
  public CacheManager cacheManager() {
    GuavaCacheManager cacheManager = new GuavaCacheManager();
    cacheManager.setCacheBuilder(
        CacheBuilder.newBuilder().
            expireAfterWrite(10, TimeUnit.SECONDS).
            maximumSize(1000));
    return cacheManager;
  }
}

Guava Cache配置十分簡潔，比如上面的代碼配置緩存存活時間為 10 秒，緩存最大數(shù)目為 1000 個

配置 application.properties

server.port=82

# Mysql 數(shù)據(jù)源配置
spring.datasource.url=jdbc:mysql://121.116.23.145: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_guava_cache.entity
mybatis.mapper-locations=classpath:mapper/*.xml
mybatis.configuration.map-underscore-to-camel-case=true

編寫數(shù)據(jù)庫操作和 Guava Cache緩存的業(yè)務代碼

編寫 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( "從數(shù)據(jù)庫讀取，而非讀取緩存！" );
    return users;
  }
}

看得很明白了，我們在 getUsersByName接口上添加了注解：@Cacheable。這是緩存的使用注解之一，除此之外常用的還有 @CachePut和 @CacheEvit，分別簡單介紹一下：

@Cacheable：配置在 getUsersByName方法上表示其返回值將被加入緩存。同時在查詢時，會先從緩存中獲取，若不存在才再發(fā)起對數(shù)據(jù)庫的訪問
@CachePut：配置于方法上時，能夠根據(jù)參數(shù)定義條件來進行緩存，其與 @Cacheable不同的是使用@CachePut標注的方法在執(zhí)行前不會去檢查緩存中是否存在之前執(zhí)行過的結果，而是每次都會執(zhí)行該方法，并將執(zhí)行結果以鍵值對的形式存入指定的緩存中，所以主要用于數(shù)據(jù)新增和修改操作上
@CacheEvict：配置于方法上時，表示從緩存中移除相應數(shù)據(jù)。

編寫 controller

@RestController
public class UserController {

  @Autowired
  private UserService userService;

  @Autowired
  CacheManager cacheManager;

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

}

改造 Spring Boot應用主類

主要是在啟動類上通過 @EnableCaching注解來顯式地開啟緩存功能

@SpringBootApplication
@MapperScan("cn.codesheep.springbt_guava_cache")
@EnableCaching
public class SpringbtGuavaCacheApplication {
  public static void main(String[] args) {
    SpringApplication.run(SpringbtGuavaCacheApplication.class, args);
  }
}

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