SpringBoot整合Caffeine

快来打我* 2022-10-30 05:18 307阅读 0赞

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNjM0ODQ2_size_16_color_FFFFFF_t_70_pic_center]

### 文章目录 ###

*  一. 问题背景
 *  二. 前言
 *  三. 知识储备
 *   *  3.1 Spring Cache简介
     *  3.2 Spring Cache整体概况
     *  3.3 Cache与CacheManager
     *   *  3.3.1 Cache
         *  3.3.2 CacheManager
 *  四. SpringBoot整合Caffeine
 *   *  4.1 引入依赖
     *  4.2 注册CacheManager组件
     *  4.3 开启缓存
     *  4.4 写相关的测试类
     *   *  4.4.1 实体类
         *  4.4.2 Service层
         *  4.4.3 Controller层
     *  4.5 测试
 *  五. 源码

# 一. 问题背景 #

> 公司的项目用到了Caffeine+Redis做双重缓存，在研究[SpringBoot整合Redis（Lettuce客户端）][SpringBoot_Redis_Lettuce]也遇到了关于Spring Cache的知识，因此来去研究一下Spring Cache。**笔者仅对Spring Cache有0到1的认知，如有不正确之处请指出，文末有源码。**

参考自：

*  [（很全面）SpringBoot 使用 Caffeine 本地缓存][SpringBoot _ Caffeine]
 *  [一文深入了解史上最强的Java堆内缓存框架Caffeine][Java_Caffeine]
 *  [spring cache 的官方guide][spring cache _guide]

# 二. 前言 #

<table> 
 <thead> 
  <tr> 
   <th>技术栈</th> 
   <th>版本</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>SpringBoot</td> 
   <td>2.3</td> 
  </tr> 
  <tr> 
   <td>Caffeine</td> 
   <td>2.8.8</td> 
  </tr> 
 </tbody> 
</table>

# 三. 知识储备 #

## 3.1 Spring Cache简介 ##

> **官方文档有如下介绍：**
> 
>  *  缓存抽象提供了其他与缓存相关的操作，例如更新缓存内容或删除一个或所有条目的能力。如果高速缓存处理在应用程序过程中可能发生变化的数据，则这些功能很有用。
>  *  与Spring Framework中的其他服务一样，缓存服务是一种抽象（不是缓存实现），并且需要使用实际的存储来存储缓存数据-也就是说，抽象使您不必编写缓存逻辑，但是没有提供实际的数据存储。**`org.springframework.cache.Cache`和`org.springframework.cache.CacheManager`接口实现了这种抽象** 。
>  *  Spring提供了该抽象的一些实现：`java.util.concurrent.ConcurrentMap`基于JDK的缓存，Ehcache 2.x，Gemfire缓存，Caffeine和符合JSR-107的缓存（例如Ehcache 3.x）。有关插入其他缓存存储区和提供程序的更多信息，请参见插入不同的后端缓存。
>  *  **使用Spring Cache，可以使用更加便捷的注解来使用缓存。比如`@Cacheable`，`@CachePut`，`@CacheEvict`。**
>  *  其他详情可见[Spring Cache官方文档][Spring Cache]

## 3.2 Spring Cache整体概况 ##

> 上面的简介已经介绍了Spring Cache提到了`org.springframework.cache.Cache`和`org.springframework.cache.CacheManager`接口实现了Cache抽象。也就是说，Spring Cache定义了2个标准：Cache以及CacheManager。**开发者可以自由地通过实现这两个标准来整合其他缓存，比如Redis、Caffeine、EhCache、Guava等等。** 在代码层面来说，我们只需向Spring注册一个Cache或CacheManager的实现就可以整合其他缓存了，后面会给出整合Caffeine的例子。

## 3.3 Cache与CacheManager ##

### 3.3.1 Cache ###

> Cache提供了操作内存中数据的方法，比如`get()`、`put()`、`evict()`，**这些方法都只是定义而已（Spring定义标准），真正的实现（比如数据淘汰策略、存储数据的数据结构）由自己想使用哪个Cache决定**。还有一个`getName()`，可见一个Cache有自己的一个`name`。

### 3.3.2 CacheManager ###

> CacheManager是管理若干个内存的。从CacheManager上有`getCache()`、`geteCacheNames()`可以看出一个CacheManager是管理多个Cache的。CacheManager的实现有很多，比如RedisCacheManager、CaffeineManager、EhCacheCacheManager。**也就是一种内存就对应一种CacheManager，一种CacheManager对应多个Cache**

# 四. SpringBoot整合Caffeine #

## 4.1 引入依赖 ##

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-cache</artifactId>
    </dependency>
    
    <dependency>
      <groupId>com.github.ben-manes.caffeine</groupId>
      <artifactId>caffeine</artifactId>
    </dependency>

## 4.2 注册CacheManager组件 ##

@Configuration
    @Slf4j
    public class CacheConfig { 
    
      @Bean("caffeineCacheManager")
      public CacheManager cacheManager() { 
        CaffeineCacheManager cacheManager = new CaffeineCacheManager();
        cacheManager.setCaffeine(Caffeine.newBuilder()
            // 设置最后一次写入或访问后经过固定时间过期
            .expireAfterAccess(60, TimeUnit.SECONDS)
            // 初始的缓存空间大小
            .initialCapacity(100)
            // 缓存的最大条数
            .maximumSize(1000));
        return cacheManager;
      }
    
    }

> 解释：`@Bean`的名字随便取，后面要记得使用自己取的名字

## 4.3 开启缓存 ##

> 在主类加`@EnableCaching`

@SpringBootApplication
    @EnableCaching
    public class GmallCacheApplication { 
    
      public static void main(String[] args) { 
        SpringApplication.run(GmallCacheApplication.class, args);
      }
    
    }

## 4.4 写相关的测试类 ##

### 4.4.1 实体类 ###

> **笔者使用了Lombok插件**，注意加上`@Data`，`@ToString`

@Data
    @ToString
    public class UserInfo { 
      private Integer id;
      private String name;
      private Integer age;
      private String sex;
    
    }

### 4.4.2 Service层 ###

> **注意：**
> 
>  *  测试例子就不连接数据库获取数据了，这里用一个map来模拟数据库
>  *  类开头使用`CacheConfig(cacheNames = "caffeineCacheManager")`作用是类中的每个方法都是使用name为caffeineCacheManager这个缓存，而前面注册CacheManager组件的时候，我们有将Caffeine设置给CacheManager，所以用的是Caffeine缓存
>  *  **标注了`@Cacheable`、`@CachePut`的方法，如果方法的返回类型是void或者方法返回值是null，那么将会把null值存入缓存中，当我插入了数据后，再执行查询，会查出null的，必须注意这一点。因此推荐方法的返回值类型是要存进缓存的值！！！**

@Service
    @Slf4j
    @CacheConfig(cacheNames = "caffeineCacheManager")
    public class UserInfoServiceImpl { 
    
      /** * 模拟数据库存储数据 */
      private HashMap<Integer, UserInfo> userInfoMap = new HashMap<>();
    
      /** * 方法的返回值如果是void或者null，那么缓存的时候会把null缓存进去 * @param userInfo * @return */
      @CachePut(key = "#userInfo.id")
      public UserInfo addUserInfo(UserInfo userInfo) { 
        log.info("addUserInfo");
        log.info("id: {}, userInfo: {}", userInfo.getId(), userInfoMap.get(userInfo.getId()));
        userInfoMap.put(userInfo.getId(), userInfo);
        return userInfoMap.get(userInfo.getId());
      }
    
      @Cacheable(key = "#id")
      public UserInfo getById(Integer id) { 
        log.info("getById");
        UserInfo userInfo = userInfoMap.get(id);
        log.info("userInfo: {}", userInfo);
        return userInfoMap.get(id);
      }
    
      @CachePut(key = "#userInfo.id")
      public UserInfo updateUserInfo(UserInfo userInfo) { 
        log.info("updateUserInfo");
    
        if (!userInfoMap.containsKey(userInfo.getId())) { 
          return new UserInfo();
        }
    
        // 取旧值
        UserInfo oldUserInfo = userInfoMap.get(userInfo.getId());
        log.info("oldUserInfo: {}", oldUserInfo);
        // 替换内容
        if (!StringUtils.isEmpty(oldUserInfo.getAge())) { 
          oldUserInfo.setAge(userInfo.getAge());
        }
        if (!StringUtils.isEmpty(oldUserInfo.getName())) { 
          oldUserInfo.setName(userInfo.getName());
        }
        if (!StringUtils.isEmpty(oldUserInfo.getSex())) { 
          oldUserInfo.setSex(userInfo.getSex());
        }
        //存储新的对象
        userInfoMap.put(oldUserInfo.getId(), oldUserInfo);
        log.info("newUserInfo: {}", oldUserInfo);
        return oldUserInfo;
    
      }
    
      @CacheEvict(key = "#id")
      public void deleteById(Integer id) { 
        log.info("deleteById");
        userInfoMap.remove(id);
      }
    
    }

### 4.4.3 Controller层 ###

@RestController
    @RequestMapping("/cache")
    @Slf4j
    public class UserInfoController { 
    
      @Autowired
      private UserInfoServiceImpl service;
    
      @PostMapping("/userInfo")
      public Object createUserInfo(@RequestBody UserInfo userInfo) { 
        service.addUserInfo(userInfo);
        return "success";
      }
    
      @GetMapping("/userInfo/{id}")
      public Object getUserInfo(@PathVariable Integer id) { 
        UserInfo userInfo = service.getById(id);
        return userInfo;
      }
    
      @PutMapping("/userInfo")
      public Object updateUserInfo(@RequestBody UserInfo userInfo) { 
        UserInfo newUserInfo = service.updateUserInfo(userInfo);
        return newUserInfo;
      }
    
      @DeleteMapping("/userInfo/{id}")
      public Object deleteUserInfo(@PathVariable Integer id) { 
        service.deleteById(id);
        return "success";
      }
    }

## 4.5 测试 ##

> 使用postman发请求进行测试即可。可以先发一个添加数据的请求，再发一个查询数据的请求

# 五. 源码 #

> [前往Gitee下载源码][Gitee]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNjM0ODQ2_size_16_color_FFFFFF_t_70_pic_center]: /images/20221024/f6747f30fd534b8e8de51fd4ae711382.png
[SpringBoot_Redis_Lettuce]: https://blog.csdn.net/qq_40634846/article/details/113815527
[SpringBoot _ Caffeine]: https://zhuanlan.zhihu.com/p/109226599
[Java_Caffeine]: https://www.cnblogs.com/madashu/p/12497025.html
[spring cache _guide]: https://spring.io/guides/gs/caching/
[Spring Cache]: https://docs.spring.io/spring-framework/docs/current/reference/html/integration.html#cache
[Gitee]: https://gitee.com/zilianggan/gmall-learning