JetCache 缓存框架的使用及源码解析(推荐)

目录

• 一、简介
• 为什么使用缓存？
• 使用场景
• 使用规范
• 二、如何使用
• 引入maven依赖
• 添加配置
• 配置说明
• 注解说明
• @EnableCreateCacheAnnotation
• @EnableMethodCache
• @CacheInvalidate
• @CacheUpdate
• @CacheRefresh
• @CachePenetrationProtect
• @CreateCache
• 三、源码解析
• 项目的各个子模块
• 常用注解与变量
• 缓存API
• Cache接口
• AbstractCache抽象类
• AbstractEmbeddedCache本地缓存
• LinkedHashMapCache
• Cleaner清理器
• CaffeineCache
• AbstractExternalCache远程缓存
• RedisCache
• RedisLettuceCache
• MultiLevelCache两级缓存
• RefreshCache
• 解析配置
• 初始化构造器
• AbstractCacheAutoInit
• EmbeddedCacheAutoInit
• LinkedHashMapAutoConfiguration
• CaffeineAutoConfiguration
• ExternalCacheAutoInit
• RedisAutoInit
• RedisLettuceAutoInit
• CacheBuilder构造器
• AOP
• 启用JetCache
• @EnableMethodCache
• @EnableCreateCacheAnnotation
• 拦截器
• ConfigProvider
• CacheContext
• JetCacheInterceptor
• CacheHandler

一、简介

JetCache是一个基于Java的缓存系统封装，提供统一的API和注解来简化缓存的使用。 JetCache提供了比SpringCache更加强大的注解，可以原生的支持TTL、两级缓存、分布式自动刷新，还提供了Cache接口用于手工缓存操作。 当前有四个实现：RedisCache、RedisLettuceCache、CaffeineCache、LinkedHashMapCache。

特性：

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

缓存类型：

• 本地

LinkedHashMap：使用LinkedHashMap做LUR方式淘汰
Caffeine：基于Java8开发的提供了近乎最佳命中率的高性能的缓存库

• 远程（访问Redis的客户端）

Redis：使用Jedis客户端，Redis官方首选的Java客户端
RedisSpringData：使用SpringData访问Redis（官网未作介绍）
RedisLettuce：使用Lettuce客户端，一个高性能基于Java的Redis驱动框架，支持线程安全的同步、异步操作，底层集成了Project Reactor，提供反应式编程，参考：关于SpringBoot整合redis使用Lettuce客户端超时问题

为什么使用缓存？

在高并发、大流量等场景下，降低系统延迟，缓解数据库压力，提高系统整体的性能，让用户有更好的体验。

使用场景

读多写少、不追求强一致性、请求入参不易变化

使用规范

选择了远程缓存请设置keyPrefix，保证存放至Redis的缓存key规范化，避免与其他系统出现冲突，例如这样设计：系统简称:所属名字:，这样存储到Redis的缓存key为：系统简称:所属名字:缓存key

选择了本地缓存请设置limit，全局默认设置了100，本地缓存的数据存放于内存，减轻内存的损耗，如果使用了Caffeine，缓存的key过多可能导致内存溢出

请勿滥用缓存注解，对于非必要添加缓存的方法我们尽量不使用缓存

二、如何使用

说明：以下使用方式是基于SpringBoot引入JetCache缓存框架的，如果不是SpringBoot工程，请参考JetCache官网使用

引入maven依赖

    
    
        com.alicp.jetcache
        jetcache-starter-redis
        ${version}
    
    
    
        com.alicp.jetcache
        jetcache-starter-redis-lettuce
        ${version}
    

添加配置

jetcache:
  statIntervalMinutes: 60
  areaInCacheName: false
  penetrationProtect: false
  enableMethodCache: true
  hiddenPackages: com.xxx.xxx,com.xxx.xxx
  local:
    default:
      type: caffeine # 支持的类型：linkedhashmap、caffeine
      limit: 100
      keyConvertor: fastjson # 支持的类型：fastjson，可自定义转换器函数
      expireAfterWriteInMillis: 600000
      expireAfterAccessInMillis: 300000 
  remote:
    default:
      type: redis.lettuce # 支持的类型：redis、redis.lettuce
      keyPrefix: '系统简称:所属名字:'
      keyConvertor: fastjson
      valueEncoder: java # 支持的类型：kryo、java，可自定义编码器
      valueDecoder: java # 支持的类型：kryo、java，可自定义解码器
      expireAfterWriteInMillis: 3600000
      #readFrom: slavePreferred # 优先从Slave节点中读取
      uri: redis-sentinel://host1:26379,host2:26379,host3:26379/?sentinelMasterId=mymaster # 哨兵模式
      #uri: redis://127.0.0.1:6379/ # 单节点模式
      #mode: masterslave # 设置为主从模式
      #uri: # 集群模式
      #- redis://127.0.0.1:7000
      #- redis://127.0.0.1:7001
      #- redis://127.0.0.1:7002
    example:
      keyPrefix: '系统简称:所属名字:'
      type: redis
      keyConvertor: fastjson
      valueEncoder: java
      valueDecoder: java
      expireAfterWriteInMillis: 3600000
      poolConfig:
        minIdle: 10
        maxIdle: 20
        maxTotal: 50
      #password: xxx # 连接密码
      #timeout: 2000 # 连接的超时时间，读取数据的超时时间
      #database: 0 # 连接的数据库
      #clientName: null # 客户端名称
      #ssl: 是否使用SSL
      host: ${redis.host}
      port: ${redis.port}
      #sentinel: host1:26379,host2:26379,host3:26379 # 哨兵模式
      #masterName: mymaster

配置说明

jetcache的全局配置

属性	默认值	说明
jetcache.statIntervalMinutes	0	用于统计缓存调用相关信息的统计间隔（分钟），0表示不统计。
jetcache.areaInCacheName	true	缓存实例名称cacheName会作为缓存key的前缀，2.4.3以前的版本总是把areaName加在cacheName中，因此areaName也出现在key前缀中。我们一般设置为false。
jetcache.penetrationProtect	false	当缓存访问未命中的情况下，对并发进行的加载行为进行保护。 当前版本实现的是单JVM内的保护，即同一个JVM中同一个key只有一个线程去加载，其它线程等待结果。这是全局配置，如果缓存实例没有指定则使用全局配置。
jetcache.enableMethodCache	true	是否使用jetcache缓存。
jetcache.hiddenPackages	无	自动生成缓存实例名称时，为了不让名称太长，hiddenPackages指定的包名前缀会被截掉，多个包名使用逗号分隔。我们一般会指定每个缓存实例的名称。

本地缓存的全局配置

属性	默认值	说明
jetcache.local.${area}.type	无	本地缓存类型，支持 linkedhashmap、caffeine。
jetcache.local.${area}.limit	100	每个缓存实例存储的缓存数量的全局配置，仅本地缓存需要配置，如果缓存实例没有指定则使用全局配置，请结合实例的业务场景进行配置该参数。
jetcache.local.${area}.keyConvertor	无	缓存key转换器的全局配置，支持的类型：fastjson。仅当使用@CreateCache且缓存类型为LOCAL时可以指定为none，此时通过equals方法来识别key。方法缓存必须指定keyConvertor。支持自定义转换器函数，可设置为：bean:beanName，然后会从spring容器中获取该bean。
jetcache.local.${area}.expireAfterWriteInMillis	无穷大	本地缓存超时时间的全局配置（毫秒）。
jetcache.local.${area}.expireAfterAccessInMillis	0	多长时间没访问就让缓存失效的全局配置（毫秒），仅支持本地缓存。0表示不使用这个功能。

远程缓存的全局配置

属性	默认值	说明
jetcache.remote.${area}.type	无	连接Redis的客户端类型，支持 redis、redis.lettuce、redis.springdata。
jetcache.remote.${area}.keyPrefix	无	保存至远程缓存key的前缀，请规范使用。
jetcache.remote.${area}.keyConvertor	无	参考上述说明。
jetcache.remote.${area}.valueEncoder	java	保存至远程缓存value的编码函数，支持：java、kryo。支持自定义编码函数，可设置为：bean:beanName，然后会从spring容器中获取该bean。
jetcache.remote.${area}.valueDecoder	java	保存至远程缓存value的解码函数，支持：java、kryo。支持自定义解码函数，可设置为：bean:beanName，然后会从spring容器中获取该bean。
jetcache.remote.${area}.expireAfterWriteInMillis	无穷大	远程缓存超时时间的全局配置（毫秒）。
jetcache.remote.${area}.uri	无	redis节点信息。

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

关于缓存的超时时间：

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

注解说明

如果需要使用jetcache缓存，启动类添加两个注解：@EnableCreateCacheAnnotation、@EnableMethodCache

@EnableCreateCacheAnnotation

开启可通过@CreateCache注解创建Cache实例功能。

@EnableMethodCache

开启可通过@Cached注解创建Cache实例功能，初始化spring aop，注解说明：

属性	默认值	说明
basePackages	无	jetcache需要拦截的包名，只有这些包名下的Cache实例才会生效
order	Ordered.LOWEST_PRECEDENCE	指定AOP切面执行过程的顺序，默认最低优先级
mode	AdviceMode.PROXY	Spring AOP的模式，目前就提供默认值让你修改
proxyTargetClass	false	无

@Cached

为一个方法添加缓存，创建对应的缓存实例，注解可以添加在接口或者类的方法上面，该类必须是spring bean，注解说明：

属性	默认值	说明
area	"default"	如果在配置中配置了多个缓存area，在这里指定使用哪个area。
name	未定义	指定缓存实例名称，如果没有指定，会根据类名+方法名自动生成。name会被用于远程缓存的key前缀。另外在统计中，一个简短有意义的名字会提高可读性。
enabled	true	是否激活缓存。
timeUnit	TimeUnit.SECONDS	指定expire的单位。
expire	未定义	超时时间。如果注解上没有定义，会使用全局配置，如果此时全局配置也没有定义，则为无穷大。
localExpire	未定义	仅当cacheType为BOTH时适用，为本地缓存指定一个不一样的超时时间，通常应该小于expire。如果没有设置localExpire且cacheType为BOTH，那么本地缓存的超时时间和远程缓存保持一致。
cacheType	CacheType.REMOTE	缓存的类型，支持：REMOTE、LOCAL、BOTH，如果定义为BOTH，会使用LOCAL和REMOTE组合成两级缓存。
localLimit	未定义	如果cacheType为LOCAL或BOTH，这个参数指定本地缓存的最大元素数量，以控制内存占用。如果注解上没有定义，会使用全局配置，如果此时你没有定义全局配置，则使用默认的全局配置100。请结合实际业务场景进行设置该值。
serialPolicy	未定义	指定远程缓存VALUE的序列化方式，支持SerialPolicy.JAVA、SerialPolicy.KRYO。如果注解上没有定义，会使用全局配置，如果你没有定义全局配置，则使用默认的全局配置SerialPolicy.JAVA。
keyConvertor	未定义	指定KEY的转换方式，用于将复杂的KEY类型转换为缓存实现可以接受的类型，支持：KeyConvertor.FASTJSON、KeyConvertor.NONE。NONE表示不转换，FASTJSON可以将复杂对象KEY转换成String。如果注解上没有定义，会使用全局配置。
key	未定义	使用SpEL指定缓存key，如果没有指定会根据入参自动生成。
cacheNullValue	false	当方法返回值为null的时候是否要缓存。
condition	未定义	使用SpEL指定条件，如果表达式返回true的时候才去缓存中查询。
postCondition	未定义	使用SpEL指定条件，如果表达式返回true的时候才更新缓存，该评估在方法执行后进行，因此可以访问到#result。

@CacheInvalidate

用于移除缓存，配置说明：

配置	默认值	说明
area	"default"	如果在配置中配置了多个缓存area，在这里指定使用哪个area。
name	无	指定缓存的唯一名称，一般指向对应的@Cached定义的name。
key	未定义	使用SpEL指定key，如果没有指定会根据入参自动生成。
condition	未定义	使用SpEL指定条件，如果表达式返回true才执行删除，可访问方法结果#result。删除缓存实例中key的元素。
multi	false	如果根据SpEL指定的key是一个集合，是否从缓存实例中删除对应的每个缓存。如果设置为true，但是key不是集合，则不会删除缓存。

@CacheUpdate

用于更新缓存，配置说明：

配置	默认值	说明
area	"default"	如果在配置中配置了多个缓存area，在这里指定使用哪个area。
name	无	指定缓存的唯一名称，一般指向对应的@Cached定义的name。
key	未定义	使用SpEL指定key，如果没有指定会根据入参自动生成。
value	无	使用SpEL指定value。
condition	未定义	使用SpEL指定条件，如果表达式返回true才执行更新，可访问方法结果#result。更新缓存实例中key的元素。
multi	false	如果根据SpEL指定key和value都是集合并且元素的个数相同，则是否更新缓存实例中的对应的每个元素。如果设置为true，但是key不是集合或者value不是集合或者它们的元素的个数不相同，也不会更新缓存。

@CacheRefresh

用于自定刷新缓存，配置说明：

配置	默认值	说明
refresh	无	刷新间隔
stopRefreshAfterLastAccess	未定义	指定该key多长时间没有访问就停止刷新，如果不指定会一直刷新。
refreshLockTimeout	60秒	类型为BOTH/REMOTE的缓存刷新时，同时只会有一台服务器在刷新，这台服务器会在远程缓存放置一个分布式锁，此配置指定该锁的超时时间。
timeUnit	TimeUnit.SECONDS	指定refresh时间单位。

@CachePenetrationProtect

当缓存访问未命中的情况下，对并发进行的加载行为进行保护。 当前版本实现的是单JVM内的保护，即同一个JVM中同一个key只有一个线程去加载，其它线程等待结果，配置说明：

配置	默认值	说明
value	true	是否开启保护模式。
timeout	未定义	其他线程的等待超时时间，如果超时则自己执行方法直接返回结果。
timeUnit	TimeUnit.SECONDS	指定timeout时间单位。

@CreateCache

在Spring Bean中使用该注解可创建一个Cache实例，配置说明：

配置	默认值	说明
area	"default"	如果在配置中配置了多个缓存area，在这里指定使用哪个area。
name	未定义	指定缓存实例名称，如果没有指定，会根据类名+方法名自动生成。name会被用于远程缓存的key前缀。另外在统计中，一个简短有意义的名字会提高可读性。
timeUnit	TimeUnit.SECONDS	指定expire的单位。
expire	未定义	超时时间。如果注解上没有定义，会使用全局配置，如果此时全局配置也没有定义，则为无穷大。
localExpire	未定义	仅当cacheType为BOTH时适用，为本地缓存指定一个不一样的超时时间，通常应该小于expire。如果没有设置localExpire且cacheType为BOTH，那么本地缓存的超时时间和远程缓存保持一致。
cacheType	CacheType.REMOTE	缓存的类型，支持：REMOTE、LOCAL、BOTH，如果定义为BOTH，会使用LOCAL和REMOTE组合成两级缓存。
localLimit	未定义	如果cacheType为LOCAL或BOTH，这个参数指定本地缓存的最大元素数量，以控制内存占用。如果注解上没有定义，会使用全局配置，如果此时你没有定义全局配置，则使用默认的全局配置100。请结合实际业务场景进行设置该值。
serialPolicy	未定义	指定远程缓存VALUE的序列化方式，支持SerialPolicy.JAVA、SerialPolicy.KRYO。如果注解上没有定义，会使用全局配置，如果你没有定义全局配置，则使用默认的全局配置SerialPolicy.JAVA。
keyConvertor	未定义	指定KEY的转换方式，用于将复杂的KEY类型转换为缓存实现可以接受的类型，支持：KeyConvertor.FASTJSON、KeyConvertor.NONE。NONE表示不转换，FASTJSON可以将复杂对象KEY转换成String。如果注解上没有定义，会使用全局配置。

使用示例

/**
 * 启动类
 */
@SpringBootApplication
@EnableCreateCacheAnnotation
@EnableMethodCache(basePackages = "com.xxx.xxx")
public class Application {
    public static void main(String[] args){
        SpringApplication.run(Application.class, args);
    }
}
/**
 * 接口
 */
public interface JetCacheExampleService {
    
    User getValue(long userId);
    
    void updateValue(User  user);
    
    void deleteValue(User  user);
}
/**
 * 实现类
 */
@Service
public class JetCacheExampleServiceImpl implements JetCacheExampleService {
    
    @CreateCache(name = "JetCacheExampleServiceImpl.exampleCache" , localLimit = 50 ,cacheType = CacheType.LOCAL)
    @CachePenetrationProtect
    private Cache exampleCache;
    
    @Override
    @Cached(name = "JetCacheExampleService.getValue", expire = 3600 * 6, localLimit = 50, cacheType = CacheType.BOTH)
    @CacheRefresh(refresh = 3600, stopRefreshAfterLastAccess = 3600 * 2)
    @CachePenetrationProtect
    public User getValue(long userId){
        String result = new User();
        // ... 处理逻辑
        return result;
    }
    
    @Override
    @CacheUpdate(name = "JetCacheExampleService.getValue", key="#user.userId", value="#user")
    public void updateValue(User user){
        // 处理逻辑
    }
    
    @Override
    @CacheInvalidate(name = "JetCacheExampleService.getValue", key="#user.userId")
    public void deleteValue(User user){
        // 处理逻辑
    }
    
}

如上述所示

getValue方法会创建一个缓存实例，通过@Cached注解可以看到缓存实例名称cacheName为'JetCacheExampleService.getValue'，缓存的有效时长为6小时，本地缓存的数量最多为50，缓存类型为BOTH（优先从本地缓存获取）；通过@CacheRefresh注解可以看到会为该缓存实例设置一个刷新策略，刷新间隔为1小时，2个小时没访问后不再刷新，需要刷新的缓存实例会为其每一个缓存数据创建一个RefreshTask周期性任务；@CachePenetrationProtect注解表示该缓存实例开启保护模式，当缓存未命中，同一个JVM中同一个key只有一个线程去加载数据，其它线程等待结果。

updateValue方法可以更新缓存，通过@CacheUpdate注解可以看到会更新缓存实例'JetCacheExampleService.getValue'中缓存key为#user.userId的缓存value为#user。

deleteValue方法可以删除缓存，通过@CacheInvalidate注解可以看到会删除缓存实例'JetCacheExampleService.getValue'中缓存key为#user.userId缓存数据。

exampleCache字段会作为一个缓存实例对象，通过@CreateCache注解可以看到，会将该字段作为cacheName为'JetCacheExampleService.getValue'缓存实例对象，本地缓存的数量最多为50，缓存类型为LOCAL，@CachePenetrationProtect注解表示该缓存实例开启保护模式。

我的业务场景是使用上述的getValue方法创建缓存实例即可。

注意：

• @Cached注解不能和@CacheUpdate或者@CacheInvalidate同时使用
• @CacheInvalidate可以多个同时使用

另外通过@CreateCache注解创建缓存实例也可以这样初始化：

@Service
public class JetCacheExampleServiceImpl implements JetCacheExampleService {
    
	@CreateCache(name = "JetCacheExampleServiceImpl.exampleCache" , localLimit = 50 ,cacheType = CacheType.LOCAL)
	private Cache exampleCache;
	@PostConstruct
	public exampleCacheInit(){
    	RefreshPolicy policy = RefreshPolicy.newPolicy(60, TimeUnit.MINUTES)
                	.stopRefreshAfterLastAccess(120, TimeUnit.MINUTES);
        exampleCache.config().setLoader(this::loadFromDatabase);
        exampleCache.config().setRefreshPolicy(policy);
	}
}

更加详细的使用方法请参考JetCache官方地址。

三、源码解析

参考本人Git仓库中的JetCache项目，已做详细的注释。

简单概括：利用Spring AOP功能，在调用需要缓存的方法前，通过解析注解获取缓存配置，根据这些配置创建不同的实例对象，进行缓存等操作。

JetCache分为两部分，一部分是Cache API以及实现，另一部分是注解支持。

项目的各个子模块

• jetcache-anno-api：定义JetCache注解和常量。
• jetcache-core：核心API，Cache接口的实现，提供各种缓存实例的操作，不依赖于Spring。
• jetcache-autoconfigure：完成初始化，解析application.yml配置文件中的相关配置，以提供不同缓存实例的CacheBuilder构造器
• jetcache-anno：基于Spring提供@Cached和@CreateCache注解支持，初始化Spring AOP以及JetCache注解等配置。
• jetcache-redis：使用Jedis提供Redis支持。
• jetcache-redis-lettuce：使用Lettuce提供Redis支持，实现了JetCache异步访问缓存的的接口。
• jetcache-redis-springdata：使用Spring Data提供Redis支持。
• jetcache-starter-redis：提供pom文件，Spring Boot方式的Starter，基于Jedis。
• jetcache-starter-redis-lettuce：提供pom文件，Spring Boot方式的Starter，基于Lettuce。
• jetcache-starter-redis-springdata：提供pom文件，Spring Boot方式的Starter，基于Spring Data。
• jetcache-test：提供相关测试。

常用注解与变量

在jetcache-anno-api模块中定义了需要用的缓存注解与常量，在上述已经详细的讲述过，其中@CacheInvalidateContainer注解定义value为@CacheInvalidate数组，然后通过jdk8新增的@Repeatable注解，在@CacheInvalidate注解上面添加@Repeatable(CacheInvalidateContainer.class)，即可支持同一个地方可以使用多个@CacheInvalidate注解。

缓存API

主要查看jetcache-core子模块，提供各种Cache缓存，以支持不同的缓存类型

Cache接口的子关系，结构如下图：

主要对象描述：

• Cache：缓存接口，定义基本方法
• AbstractCache：抽象类，缓存接口的继承者，提供基本实现，具体实现交由不同的子类
• LinkedHashMapCache：基于LinkedHashMap设计的简易内存缓存
• CaffeineCache：基于Caffeine工具设计的内存缓存
• RedisCache：Redis实现，使用Jedis客户端
• RedisLettuceCache：Redis实现，使用Lettuce客户端
• MultiLevelCache：两级缓存，用于封装EmbeddedCache（本地缓存）和ExternalCache（远程缓存）
• RefreshCache：基于装饰器模式Decorator，提供自动刷新功能
• LazyInitCache：用于@CreateCache注解创建的缓存实例，依赖于Spring

Cache接口

com.alicp.jetcache.Cache接口，定义了缓存实例的操作方法（部分有默认实现），以及获取分布式锁（非严格，用于刷新远程缓存）的实现，因为继承了java.io.Closeable接口，所以也提供了close方法的默认实现，空方法，交由不同缓存实例的实现去实现该方法用于释放资源，在com.alicp.jetcache.anno.support.ConfigProvider.doShutdown()方法中会调用每个缓存实例对象的close方法进行资源释放。主要代码如下：

public interface Cache extends Closeable {
    Logger logger = LoggerFactory.getLogger(Cache.class);
    //-----------------------------JSR 107 style API------------------------------------------------
    default V get(K key) throws CacheInvokeException {
        CacheGetResult result = GET(key);
        if (result.isSuccess()) {
            return result.getValue();
        } else {
            return null;
        }
    }
    default Map getAll(Set keys) throws CacheInvokeException {
        MultiGetResult cacheGetResults = GET_ALL(keys);
        return cacheGetResults.unwrapValues();
    }
    default void put(K key, V value) {
        PUT(key, value);
    }
    default void putAll(Map map) {
        PUT_ALL(map);
    }
    default boolean putIfAbsent(K key, V value) { // 多级缓存MultiLevelCache不支持此方法
        CacheResult result = PUT_IF_ABSENT(key, value, config().getExpireAfterWriteInMillis(), TimeUnit.MILLISECONDS);
        return result.getResultCode() == CacheResultCode.SUCCESS;
    }
    default boolean remove(K key) {
        return REMOVE(key).isSuccess();
    }
    default void removeAll(Set keys) {
        REMOVE_ALL(keys);
    }
     T unwrap(Class clazz);
    @Override
    default void close() {
    }
    //--------------------------JetCache API---------------------------------------------
    CacheConfig config();
    default AutoReleaseLock tryLock(K key, long expire, TimeUnit timeUnit) {
        if (key == null) {
            return null;
        }
        // 随机生成一个值
        final String uuid = UUID.randomUUID().toString();
        // 过期时间
        final long expireTimestamp = System.currentTimeMillis() + timeUnit.toMillis(expire);
        final CacheConfig config = config();
        AutoReleaseLock lock = () -> { // 创建一把会自动释放资源的锁，实现其 close() 方法
            int unlockCount = 0;
            while (unlockCount++ < config.getTryLockUnlockCount()) {
                if(System.currentTimeMillis() < expireTimestamp) { // 这把锁还没有过期，则删除
                    // 删除对应的 Key 值
                    // 出现的结果：成功，失败，Key 不存在
                    CacheResult unlockResult = REMOVE(key);
                    if (unlockResult.getResultCode() == CacheResultCode.FAIL
                            || unlockResult.getResultCode() == CacheResultCode.PART_SUCCESS) {
                        // 删除对应的 Key 值过程中出现了异常，则重试
                        logger.info("[tryLock] [{} of {}] [{}] unlock failed. Key={}, msg = {}",
                                unlockCount, config.getTryLockUnlockCount(), uuid, key, unlockResult.getMessage());
                        // retry
                    } else if (unlockResult.isSuccess()) { // 释放成功
                        logger.debug("[tryLock] [{} of {}] [{}] successfully release the lock. Key={}",
                                unlockCount, config.getTryLockUnlockCount(), uuid, key);
                        return;
                    } else { // 锁已经被释放了
                        logger.warn("[tryLock] [{} of {}] [{}] unexpected unlock result: Key={}, result={}",
                                unlockCount, config.getTryLockUnlockCount(), uuid, key, unlockResult.getResultCode());
                        return;
                    }
                } else { // 该锁已失效
                    logger.info("[tryLock] [{} of {}] [{}] lock already expired: Key={}",
                            unlockCount, config.getTryLockUnlockCount(), uuid, key);
                    return;
                }
            }
        };
        int lockCount = 0;
        Cache cache = this;
        while (lockCount++ < config.getTryLockLockCount()) {
            // 往 Redis（或者本地） 中存放 Key 值（_#RL#结尾的Key）
            // 返回的结果：成功、已存在、失败
            CacheResult lockResult = cache.PUT_IF_ABSENT(key, uuid, expire, timeUnit);
            if (lockResult.isSuccess()) { // 成功获取到锁
                logger.debug("[tryLock] [{} of {}] [{}] successfully get a lock. Key={}",
                        lockCount, config.getTryLockLockCount(), uuid, key);
                return lock;
            } else if (lockResult.getResultCode() == CacheResultCode.FAIL || lockResult.getResultCode() == CacheResultCode.PART_SUCCESS) {
                logger.info("[tryLock] [{} of {}] [{}] cache access failed during get lock, will inquiry {} times. Key={}, msg={}",
                        lockCount, config.getTryLockLockCount(), uuid,
                        config.getTryLockInquiryCount(), key, lockResult.getMessage());
                // 尝试获取锁的过程中失败了，也就是往 Redis 中存放 Key 值出现异常
                // 这个时候可能 Key 值已经存储了，但是由于其他原因导致返回的结果表示执行失败
                int inquiryCount = 0;
                while (inquiryCount++ < config.getTryLockInquiryCount()) {
                    CacheGetResult inquiryResult = cache.GET(key);
                    if (inquiryResult.isSuccess()) {
                        if (uuid.equals(inquiryResult.getValue())) {
                            logger.debug("[tryLock] [{} of {}] [{}] successfully get a lock after inquiry. Key={}",
                                    inquiryCount, config.getTryLockInquiryCount(), uuid, key);
                            return lock;
                        } else {
                            logger.debug("[tryLock] [{} of {}] [{}] not the owner of the lock, return null. Key={}",
                                    inquiryCount, config.getTryLockInquiryCount(), uuid, key);
                            return null;
                        }
                    } else {
                        logger.info("[tryLock] [{} of {}] [{}] inquiry failed. Key={}, msg={}",
                                inquiryCount, config.getTryLockInquiryCount(), uuid, key, inquiryResult.getMessage());
                        // retry inquiry
                    }
                }
            } else { // 已存在表示该锁被其他人占有
                // others holds the lock
                logger.debug("[tryLock] [{} of {}] [{}] others holds the lock, return null. Key={}",
                        lockCount, config.getTryLockLockCount(), uuid, key);
                return null;
            }
        }
        logger.debug("[tryLock] [{}] return null after {} attempts. Key={}", uuid, config.getTryLockLockCount(), key);
        return null;
    }
    default boolean tryLockAndRun(K key, long expire, TimeUnit timeUnit, Runnable action){
        // Release the lock use Java 7 try-with-resources.
        try (AutoReleaseLock lock = tryLock(key, expire, timeUnit)) { // 尝试获取锁
            if (lock != null) { // 获取到锁则执行下面的任务
                action.run();
                return true;
            } else {
                return false;
            }
            // 执行完锁的操作后会进行资源释放，调用 AutoCloseable 的 close() 方法
        }
    }
    CacheGetResult GET(K key);
    MultiGetResult GET_ALL(Set keys);
    default V computeIfAbsent(K key, Function loader) {
        return computeIfAbsent(key, loader, config().isCacheNullValue());
    }
    V computeIfAbsent(K key, Function loader, boolean cacheNullWhenLoaderReturnNull);
    V computeIfAbsent(K key, Function loader, boolean cacheNullWhenLoaderReturnNull, long expireAfterWrite, TimeUnit timeUnit);
    default void put(K key, V value, long expireAfterWrite, TimeUnit timeUnit) {
        PUT(key, value, expireAfterWrite, timeUnit);
    }
    default CacheResult PUT(K key, V value) {
        if (key == null) {
            return CacheResult.FAIL_ILLEGAL_ARGUMENT;
        }
        return PUT(key, value, config().getExpireAfterWriteInMillis(), TimeUnit.MILLISECONDS);
    }
    CacheResult PUT(K key, V value, long expireAfterWrite, TimeUnit timeUnit);
    default void putAll(Map map, long expireAfterWrite, TimeUnit timeUnit) {
        PUT_ALL(map, expireAfterWrite, timeUnit);
    }
    default CacheResult PUT_ALL(Map map) {
        if (map == null) {
            return CacheResult.FAIL_ILLEGAL_ARGUMENT;
        }
        return PUT_ALL(map, config().getExpireAfterWriteInMillis(), TimeUnit.MILLISECONDS);
    }
    CacheResult PUT_ALL(Map map, long expireAfterWrite, TimeUnit timeUnit);
    CacheResult REMOVE(K key);
    CacheResult REMOVE_ALL(Set keys);
    CacheResult PUT_IF_ABSENT(K key, V value, long expireAfterWrite, TimeUnit timeUnit);
}

com.alicp.jetcache.Cache定义的方法大都是关于缓存的获取、删除和存放操作

其中大写的方法返回JetCache自定义的CacheResult（完整的返回值，可以清晰的知道执行结果，例如get返回null的时候，无法断定是对应的key不存在，还是访问缓存发生了异常）

小写的方法默认实现就是调用大写的方法

computeIfAbsent方法最为核心，交由子类去实现

tryLockAndRun方法会非堵塞的尝试获取一把AutoReleaseLock分布式锁（非严格）,获取过程：

• 尝试往Redis中设置（已存在无法设置）一个键值对，key为缓存key_#RL#，value为UUID，并设置这个键值对的过期时间为60秒（默认）
• 如果获取到锁后进行加载任务，也就是重新加载方法并更新远程缓存
• 该锁实现了java.lang.AutoCloseable接口，使用try-with-resource方式，在执行完加载任务后会自动释放资源，也就是调用close方法将获取锁过程中设置的键值对从Redis中删除
• 在RefreshCache中会调用该方法，因为如果存在远程缓存需要刷新则需要采用分布式锁的方式

AbstractCache抽象类

com.alicp.jetcache.AbstractCache抽象类，实现了Cache接口，主要代码如下：

public abstract class AbstractCache implements Cache {
    /**
     * 当缓存未命中时，并发情况同一个Key是否只允许一个线程去加载，其他线程等待结果（可以设置timeout，超时则自己加载并直接返回）
     * 如果是的话则由获取到Key对应的 LoaderLock.signal（采用了 CountDownLatch）的线程进行加载
     * loaderMap临时保存 Key 对应的 LoaderLock 对象
     */
    private volatile ConcurrentHashMap loaderMap;
    ConcurrentHashMap initOrGetLoaderMap() {
        if (loaderMap == null) {
            synchronized (this) {
                if (loaderMap == null) {
                    loaderMap = new ConcurrentHashMap<>();
                }
            }
        }
        return loaderMap;
    }
    @Override
    public final V computeIfAbsent(K key, Function loader, boolean cacheNullWhenLoaderReturnNull) {
        return computeIfAbsentImpl(key, loader, cacheNullWhenLoaderReturnNull,
                0, null, this);
    }
    @Override
    public final V computeIfAbsent(K key, Function loader, boolean cacheNullWhenLoaderReturnNull,
                                   long expireAfterWrite, TimeUnit timeUnit) {
        return computeIfAbsentImpl(key, loader, cacheNullWhenLoaderReturnNull,
                expireAfterWrite, timeUnit, this);
    }
    private static  boolean needUpdate(V loadedValue, boolean cacheNullWhenLoaderReturnNull, Function loader) {
        if (loadedValue == null && !cacheNullWhenLoaderReturnNull) {
            return false;
        }
        if (loader instanceof CacheLoader && ((CacheLoader) loader).vetoCacheUpdate()) {
            return false;
        }
        return true;
    }
    static  V computeIfAbsentImpl(K key, Function loader, boolean cacheNullWhenLoaderReturnNull,
                                               long expireAfterWrite, TimeUnit timeUnit, Cache cache) {
    	// 获取内部的 Cache 对象
        AbstractCache abstractCache = CacheUtil.getAbstractCache(cache);
        // 封装 loader 函数成一个 ProxyLoader 对象，主要在重新加载缓存后发出一个 CacheLoadEvent 到 CacheMonitor
        CacheLoader newLoader = CacheUtil.createProxyLoader(cache, loader, abstractCache::notify);
        CacheGetResult r;
        if (cache instanceof RefreshCache) { // 该缓存实例需要刷新
            RefreshCache refreshCache = ((RefreshCache) cache);
            /*
             * 从缓存中获取数据
             * 如果是多级缓存（先从本地缓存获取，获取不到则从远程缓存获取）
             * 如果缓存数据是从远程缓存获取到的数据则会更新至本地缓存，并且如果本地缓存没有设置 localExpire 则使用远程缓存的到期时间作为自己的到期时间
             * 我一般不设置 localExpire ，因为可能导致本地缓存的有效时间比远程缓存的有效时间更长
             * 如果设置 localExpire 了记得设置 expireAfterAccessInMillis
             */
            r = refreshCache.GET(key);
            // 添加/更新当前 RefreshCache 的刷新缓存任务，存放于 RefreshCache 的 taskMap 中
            refreshCache.addOrUpdateRefreshTask(key, newLoader);
        } else {
            // 从缓存中获取数据
            r = cache.GET(key);
        }
        if (r.isSuccess()) { // 缓存命中
            return r.getValue();
        } else { // 缓存未命中
            // 创建当缓存未命中去更新缓存的函数
            Consumer cacheUpdater = (loadedValue) -> {
                if(needUpdate(loadedValue, cacheNullWhenLoaderReturnNull, newLoader)) {
                    /*
                     * 未在缓存注解中配置 key 的生成方式则默认取入参作为缓存 key
                     * 在进入当前方法时是否可以考虑为 key 创建一个副本？？？？
                     * 因为缓存未命中然后通过 loader 重新加载方法时，如果方法内部对入参进行了修改，那么生成的缓存 key 也会被修改
                     * 从而导致相同的 key 进入该方法时一直与缓存中的 key 不相同，一直出现缓存未命中
                     */
                    if (timeUnit != null) {
                        cache.PUT(key, loadedValue, expireAfterWrite, timeUnit).waitForResult();
                    } else {
                        cache.PUT(key, loadedValue).waitForResult();
                    }
                }
            };
            V loadedValue;
            if (cache.config().isCachePenetrationProtect()) { // 添加了 @CachePenetrationProtect 注解
            	// 一个JVM只允许一个线程执行
                loadedValue = synchronizedLoad(cache.config(), abstractCache, key, newLoader, cacheUpdater);
            } else {
            	// 执行方法
                loadedValue = newLoader.apply(key);
                // 将新的结果异步缓存
                cacheUpdater.accept(loadedValue);
            }
            return loadedValue;
        }
    }
    static  V synchronizedLoad(CacheConfig config, AbstractCache abstractCache,
                                     K key, Function newLoader, Consumer cacheUpdater) {
        ConcurrentHashMap loaderMap = abstractCache.initOrGetLoaderMap();
        Object lockKey = buildLoaderLockKey(abstractCache, key);
        while (true) {
            // 为什么加一个 create[] 数组 疑问？？
            boolean create[] = new boolean[1];
            LoaderLock ll = loaderMap.computeIfAbsent(lockKey, (unusedKey) -> {
                create[0] = true;
                LoaderLock loaderLock = new LoaderLock();
                loaderLock.signal = new CountDownLatch(1);
                loaderLock.loaderThread = Thread.currentThread();
                return loaderLock;
            });
            if (create[0] || ll.loaderThread == Thread.currentThread()) {
                try {
                    // 加载该 Key 实例的方法
                    V loadedValue = newLoader.apply(key);
                    ll.success = true;
                    ll.value = loadedValue;
                    // 将重新加载的数据更新至缓存
                    cacheUpdater.accept(loadedValue);
                    return loadedValue;
                } finally {
                    // 标记已完成
                    ll.signal.countDown();
                    if (create[0]) {
                        loaderMap.remove(lockKey);
                    }
                }
            } else { // 等待其他线程加载，如果出现异常或者超时则自己加载返回数据，但是不更新缓存
                try {
                    Duration timeout = config.getPenetrationProtectTimeout();
                    if (timeout == null) {
                        ll.signal.await();
                    } else {
                        boolean ok = ll.signal.await(timeout.toMillis(), TimeUnit.MILLISECONDS);
                        if(!ok) {
                            logger.info("loader wait timeout:" + timeout);
                            return newLoader.apply(key);
                        }
                    }
                } catch (InterruptedException e) {
                    logger.warn("loader wait interrupted");
                    return newLoader.apply(key);
                }
                if (ll.success) {
                    return (V) ll.value;
                } else {
                    continue;
                }
            }
        }
    }
    private static Object buildLoaderLockKey(Cache c, Object key) {
        if (c instanceof AbstractEmbeddedCache) {
            return ((AbstractEmbeddedCache) c).buildKey(key);
        } else if (c instanceof AbstractExternalCache) {
            byte bytes[] = ((AbstractExternalCache) c).buildKey(key);
            return ByteBuffer.wrap(bytes);
        } else if (c instanceof MultiLevelCache) {
            c = ((MultiLevelCache) c).caches()[0];
            return buildLoaderLockKey(c, key);
        } else if(c instanceof ProxyCache) {
            c = ((ProxyCache) c).getTargetCache();
            return buildLoaderLockKey(c, key);
        } else {
            throw new CacheException("impossible");
        }
    }
    /**
     * 重新加载数据锁
     */
    static class LoaderLock {
        /**
         * 栅栏
         */
        CountDownLatch signal;
        /**
         * 持有的线程
         */
        Thread loaderThread;
        /**
         * 是否加载成功
         */
        boolean success;
        /**
         * 加载出来的数据
         */，
        Object value;
    }
}

com.alicp.jetcache.AbstractCache实现了Cache接口的大写方法，内部调用自己定义的抽象方法（以DO_开头，交由不同的子类实现），操作缓存后发送相应的事件CacheEvent，也就是调用自己定义的notify方法，遍历每个CacheMonitor对该事件进行后置操作，用于统计信息。

computeIfAbsentImpl方法实现了Cache接口的核心方法，从缓存实例中根据缓存key获取缓存value，逻辑如下：

1. 获取cache的targetCache，因为我们通过@CreateCache注解创建的缓存实例将生成LazyInitCache对象，需要调用其getTargetCache方法才会完成缓存实例的初始化
2. loader函数是对加载原有方法的封装，这里再进行一层封装，封装成ProxyLoader类型，目的是在加载原有方法后将发送CacheLoadEvent事件
3. 从缓存实例中获取对应的缓存value，如果缓存实例对象是RefreshCache类型（在com.alicp.jetcache.anno.support.CacheContext.buildCache方法中会将cache包装成CacheHandlerRefreshCache），则调用RefreshCache.addOrUpdateRefreshTask方法，判断是否应该为它添加一个定时的刷新任务
4. 如果缓存未命中，则执行loader函数，如果开启了保护模式，则调用自定义的synchronizedLoad方法，大致逻辑：根据缓存key从自己的loaderMap（线程安全）遍历中尝试获取（不存在则创建）LoaderLock加载锁，获取到这把加载锁才可以执行loader函数，如果已被其他线程占有则进行等待（没有设置超时时间则一直等待），通过CountDownLatch计数器实现

AbstractEmbeddedCache本地缓存

com.alicp.jetcache.embedded.AbstractEmbeddedCache抽象类继承AbstractCache抽象类，定义了本地缓存的存放缓存数据的对象为com.alicp.jetcache.embedded.InnerMap接口和一个初始化该接口的createAreaCache抽象方法，基于InnerMap接口实现以DO_开头的方法，完成缓存实例各种操作的具体实现，主要代码如下：

public abstract class AbstractEmbeddedCache extends AbstractCache {
    protected EmbeddedCacheConfig config;
    /**
     * 本地缓存的 Map
     */
    protected InnerMap innerMap;
    protected abstract InnerMap createAreaCache();
    public AbstractEmbeddedCache(EmbeddedCacheConfig config) {
        this.config = config;
        innerMap = createAreaCache();
    }
    @Override
    public CacheConfig config() {
        return config;
    }
    public Object buildKey(K key) {
        Object newKey = key;
        Function keyConvertor = config.getKeyConvertor();
        if (keyConvertor != null) {
            newKey = keyConvertor.apply(key);
        }
        return newKey;
    }
    @Override
    protected CacheGetResult do_GET(K key) {
        Object newKey = buildKey(key);
        CacheValueHolder holder = (CacheValueHolder) innerMap.getValue(newKey);
        return parseHolderResult(holder);
    }
    protected CacheGetResult parseHolderResult(CacheValueHolder holder) {
        long now = System.currentTimeMillis();
        if (holder == null) {
            return CacheGetResult.NOT_EXISTS_WITHOUT_MSG;
        } else if (now >= holder.getExpireTime()) {
            return CacheGetResult.EXPIRED_WITHOUT_MSG;
        } else {
            synchronized (holder) {
                long accessTime = holder.getAccessTime();
                if (config.isExpireAfterAccess()) {
                    long expireAfterAccess = config.getExpireAfterAccessInMillis();
                    if (now >= accessTime + expireAfterAccess) {
                        return CacheGetResult.EXPIRED_WITHOUT_MSG;
                    }
                }
                // 设置该缓存数据的最后一次访问时间
                holder.setAccessTime(now);
            }
            return new CacheGetResult(CacheResultCode.SUCCESS, null, holder);
        }
    }
    @Override
    protected MultiGetResult do_GET_ALL(Set keys) {
        ArrayList keyList = new ArrayList(keys.size());
        ArrayList