给接口添加缓存

早期文章

• Spring Cloud Gateway 的简单搭建

• 服务注册、发现和远程调用

• 让 MongoDB 的 CRUD 有 JPA 的味道

• 使用 MongoTemplate 对 MongoDB 进行 CRUD

• 省内存的 Excel 导入导出库还是得了解下它...

• 后端程序员的 VUE 超简单入门笔记

• 后端程序员的 ES6 超简单入门笔记

• 看完即可上手 MyBatis-Plus

• 奇怪的函数调用

• 打造后台登录页面扫描工具

• 一道有趣的 Java 基础题

• Spring 拦截器流程及多个拦截器的顺序

• Docker常用命令

• Docker 使用 MySQL

• JWT库生成Token的使用与原理

• Java 项目中几个必不可少的小功能

目录

一、创建 SpringBoot 项目

二、创建项目的结构及代码

三、给接口增加缓存

四、总结

---

        在项目中有些接口调用非常的频繁，但是接口的数据却很少改变，在接口上添加缓存可以有效的提高接口的性能。本文介绍如何在接口上增加缓存来提高接口的性能。

一、创建 SpringBoot 项目

        在项目中，我们通过引入 Redis 服务器来做接口的缓存，我们创建一个 SpringBoot 的项目，先来添加其依赖，依赖如下：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-pool2</artifactId>
    <version>2.6.0</version>
</dependency>

        依赖中引入了 Redis 所需的依赖，以及连接池的依赖，引入依赖后，来完成相关的配置。配置文件如下：

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=

spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
spring.jackson.time-zone=GMT+8

mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

spring.redis.host=127.0.0.1
spring.redis.port=6379
spring.redis.database=0
spring.redis.timeout=1800000
spring.redis.lettuce.pool.max-active=20
spring.redis.lettuce.pool.max-wait=-1
spring.redis.lettuce.pool.max-idle=5
spring.redis.lettuce.pool.min-idle=0

二、创建项目的结构及代码

        写一个简单的 Demo，Demo 的功能有两个，一个用来读取用户的列表，第二个功能用来添加新的用户。我们首先创建 controller、service 和 mapper 三个包结构。然后在其下分别添加相关的代码。

        首先添加 controller 的代码，代码如下：

@RestController
@RequestMapping("/api/user")
public class CacheController
{
    @Autowired
    private CacheService cacheService;

    @GetMapping("getList")
    public List<User> getList() {
        return cacheService.getList();
    }

    @PostMapping("save")
    public void save(User user) {
        cacheService.setUser(user);
    }
}

        在 Controller 中有 getList 和 save 两个方法，getList 方法用来获取用户的列表，save 用来添加新的用户。然后来编写这两个方法对应的 service 代码，代码如下：

@Service
public class CacheServiceImpl extends ServiceImpl<UserMapper, User> implements CacheService
{
    @Override
    public List<User> getList() {
        return baseMapper.selectList(null);
    }

    @Override
    public void setUser(User user) {
        baseMapper.insert(user);
    }
}

        在 service 的 getList 方法，直接调用 baseMapper 的 selectList 方法来获取全部用户的列表，setUser 方法直接调用 baseMapper 的 insert 方法来添加新的用户。

        mapper 文件直接继承 BaseMapper 即可，mapper 代码如下：

@Mapper
public interface UserMapper extends BaseMapper<User>
{
}

        上面的代码是典型 Web 开发的套路。在上面的代码中，每次调用 getList 接口都会查询 user 表，返回用户的列表。在返回的列表中，只要用户的信息不变，或者用户没有增减，那么列表返回的内容总是固定的。在这种情况，每次调用接口都去查询数据库，对数据库而言是一种负担，且是不必要的。这时候给该接口增加一个缓存，那么每次调用 getList 时就无需查询数据库了，这样既减轻了数据库的压力，也提升了接口的性能，这样就非常的 nice 了。

三、给接口增加缓存

        缓存的形式比较多，可以在项目的内存中直接进行缓存，也可以使用专门的缓存服务器进行缓存。如果缓存的内容少，可以直接在项目的内存中进行缓存，省去了缓存服务器的管理与成本，缓存的内容多则在缓存服务器中进行缓存，方便后续的扩容和进行单独的管理等，并且在项目重启后，缓存的内容不丢。本 Demo 我们使用 Redis 服务器来作为缓存。

        使用缓存，首先来增加一个 config 包，在包中创建一个 Redis 的配置类，在该配置类中设置编写 key 生成的规则，设置 RedisTemplate 的规则，设置缓存的规则等。此处，基本上每个 Redis 的配置类都差不多，因此，这里就不贴出具体的代码了。

        在配置好 Redis 的配置类后，无需修改任何代码，只需要在 service 的方法上增加注解，即可给接口增加缓存，增加注解后的 service 代码如下：

@Override
@Cacheable(value = "user", keyGenerator = "keyGenerator")
public List<User> getList() {
    return baseMapper.selectList(null);
}

@Override
@CacheEvict(value = "user", allEntries = true)
public void setUser(User user) {
    baseMapper.insert(user);
}

        在上面的代码中，为两个方法分别增加了注解。第一个 @Cacheable 注解用于给该方法增加一个缓存，另外一个 @CacheEvict 注解用于给清除缓存。在两个注解中，都有一个 value 值，@CacheEvict 清除缓存时会清除指定 value 的缓存。

        增加完缓存后，我们重启项目，重新来测试接口的缓存。在测试接口之前，不要忘记启动 Redis 服务器，然后通过 redis-cli 执行 flushdb 清空 redis 中的缓存，这样方便我们观察缓存中的数据。做好这些准备，我们就可以请求接口的地址了，地址如下：

http://localhost:8080/api/user/getList

        请求上面的接口后，在 IDEA 的控制台中可以看到接口查询数据库的日志记录，日志如下图所示。

        此时来查看 Redis 服务器缓存，缓存中的内容如下图所示。

        可以看到，缓存中已经有数据了，然后再次访问该接口，在 IDEA 的控制台中没有任何的查询日志输出，但是接口同样返回了刚才的数据列表，这样就说明我们接口查询的数据被缓存到 Redis 中了。

        当我们增加一个新的 user 记录时，需要让缓存失效，也就是删除缓存。因为实际的用户列表发生了变化，这个功能由 @CacheEvict 注解为我们完成。我们通过 save 接口来增加一个用户，增加用户如下图。

        此时再来查看 Redis 服务器中的缓存，如下图所示。

        可以看到，刚刚被缓存的用户列表已经没有了。再次调用查询用户列表的接口，仍然可以看到 IDEA 的控制台有数据库的查询日志，且 Redis 服务器中又缓存了新的数据用户列表数据。

四、总结

        并不是所有的接口都适合增加缓存，但是对于类似字典表中的数据我们完全可以进行缓存，还有一些不经常变化的数据也可以进行缓存。

更多文章

• BCryptPasswordEncoder的使用及原理

• Redis | 慢查询

• Druid 的整合

• Dubbo框架的Hello World