jetcache：阿里这款多级缓存框架一定要掌握

浅浅的花香味﹌ 2024-03-22 11:40 127阅读 0赞

## 0. 引言 ##

之前我们讲解了[本地缓存ehcache组件][ehcache]，在实际应用中，并不是单一的使用本地缓存或者redis，更多是组合使用来满足不同的业务场景，于是如何优雅的组合本地缓存和远程缓存就成了我们要研究的问题，而这一点，阿里开源的`jetcache`组件帮我们实现了

## 1. jetcache简介 ##

`jetcache`是阿里开源的基于java开发的缓存框架，支持多种缓存类型：本地缓存、分布式缓存、多级缓存。能够满足不同业务场景的缓存需求。

jetcache具有上手简单、性能高效、拓展性强的特点。支持缓存预热 、缓存key前缀等功能。结合spring-cache使用，可以实现十分优雅的缓存类型切换

官网地址：[https://github.com/alibaba/jetcache][https_github.com_alibaba_jetcache]  
官方文档：[https://github.com/alibaba/jetcache/tree/master/docs/CN][https_github.com_alibaba_jetcache_tree_master_docs_CN]

## 2. jetcache使用 ##

1、引入依赖，这里我们使用sringboot项目框架，同时使用redis作为远程缓存。于是我们引入`jetcache-starter-redis`依赖，这里我的springboot版本为`2.6.13`

如果是非springboot项目可以参考[官网说明配置][Link 1]

![在这里插入图片描述][82bc29ceef52494da0cfd8c67e560669.png]

<dependency>
                <groupId>com.alicp.jetcache</groupId>
                <artifactId>jetcache-starter-redis</artifactId>
                <version>2.7.0</version>
    </dependency>
    
    
    <dependency>
                <groupId>redis.clients</groupId>
                <artifactId>jedis</artifactId>
                <version>4.3.1</version>
    </dependency>

对应的版本说明如下：[springboot与jetcache版本关系][springboot_jetcache]

![在这里插入图片描述][9b3c46f4a91a42d981393ae6a0e27438.png]

2、修改配置文件，配置redis地址和线程数

jetcache:
      # 统计间隔，0表示不统计，开启后定期在控制台输出缓存信息
      statIntervalMinutes: 15
      # 是否把cacheName作为远程缓存key前缀
      areaInCacheName: false
      # 本地缓存配置
      local:
        default: # default表示全部生效，也可以指定某个cacheName
          # 本地缓存类型，其他可选：caffeine/linkedhashmap
          type: linkedhashmap
          keyConvertor: fastjson
      # 远程缓存配置
      remote:
        default: # default表示全部生效，也可以指定某个cacheName
          type: redis
          # key转换器方式n
          keyConvertor: fastjson
          broadcastChannel: projectA
          # redis序列化方式
          valueEncoder: java
          valueDecoder: java
          # redis线程池
          poolConfig:
            minIdle: 5
            maxIdle: 20
            maxTotal: 50
          # redis地址与端口
          host: 127.0.0.1
          port: 6379

更详细的参数配置可参考官网说明：[https://github.com/alibaba/jetcache/blob/master/docs/CN/Config.md][https_github.com_alibaba_jetcache_blob_master_docs_CN_Config.md]

![在这里插入图片描述][3063b28087cd4208a39f5f3868385fda.png]

3、启动类添加注解`@EnableCreateCacheAnnotation`，开启缓存，添加`@EnableMethodCache(basePackages = "com.example.jetcachedemo")`注解，配置缓存方法扫描路径

4、使用缓存可以通过三种方式：

*  方式一（推荐）AOP模式：通过`@Cached`,`@CacheUpdate`,`@CacheInvalidate`注解

@RestController
    @RequestMapping("user")
    public class UserController {
        
    
        @GetMapping("getRemote")
        @Cached(name="userCache:", key = "#id", expire = 3600, timeUnit = TimeUnit.SECONDS, cacheType = CacheType.REMOTE)
        public User getRemote(Long id){
        
            // 直接新建用户，模拟从数据库获取数据
            User user = new User();
            user.setId(id);
            user.setName("用户remote"+id);
            user.setAge(23);
            user.setSex(1);
            System.out.println("第一次获取数据，未走缓存："+id);
            return user;
        }
    
        @GetMapping("getLocal")
        @Cached(name="userCache:", key = "#id", expire = 3600, timeUnit = TimeUnit.SECONDS, cacheType = CacheType.LOCAL)
        public User getLocal(Long id){
        
            // 直接新建用户，模拟从数据库获取数据
            User user = new User();
            user.setId(id);
            user.setName("用户local"+id);
            user.setAge(23);
            user.setSex(1);
            System.out.println("第一次获取数据，未走缓存："+id);
            return user;
        }
    
        @GetMapping("getBoth")
        @Cached(name="userCache:", key = "#id", expire = 3600, timeUnit = TimeUnit.SECONDS, cacheType = CacheType.BOTH)
        public User getBoth(Long id){
        
            // 直接新建用户，模拟从数据库获取数据
            User user = new User();
            user.setId(id);
            user.setName("用户both"+id);
            user.setAge(23);
            user.setSex(1);
            System.out.println("第一次获取数据，未走缓存："+id);
            return user;
        }
    
        @PostMapping("updateUser")
        @CacheUpdate(name = "userCache:", key = "#user.id", value = "#user")
        public Boolean updateUser(@RequestBody User user){
        
            // TODO 更新数据库
            return true;
        }
    
        @PostMapping("deleteUser")
        @CacheInvalidate(name = "userCache:", key = "#id")
        public Boolean deleteUser(Long id){
        
            // TODO 从数据库删除
            return true;
        }
    
    }

这里要注意实体类`User`一定要实现序列化，即声明`Serializable`

@Data
    public class User implements Serializable {
        
    
        private Long id;
        private String name;
        private Integer age;
        private Integer sex;
    }

*  方式二 API模式：通过`@CreateCache`，注：在jetcache 2.7 版本CreateCache注解已废弃，不推荐使用

@RestController
    @RequestMapping("user2")
    public class User2Controller {
        
    
        @CreateCache(name= "userCache:", expire = 3600, timeUnit = TimeUnit.SECONDS, cacheType = CacheType.BOTH)
        private Cache<Long, Object> userCache;
    
        @GetMapping("get")
        public User get(Long id){
        
            if(userCache.get(id) != null){
        
                return (User) userCache.get(id);
            }
            User user = new User();
            user.setId(id);
            user.setName("用户both"+id);
            user.setAge(23);
            user.setSex(1);
            userCache.put(id, user);
            System.out.println("第一次获取数据，未走缓存："+id);
            return user;
        }
    
        @PostMapping("updateUser")
        public Boolean updateUser(@RequestBody User user){
        
            // TODO 更新数据库
            userCache.put(user.getId(), user);
            return true;
        }
    
        @PostMapping("deleteUser")
        public Boolean deleteUser(Long id){
        
            // TODO 从数据库删除
            userCache.remove(id);
            return true;
        }
    
    }

*  方式三 高级API模式：通过`CacheManager`，2.7 版本才可使用

（1）添加依赖

<dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>fastjson</artifactId>
                <version>2.0.25</version>
    </dependency>

（2）书写配置类

@Configuration
    public class JetcacheConfig {
        
    
        @Autowired
        private CacheManager cacheManager;
        private Cache<Long, Object> userCache;
    
        @PostConstruct
        public void init(){
        
            QuickConfig qc = QuickConfig.newBuilder("userCache:")
                    .expire(Duration.ofSeconds(3600))
                    .cacheType(CacheType.BOTH)
                    // 本地缓存更新后，将在所有的节点中删除缓存，以保持强一致性
                    .syncLocal(false)
                    .build();
            userCache = cacheManager.getOrCreateCache(qc);
        }
    
        @Bean
        public Cache<Long, Object> getUserCache(){
        
            return userCache;
        }
    }

（3）调用代码

@RestController
    @RequestMapping("user3")
    public class User3Controller {
        
    
        @Autowired
        JetcacheConfig jetcacheConfig;
        @Autowired
        private Cache<Long, Object> userCache;
    
        @GetMapping("get")
        public User get(Long id){
        
            if(userCache.get(id) != null){
        
                return (User) userCache.get(id);
            }
            User user = new User();
            user.setId(id);
            user.setName("用户both"+id);
            user.setAge(23);
            user.setSex(1);
            userCache.put(id, user);
            System.out.println("第一次获取数据，未走缓存："+id);
            return user;
        }
    
        @PostMapping("updateUser")
        public Boolean updateUser(@RequestBody User user){
        
            // TODO 更新数据库
            userCache.put(user.getId(), user);
            return true;
        }
    
        @PostMapping("deleteUser")
        public Boolean deleteUser(Long id){
        
            // TODO 从数据库删除
            userCache.remove(id);
            return true;
        }
    
    }

多级缓存的形式，会先从本地缓存获取数据，本地获取不到会从远程缓存获取

5、启动redis，启动演示项目

> 注意，如果启动出现`NoClassDefFoundError: redis/clients/util/Pool`或`NoClassDefFoundError: redis/clients/jedis/UnifiedJedis`报错，说明springboot与jetcache版本不一致，对应关系可参考上述第一步中的说明  
> 同时如果使用的是jetcache2.7.x版本，因为该版本中有jedis包的依赖，需要额外添加如下依赖，或者将jetcache版本将至2.6.5以下

<dependency>
                <groupId>redis.clients</groupId>
                <artifactId>jedis</artifactId>
                <version>4.3.1</version>
    </dependency>

## 3. 测试 ##

### 3.1 方式一测试 ###

1、访问localhost:8088/user/getRemote?id=1

![在这里插入图片描述][d07ef0c7ba9d4e5691f44768569ac706.png]

因为配置的是远程缓存，在redis中也能看到对应的key

![在这里插入图片描述][bb847c1d4c5d492fa321a98e7a9d1a1d.png]

2、访问localhost:8088/user/getLocal?id=1，这个方法是从本地缓存获取的，现在只有远程缓存上有数据，我们调用发现缓存数据还是拿到了，这说明当我们在配置文件中配置了本地缓存和远程缓存后，方式一中本地缓存和远程缓存会自动相互调用

比如本地缓存有这个key，redis中没有，通过远程缓存方式访问时，会先从redis获取，如果没有会自动获取本地缓存，但是数据还是存储在本地缓存，并不会同步到redis上，这样更加灵活的实现了多级缓存架构

![在这里插入图片描述][d5858a3a90374d599fc9d4c6a278fa53.png]

### 3.2 方式二测试 ###

1、再测试下`CreateCache`的形式：localhost:8088/user2/get?id=4

![在这里插入图片描述][eb3c18198bd843469ae39e6c0498b153.png]

正常获取了，并且redis中也有了对应的值

![在这里插入图片描述][0b4725dc393e4a559f768fc55ab606b1.png]  
而当我们把缓存方式更改为`LOCAL`后，再访问localhost:8088/user2/get?id=5

@CreateCache(name= "userCache:", expire = 3600, timeUnit = TimeUnit.SECONDS, cacheType = CacheType.LOCAL)

会发现redis中就没有对应缓存了，只在本地缓存存在，说明我们指定本地缓存的形式成功了

![在这里插入图片描述][fe2e976021c545dd9b196e5b6874d214.png]

## 3.3 方式三测试 ##

1、调用localhost:8088/user3/get?id=11

![在这里插入图片描述][d4d01e8413c84f1686a38d0256a946e5.png]

redis中缓存设置成功！

![在这里插入图片描述][275b7ed338d64f7fb2269b84add6098a.png]

## 4. 常见报错 ##

1、 `ClassNotFoundException: com.alibaba.fastjson.JSON`  
解决：添加依赖

<dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>fastjson</artifactId>
                <version>2.0.25</version>
    </dependency>

2、`NoClassDefFoundError: redis/clients/jedis/UnifiedJedis`  
解决：  
添加依赖

<dependency>
                <groupId>redis.clients</groupId>
                <artifactId>jedis</artifactId>
                <version>4.3.1</version>
    </dependency>

或者将jetcache版本降低至2.6.5以下

## 演示源码 ##

[https://gitee.com/wuhanxue/wu\_study/tree/master/demo/jetcache-demo][https_gitee.com_wuhanxue_wu_study_tree_master_demo_jetcache-demo]

[ehcache]: https://blog.csdn.net/qq_24950043/article/details/130296868
[https_github.com_alibaba_jetcache]: https://github.com/alibaba/jetcache
[https_github.com_alibaba_jetcache_tree_master_docs_CN]: https://github.com/alibaba/jetcache/tree/master/docs/CN
[Link 1]: https://github.com/alibaba/jetcache/blob/master/docs/CN/GettingStarted.md
[82bc29ceef52494da0cfd8c67e560669.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/d5c8432021564f5781a45e8e8dc3329c.png
[springboot_jetcache]: https://github.com/alibaba/jetcache/blob/master/docs/CN/Compatibility.md
[9b3c46f4a91a42d981393ae6a0e27438.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/7d052263343c4d2fbd05fb668cfce438.png
[https_github.com_alibaba_jetcache_blob_master_docs_CN_Config.md]: https://github.com/alibaba/jetcache/blob/master/docs/CN/Config.md
[3063b28087cd4208a39f5f3868385fda.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/95bfc048d3c74ca1bfdabfd05f6c237e.png
[d07ef0c7ba9d4e5691f44768569ac706.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/fed6b50e497245d0be5479dd30d00775.png
[bb847c1d4c5d492fa321a98e7a9d1a1d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/b0e0265c2a7f43c6bb4dadffc84f7978.png
[d5858a3a90374d599fc9d4c6a278fa53.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/2d0553601ad5417faa53827ebf2910b6.png
[eb3c18198bd843469ae39e6c0498b153.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/a0107a0b94a446f7b9f10bf64247b1d2.png
[0b4725dc393e4a559f768fc55ab606b1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/1627531c69e24399bb3e16fefa1faccf.png
[fe2e976021c545dd9b196e5b6874d214.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/75dca06575824aba867a3502e8b55c2c.png
[d4d01e8413c84f1686a38d0256a946e5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/7839a6a5d57f458097cc8c82142d81ef.png
[275b7ed338d64f7fb2269b84add6098a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/d2a0186d8e8a4c5b99b128bbcafb35aa.png
[https_gitee.com_wuhanxue_wu_study_tree_master_demo_jetcache-demo]: https://gitee.com/wuhanxue/wu_study/tree/master/demo/jetcache-demo