阿里开源的缓存框架JetCache，实现spring二级缓存

╰半橙微兮° 2022-09-02 13:58 531阅读 0赞

之前一直在用Spring Cache进行接口数据的缓存，主要是Spring Cache在对具体key缓存失效时间的设置不是很方法，还要自己去扩展，无意中发现了阿里的JetCache。大部分的需求都能满足，并且有一些很实用的功能，今天给大家介绍下。

JetCache是一个基于Java的缓存系统封装，提供统一的API和注解来简化缓存的使用。 JetCache提供了比SpringCache更加强大的注解，可以原生的支持TTL、两级缓存、分布式自动刷新，还提供了Cache接口用于手工缓存操作。 当前有四个实现，RedisCache、TairCache（此部分未在github开源）、CaffeineCache(in memory)和一个简易的LinkedHashMapCache(in memory)，要添加新的实现也是非常简单的。

GitHub：https://github.com/alibaba/jetcache  
![在这里插入图片描述][acd73df290dd4e42843cd730517c065e.png_pic_center]

## 简介 ##

JetCache是一个基于Java的缓存系统封装，提供统一的API和注解来简化缓存的使用。 JetCache提供了比SpringCache更加强大的注解，可以原生的支持TTL、两级缓存、分布式自动刷新，还提供了`Cache`接口用于手工缓存操作。 当前有四个实现，`RedisCache`、`TairCache`（此部分未在github开源）、`CaffeineCache`(in memory)和一个简易的`LinkedHashMapCache`(in memory)，要添加新的实现也是非常简单的。

全部特性:

*  通过统一的API访问Cache系统
 *  通过注解实现声明式的方法缓存，支持TTL和两级缓存
 *  通过注解创建并配置`Cache`实例
 *  针对所有`Cache`实例和方法缓存的自动统计
 *  Key的生成策略和Value的序列化策略是可以配置的
 *  分布式缓存自动刷新，分布式锁 (2.2+)
 *  异步Cache API (2.2+，使用Redis的lettuce客户端时)
 *  Spring Boot支持

## 要求 ##

JetCache需要JDK1.8、Spring Framework4.0.8以上版本。Spring Boot为可选，需要1.1.9以上版本。如果不使用注解（仅使用jetcache-core），Spring Framework也是可选的，此时使用方式与Guava/Caffeine cache类似。

## 文档目录 ##

*  [快速入门][Link 1]
 *  [基本Cache API][Cache API]
 *  [通过@CreateCache注解创建`Cache`实例][CreateCache_Cache]
 *  [通过注解实现方法缓存][Link 2]
 *  [配置详解][Link 3]
 *  [高级Cache API][Cache API 1]
 *  Redis支持(两种redis客户端二选一即可)
    
     *  [使用jedis客户端连接redis][jedis_redis]
     *  [使用lettuce客户端连接redis][lettuce_redis]
 *  [内存缓存`LinkedHashMapCache`和`CaffeineCache`][LinkedHashMapCache_CaffeineCache]
 *  [统计][Link 4]
 *  [Builder][]：未使用Spring4（或未使用Spring）的时候，或通过Builder手工构造`Cache`
 *  [开发者文档][Link 5]
 *  [升级和兼容性指南][Link 6]
 *  [FAQ][]

# 基本配置（使用Spring Boot） #

> 如果使用Spring Boot，可以按如下的方式配置（这里使用了jedis客户端连接redis，如果需要集群、读写分离、异步等特性支持请使用[lettuce][lettuce_redis]客户端）。

增加Maven配置：

<dependency>
        <groupId>com.alicp.jetcache</groupId>
        <artifactId>jetcache-starter-redis</artifactId>
        <version>2.5.14</version>
    </dependency>

# 配置说明 #

jetcache:
      statIntervalMinutes: 15
      areaInCacheName: false
      hidePackages: com.alibaba
      local:
        default:
          type: caffeine
          limit: 100
          keyConvertor: fastjson
          expireAfterWriteInMillis: 100000
        otherArea:
          type: linkedhashmap
          limit: 100
          keyConvertor: none
          expireAfterWriteInMillis: 100000
      remote:
        default:
          type: redis
          keyConvertor: fastjson
          valueEncoder: java
          valueDecoder: java
          poolConfig:
            minIdle: 5
            maxIdle: 20
            maxTotal: 50
          host: ${redis.host}
          port: ${redis.port}
        otherArea:
          type: redis
          keyConvertor: fastjson
          valueEncoder: kryo
          valueDecoder: kryo
          poolConfig:
            minIdle: 5
            maxIdle: 20
            maxTotal: 50
          host: ${redis.host}
          port: ${redis.port}

配置通用说明如下

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>默认值</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>jetcache.statIntervalMinutes</td> 
   <td>0</td> 
   <td>统计间隔，0表示不统计</td> 
  </tr> 
  <tr> 
   <td>jetcache.areaInCacheName</td> 
   <td>true</td> 
   <td>jetcache-anno把cacheName作为远程缓存key前缀，2.4.3以前的版本总是把areaName加在cacheName中，因此areaName也出现在key前缀中。2.4.4以后可以配置，为了保持远程key兼容默认值为true，但是新项目的话false更合理些。</td> 
  </tr> 
  <tr> 
   <td>jetcache.hiddenPackages</td> 
   <td>无</td> 
   <td>@Cached和@CreateCache自动生成name的时候，为了不让name太长，hiddenPackages指定的包名前缀被截掉</td> 
  </tr> 
  <tr> 
   <td>jetcache.[local|remote].${area}.type</td> 
   <td>无</td> 
   <td>缓存类型。tair、redis为当前支持的远程缓存；linkedhashmap、caffeine为当前支持的本地缓存类型</td> 
  </tr> 
  <tr> 
   <td>jetcache.[local|remote].${area}.keyConvertor</td> 
   <td>无</td> 
   <td>key转换器的全局配置，当前只有一个已经实现的keyConvertor：<code>fastjson</code>。仅当使用@CreateCache且缓存类型为LOCAL时可以指定为<code>none</code>，此时通过equals方法来识别key。方法缓存必须指定keyConvertor</td> 
  </tr> 
  <tr> 
   <td>jetcache.[local|remote].${area}.valueEncoder</td> 
   <td>java</td> 
   <td>序列化器的全局配置。仅remote类型的缓存需要指定，可选java和kryo</td> 
  </tr> 
  <tr> 
   <td>jetcache.[local|remote].${area}.valueDecoder</td> 
   <td>java</td> 
   <td>序列化器的全局配置。仅remote类型的缓存需要指定，可选java和kryo</td> 
  </tr> 
  <tr> 
   <td>jetcache.[local|remote].${area}.limit</td> 
   <td>100</td> 
   <td>每个缓存实例的最大元素的全局配置，仅local类型的缓存需要指定。注意是每个缓存实例的限制，而不是全部，比如这里指定100，然后用@CreateCache创建了两个缓存实例（并且注解上没有设置localLimit属性），那么每个缓存实例的限制都是100</td> 
  </tr> 
  <tr> 
   <td>jetcache.[local|remote].${area}.expireAfterWriteInMillis</td> 
   <td>无穷大</td> 
   <td>以毫秒为单位指定超时时间的全局配置(以前为defaultExpireInMillis)</td> 
  </tr> 
  <tr> 
   <td>jetcache.local.${area}.expireAfterAccessInMillis</td> 
   <td>0</td> 
   <td>需要jetcache2.2以上，以毫秒为单位，指定多长时间没有访问，就让缓存失效，当前只有本地缓存支持。0表示不使用这个功能。</td> 
  </tr> 
 </tbody> 
</table>

上表中$\{area\}对应@Cached和@CreateCache的area属性。注意如果注解上没有指定area，默认值是"default"。

关于缓存的超时时间，有多个地方指定，澄清说明一下：

1.  put等方法上指定了超时时间，则以此时间为准
2.  put等方法上未指定超时时间，使用Cache实例的默认超时时间
3.  Cache实例的默认超时时间，通过在@CreateCache和@Cached上的expire属性指定，如果没有指定，使用yml中定义的全局配置，例如@Cached(cacheType=local)使用jetcache.local.default.expireAfterWriteInMillis，如果仍未指定则是无穷大

启动类开启缓存：

@SpringBootApplication
    @EnableMethodCache(basePackages = "com.cxytiandi.jetcache")
    @EnableCreateCacheAnnotation
    public class App {
        public static void main(String[] args) {
            SpringApplication.run(App.class);
        }
    }

*  @EnableMethodCache  
    用于激活@Cached注解的使用
 *  @EnableCreateCacheAnnotation  
    用于激活@CreateCache注解的使用

定义一个简单的实体类来作为数据的缓存，必须实现Serializable接口。

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

**@CreateCache使用**

@CreateCache(expire = 100)
    private Cache<Long, User> userCache;
    
    User user = new User();
    user.setId(1L);
    user.setName("yinjihuan");
    // 新增缓存
    userCache.put(1L, user);
    
    // 删除缓存
    userCache.remove(1L);

用起来很简单，就像操作本地Map一样，@CreateCache中有很多配置需要我们自己去指定，不指定则使用默认的，关于配置请查看文档：https://github.com/alibaba/jetcache/wiki/CreateCache\_CN

**@Cached使用**

@Cached(name="getUser.", key="#id", expire = 8, cacheType=CacheType.BOTH)
    @Override
    public User getUser(Long id) {
    	User user = new User();
    	user.setId(1L);
    	user.setName("yinjihuan");
    	return user;
    }

*  name  
    缓存名称
 *  key  
    缓存key,追加到name后面构成唯一的缓存key, 使用[SpEL][]指定key，如果没有指定会根据所有参数自动生成。
 *  expire  
    缓存失效时间
 *  cacheType  
    缓存的类型，包括CacheType.REMOTE、CacheType.LOCAL、CacheType.BOTH。如果定义为BOTH，会使用LOCAL和REMOTE组合成两级缓存

更多配置的介绍请查看文档：https://github.com/alibaba/jetcache/wiki/MethodCache\_CN

今天的介绍就到这里，使用起来还是很方便的，关于更多的功能大家自行去尝试吧，比如缓存定时刷新，缓存命中率统计，自定义序列化方式等等。

**@Cached定义在接口上的坑**  
还有一个呢就是@Cached如果定义在接口上就不能指定key属性，框架中会自动根据参数生成key, 如果非得自己用SPEL表达式指定key的话，项目编译设置target必须为1.8格式，并且指定javac的-parameters参数，否则就要使用key="args\[0\]"这样按下标访问的形式。我建议还是把@Cached的定义放在实现类上，也方便修改。

[acd73df290dd4e42843cd730517c065e.png_pic_center]: /images/20220829/671727a7318443cabc3c2e913ffdc08c.png
[Link 1]: https://github.com/alibaba/jetcache/wiki/GettingStarted_CN
[Cache API]: https://github.com/alibaba/jetcache/wiki/CacheAPI_CN
[CreateCache_Cache]: https://github.com/alibaba/jetcache/wiki/CreateCache_CN
[Link 2]: https://github.com/alibaba/jetcache/wiki/MethodCache_CN
[Link 3]: https://github.com/alibaba/jetcache/wiki/Config_CN
[Cache API 1]: https://github.com/alibaba/jetcache/wiki/AdvancedCacheAPI_CN
[jedis_redis]: https://github.com/alibaba/jetcache/wiki/RedisWithJedis_CN
[lettuce_redis]: https://github.com/alibaba/jetcache/wiki/RedisWithLettuce_CN
[LinkedHashMapCache_CaffeineCache]: https://github.com/alibaba/jetcache/wiki/Embedded_CN
[Link 4]: https://github.com/alibaba/jetcache/wiki/Stat_CN
[Builder]: https://github.com/alibaba/jetcache/wiki/Builder_CN
[Link 5]: https://github.com/alibaba/jetcache/wiki/DevNote_CN
[Link 6]: https://github.com/alibaba/jetcache/wiki/Compatibility_CN
[FAQ]: https://github.com/alibaba/jetcache/wiki/FAQ_CN
[SpEL]: https://docs.spring.io/spring/docs/4.2.x/spring-framework-reference/html/expressions.html