简介
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支持
创建缓存实例
通过@CreateCache注解创建一个缓存实例，默认超时时间是100秒
@Autowired
private CacheManager cacheManager;
private Cache<Long, UserDO> userCache;
@PostConstruct
public void init() {
QuickConfig qc = QuickConfig.newBuilder("userCache") // name用于统计信息展示名字
.expire(Duration.ofSeconds(100))
//.cacheType(CacheType.BOTH) // 创建一个两级缓存
//.localLimit(100) // 本地缓存元素个数限制，只对CacheType.LOCAL和CacheType.BOTH有效
//.syncLocal(true) // 两级缓存的情况下，缓存更新时发消息让其它JVM实例中的缓存失效，需要配置broadcastChannel才生效。
.build();
userCache = cacheManager.getOrCreateCache(qc);
}用起来就像map一样：
UserDO user = userCache.get(123L);
userCache.put(123L, user);
userCache.remove(123L);创建方法缓存
JetCache方法缓存和SpringCache比较类似，它原生提供了TTL支持，以保证最终一致，并且支持二级缓存。JetCache2.4以后支持基于注解的缓存更新和删除。
在spring环境下，使用@Cached注解可以为一个方法添加缓存，@CacheUpdate用于更新缓存，@CacheInvalidate用于移除缓存元素。注解可以加在接口上也可以加在类上，加注解的类必须是一个spring bean，例如：
public interface UserService {
@Cached(name="userCache.", key="#userId", expire = 3600)
User getUserById(long userId);
@CacheUpdate(name="userCache.", key="#user.userId", value="#user")
void updateUser(User user);
@CacheInvalidate(name="userCache.", key="#userId")
void deleteUser(long userId);
}key使用Spring的SpEL脚本来指定。如果要使用参数名（比如这里的key="#userId"），项目编译设置target必须为1.8格式，并且指定javac的-parameters参数，否则就要使用key="args[0]"这样按下标访问的形式。
@CacheUpdate和@CacheInvalidate的name和area属性必须和@Cached相同，name属性还会用做cache的key前缀。
@Cached注解和@CreateCache的属性非常类似，但是多几个：
| 属性 | 默认值 | 说明 |
|---|---|---|
| area | “default” | 如果在配置中配置了多个缓存area，在这里指定使用哪个area |
| name | 未定义 | 指定缓存的唯一名称，不是必须的，如果没有指定，会使用类名+方法名。name会被用于远程缓存的key前缀。另外在统计中，一个简短有意义的名字会提高可读性。 |
| key | 未定义 | 使用SpEL指定key，如果没有指定会根据所有参数自动生成。 |
| expire | 未定义 | 超时时间。如果注解上没有定义，会使用全局配置，如果此时全局配置也没有定义，则为无穷大 |
| timeUnit | TimeUnit.SECONDS | 指定expire的单位 |
| cacheType | CacheType.REMOTE | 缓存的类型，包括CacheType.REMOTE、CacheType.LOCAL、CacheType.BOTH。如果定义为BOTH，会使用LOCAL和REMOTE组合成两级缓存 |
| localLimit | 未定义 | 如果cacheType为LOCAL或BOTH，这个参数指定本地缓存的最大元素数量，以控制内存占用。如果注解上没有定义，会使用全局配置，如果此时全局配置也没有定义，则为100 |
| localExpire | 未定义 | 仅当cacheType为BOTH时适用，为内存中的Cache指定一个不一样的超时时间，通常应该小于expire |
| serialPolicy | 未定义 | 指定远程缓存的序列化方式。可选值为SerialPolicy.JAVA和SerialPolicy.KRYO。如果注解上没有定义，会使用全局配置，如果此时全局配置也没有定义，则为SerialPolicy.JAVA |
| keyConvertor | 未定义 | 指定KEY的转换方式，用于将复杂的KEY类型转换为缓存实现可以接受的类型，当前支持KeyConvertor.FASTJSON和KeyConvertor.NONE。NONE表示不转换，FASTJSON可以将复杂对象KEY转换成String。如果注解上没有定义，会使用全局配置。 |
| enabled | true | 是否激活缓存。例如某个dao方法上加缓存注解，由于某些调用场景下不能有缓存，所以可以设置enabled为false，正常调用不会使用缓存，在需要的地方可使用CacheContext.enableCache在回调中激活缓存，缓存激活的标记在ThreadLocal上，该标记被设置后，所有enable=false的缓存都被激活 |
| cacheNullValue | false | 当方法返回值为null的时候是否要缓存 |
| condition | 未定义 | 使用SpEL指定条件，如果表达式返回true的时候才去缓存中查询 |
| postCondition | 未定义 | 使用SpEL指定条件，如果表达式返回true的时候才更新缓存，该评估在方法执行后进行，因此可以访问到#result |
@CacheInvalidate注解说明：
| 属性 | 默认值 | 说明 |
|---|---|---|
| area | “default” | 如果在配置中配置了多个缓存area，在这里指定使用哪个area，指向对应的@Cached定义。 |
| name | 未定义 | 指定缓存的唯一名称，指向对应的@Cached定义。 |
| key | 未定义 | 使用SpEL指定key |
| condition | 未定义 | 使用SpEL指定条件，如果表达式返回true才执行删除，可访问方法结果#result |
@CacheUpdate注解说明：
| 属性 | 默认值 | 说明 |
|---|---|---|
| area | “default” | 如果在配置中配置了多个缓存area，在这里指定使用哪个area，指向对应的@Cached定义。 |
| name | 未定义 | 指定缓存的唯一名称，指向对应的@Cached定义。 |
| key | 未定义 | 使用SpEL指定key |
| value | 未定义 | 使用SpEL指定value |
| condition | 未定义 | 使用SpEL指定条件，如果表达式返回true才执行更新，可访问方法结果#result |
使用@CacheUpdate和@CacheInvalidate的时候，相关的缓存操作可能会失败（比如网络IO错误），所以指定缓存的超时时间是非常重要的。
@CacheRefresh注解说明：
| 属性 | 默认值 | 说明 |
|---|---|---|
| refresh | 未定义 | 刷新间隔 |
| timeUnit | TimeUnit.SECONDS | 时间单位 |
| stopRefreshAfterLastAccess | 未定义 | 指定该key多长时间没有访问就停止刷新，如果不指定会一直刷新 |
| refreshLockTimeout | 60秒 | 类型为BOTH/REMOTE的缓存刷新时，同时只会有一台服务器在刷新，这台服务器会在远程缓存放置一个分布式锁，此配置指定该锁的超时时间 |
@CachePenetrationProtect注解：
当缓存访问未命中的情况下，对并发进行的加载行为进行保护。 当前版本实现的是单JVM内的保护，即同一个JVM中同一个key只有一个线程去加载，其它线程等待结果。
基本配置（使用Spring Boot）
如果使用Spring Boot，可以按如下的方式配置（这里使用了jedis客户端连接redis，也可以使用lettuce客户端）。
<dependency>
<groupId>com.alicp.jetcache</groupId>
<artifactId>jetcache-starter-redis</artifactId>
<version>${jetcache.latest.version}</version>
</dependency>配置一个spring boot风格的application.yml文件，把他放到资源目录中
jetcache:
statIntervalMinutes: 15
areaInCacheName: false
local:
default:
type: linkedhashmap
keyConvertor: fastjson
remote:
default:
type: redis
keyConvertor: fastjson2
broadcastChannel: projectA
valueEncoder: java
valueDecoder: java
poolConfig:
minIdle: 5
maxIdle: 20
maxTotal: 50
host: 127.0.0.1
port: 6379配置通用说明如下
| 属性 | 默认值 | 说明 |
|---|---|---|
| jetcache.statIntervalMinutes | 0 | 统计间隔，0表示不统计 |
| jetcache.areaInCacheName | true(2.6-) false(2.7+) | jetcache-anno把cacheName作为远程缓存key前缀，2.4.3以前的版本总是把areaName加在cacheName中，因此areaName也出现在key前缀中。2.4.4以后可以配置，为了保持远程key兼容默认值为true，但是新项目的话false更合理些，2.7默认值已改为false。 |
| jetcache.hiddenPackages | 无 | @Cached和@CreateCache自动生成name的时候，为了不让name太长，hiddenPackages指定的包名前缀被截掉 |
| jetcache.[local/remote].${area}.type | 无 | 缓存类型。tair、redis为当前支持的远程缓存；linkedhashmap、caffeine为当前支持的本地缓存类型 |
| jetcache.[local/remote].${area}.keyConvertor | fastjson2 | key转换器的全局配置，2.6.5+已经支持的keyConvertor：fastjson2/jackson；2.6.5-只有一个已经实现的keyConvertor： fastjson。仅当使用@CreateCache且缓存类型为LOCAL时可以指定为none，此时通过equals方法来识别key。方法缓存必须指定keyConvertor |
| jetcache.[local/remote].${area}.valueEncoder | java | 序列化器的全局配置。仅remote类型的缓存需要指定，2.7+可选java/kryo/kryo5；2.6-可选java/kryo |
| jetcache.[local/remote].${area}.valueDecoder | java | 序列化器的全局配置。仅remote类型的缓存需要指定，2.7+可选java/kryo/kryo5；2.6-可选java/kryo |
| jetcache.[local/remote].${area}.limit | 100 | 每个缓存实例的最大元素的全局配置，仅local类型的缓存需要指定。注意是每个缓存实例的限制，而不是全部，比如这里指定100，然后用@CreateCache创建了两个缓存实例（并且注解上没有设置localLimit属性），那么每个缓存实例的限制都是100 |
| jetcache.[local/remote].${area}.expireAfterWriteInMillis | 无穷大 | 以毫秒为单位指定超时时间的全局配置(以前为defaultExpireInMillis) |
| jetcache.remote.${area}.broadcastChannel | 无 | jetcahe2.7的两级缓存支持更新以后失效其他JVM中的local cache，但多个服务共用redis同一个channel可能会造成广播风暴，需要在这里指定channel，你可以决定多个不同的服务是否共用同一个channel。如果没有指定则不开启。 |
| jetcache.local.${area}.expireAfterAccessInMillis | 0 | 需要jetcache2.2以上，以毫秒为单位，指定多长时间没有访问，就让缓存失效，当前只有本地缓存支持。0表示不使用这个功能。 |
上表中${area}对应@Cached和@CreateCache的area属性。注意如果注解上没有指定area，默认值是"default"。
关于缓存的超时时间，有多个地方指定，澄清说明一下：
- put等方法上指定了超时时间，则以此时间为准
- put等方法上未指定超时时间，使用Cache实例的默认超时时间
- Cache实例的默认超时时间，通过在@CreateCache和@Cached上的expire属性指定，如果没有指定，使用yml中定义的全局配置，例如@Cached(cacheType=local)使用jetcache.local.default.expireAfterWriteInMillis，如果仍未指定则是无穷大
然后创建一个App类放在业务包的根下，EnableMethodCache，EnableCreateCacheAnnotation这两个注解分别激活Cached和CreateCache注解，其他和标准的Spring Boot程序是一样的。这个类可以直接main方法运行。
package com.company.mypackage;
import com.alicp.jetcache.anno.config.EnableCreateCacheAnnotation;
import com.alicp.jetcache.anno.config.EnableMethodCache;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
@EnableMethodCache(basePackages = "com.company.mypackage")
@EnableCreateCacheAnnotation
public class MySpringBootApp {
public static void main(String[] args) {
SpringApplication.run(MySpringBootApp.class);
}
}根据上面的简单描述，我们可以发现JetCache是支持多级缓存的，而且跟J2Cache和Spring.data.cache差不多，都可以通过简单的在方法上使用@Cached、@CacheUpdate、@CacheRefresh、@CacheInvalidate等注解来添加缓存、更新缓存和移除缓存。JetCache不仅支持已有的内存缓存框架，如LinkedHashMap和caffeine，也支持通过jedis、lettuce、redisson和spring-data-redis来缓存数据到Redis服务。当然JetCache不仅可以缓存数据，也可以基于Redis提供了锁的功能。在2.7.X之前的版本中，JetCache并不支持订阅Redis服务端的事件来刷新内存缓存的数据，只提供了一个进程内缓存数据变更的事件广播器，我们就不得不自己去实现相应的功能以保证Redis和内存数据的一致性。
针对JetCache框架的源码分析，我们可以基于如下几个问题，分章节进行介绍：
- JetCache在服务启动时，如何加载缓存配置？
- 添加、更新、移除和刷新缓存操作是如何被执行的？
- JetCache高级特性的支持和扩展有哪些？
1923
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
