Guava Cache本地缓存在 Spring Boot应用中的实践

时间 2019-11-30

标签 guava cache 本地缓存 spring boot 应用实践栏目 Java 繁體版

原文原文链接

概述

在现在高并发的互联网应用中，缓存的地位举足轻重，对提高程序性能帮助不小。而 3.x开始的 Spring也引入了对 Cache的支持，那对于现在发展得如火如荼的 Spring Boot来讲天然也是支持缓存特性的。固然 Spring Boot默认使用的是 SimpleCacheConfiguration，即便用 ConcurrentMapCacheManager 来实现的缓存。但本文将讲述如何将 Guava Cache缓存应用到 Spring Boot应用中。java

Guava Cache是一个全内存的本地缓存实现，并且提供了线程安全机制，因此特别适合于代码中已经预料到某些值会被屡次调用的场景mysql

下文就上手来摸一摸它，结合对数据库的操做，咱们让 Guava Cache做为本地缓存来看一下效果！web

注：本文首发于 My Personal Blog：CodeSheep·程序羊，欢迎光临小站spring

准备工做

准备好数据库和数据表并插入相应实验数据（MySQL）

好比我这里准备了一张用户表，包含几条记录：sql

咱们将经过模拟数据库的存取操做来看看 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 秒，缓存最大数目为 1000 个bash

配置 application.properties

server.port=82

# Mysql 数据源配置
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
复制代码

编写数据库操做和 Guava Cache缓存的业务代码

编写 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。这是缓存的使用注解之一，除此以外经常使用的还有 @CachePut和 @CacheEvit，分别简单介绍一下：mybatis

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

编写 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);
    }
}
复制代码

最终完工的整个工程的结构以下：