jetcache官网教程[转]

jetcache 转载地址: https://blog.csdn.net/sinat_32366329/article/details/80260944

简 介

JetCache是 一个基于Java的缓存系统封装,提供统一的API和注解来简化缓存的使用。 JetCache提供了比SpringCache更加强大的注解,可以原生的支持TTL、两级缓存、分布式自动刷新,还提供了Cache接口用于手工缓存操作。当前有四个实现,RedisCacheTairCache(此部分未在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.8Spring Framework4.0.8以上版本。Spring Boot为可选,需要1.1.9以上版本。如果不使用注解(仅使用jetcache-core),Spring Framework也是可选的,此时使用方式与Guava/Caffeinecache类似。

文档目录

依赖哪个jar

  • jetcache-anno-api:定义jetcache的注解和常量,不传递依赖。如果你想把Cached注解加到接口上,又不希望你的接口jar传递太多依赖,可以让接口jar依赖jetcache-anno-api。
  • jetcache-core:核心api,完全通过编程来配置操作Cache,不依赖Spring。两个内存中的缓存实现LinkedHashMapCacheCaffeineCache也由它提供。
  • jetcache-anno:基于Spring提供@Cached和@CreateCache注解支持。
  • jetcache-redis:使用jedis提供Redis支持。
  • jetcache-redis-lettuce(需要JetCache2.3以上版本):使用lettuce提供Redis支持,实现了JetCache异步访问缓存的的接口。
  • jetcache-starter-redis:Spring Boot方式的Starter,基于Jedis。
  • jetcache-starter-redis-lettuce(需要JetCache2.3以上版本):Spring Boot方式的Starter,基于Lettuce。

快速入门

创建缓存实例

通过@CreateCache注解创建一个缓存实例,默认超时时间是100


  
  
  1. @CreateCache(expire = 100)
  2. private Cache<Long, UserDO> userCache;

用起来就像map一样


  
  
  1. UserDO user = userCache.get( 123L);
  2. userCache.put( 123L, user);
  3. userCache.remove( 123L);

创建一个两级(内存+远程)的缓存,内存中的元素个数限制在50个。


  
  
  1. @CreateCache(name = "UserService.userCache", expire = 100, cacheType = CacheType.BOTH, localLimit = 50)
  2. private Cache<Long, UserDO> userCache;

name属性不是必须的,但是起个名字是个好习惯,展示统计数据的使用,会使用这个名字。如果同一个area两个@CreateCachename配置一样,它们生成的Cache将指向同一个实例。

创建方法缓存

使用@Cached方法可以为一个方法添加上缓存。JetCache通过Spring AOP生成代理,来支持缓存功能。注解可以加在接口方法上也可以加在类方法上,但需要保证是个Springbean


  
  
  1. public interface UserService {
  2. @Cached(name= "UserService.getUserById", expire = 3600)
  3. User getUserById(long userId);
  4. }

基本配置(使用Spring Boot)

如果使用SpringBoot,可以按如下的方式配置。

POM


  
  
  1. <dependency>
  2. <groupId>com.alicp.jetcache </groupId>
  3. <artifactId>jetcache-starter-redis </artifactId>
  4. <version>2.4.4 </version>
  5. </dependency>

配置一个springboot风格的application.yml文件,把他放到资源目录中


  
  
  1. jetcache:
  2. statIntervalMinutes: 15
  3. areaInCacheName: false
  4. local:
  5. default:
  6. type: linkedhashmap
  7. keyConvertor: fastjson
  8. remote:
  9. default:
  10. type: redis
  11. keyConvertor: fastjson
  12. valueEncoder: java
  13. valueDecoder: java
  14. poolConfig:
  15. minIdle: 5
  16. maxIdle: 20
  17. maxTotal: 50
  18. host: 127.0.0.1
  19. port: 6379

然后创建一个App类放在业务包的根下,EnableMethodCacheEnableCreateCacheAnnotation这两个注解分别激活CachedCreateCache注解,其他和标准的SpringBoot程序是一样的。这个类可以直接main方法运行。


  
  
  1. package com.company.mypackage;
  2. import com.alicp.jetcache.anno.config.EnableCreateCacheAnnotation;
  3. import com.alicp.jetcache.anno.config.EnableMethodCache;
  4. import org.springframework.boot.SpringApplication;
  5. import org.springframework.boot.autoconfigure.SpringBootApplication;
  6. @SpringBootApplication
  7. @EnableMethodCache(basePackages = "com.company.mypackage")
  8. @EnableCreateCacheAnnotation
  9. public class MySpringBootApp {
  10. public static void main(String[] args) {
  11. SpringApplication.run(MySpringBootApp.class);
  12. }
  13. }

未使用SpringBoot的配置方式

如果没有使用springboot,可以按下面的方式配置(这里使用jedis客户端连接redis为例)。


  
  
  1. <dependency>
  2. <groupId>com.alicp.jetcache </groupId>
  3. <artifactId>jetcache-anno </artifactId>
  4. <version>2.4.4 </version>
  5. </dependency>
  6. <dependency>
  7. <groupId>com.alicp.jetcache </groupId>
  8. <artifactId>jetcache-redis </artifactId>
  9. <version>2.4.4 </version>
  10. </dependency>

配置了这个JetCacheConfig类以后,可以使用@CreateCache@Cached注解。


  
  
  1. package com.company.mypackage;
  2. import java.util.HashMap;
  3. import java.util.Map;
  4. import com.alicp.jetcache.anno.CacheConsts;
  5. import com.alicp.jetcache.anno.config.EnableCreateCacheAnnotation;
  6. import com.alicp.jetcache.anno.config.EnableMethodCache;
  7. import com.alicp.jetcache.anno.support.GlobalCacheConfig;
  8. import com.alicp.jetcache.anno.support.SpringConfigProvider;
  9. import com.alicp.jetcache.embedded.EmbeddedCacheBuilder;
  10. import com.alicp.jetcache.embedded.LinkedHashMapCacheBuilder;
  11. import com.alicp.jetcache.redis.RedisCacheBuilder;
  12. import com.alicp.jetcache.support.FastjsonKeyConvertor;
  13. import com.alicp.jetcache.support.JavaValueDecoder;
  14. import com.alicp.jetcache.support.JavaValueEncoder;
  15. import org.apache.commons.pool2.impl.GenericObjectPoolConfig;
  16. import org.springframework.context.annotation.Bean;
  17. import org.springframework.context.annotation.Configuration;
  18. import redis.clients.jedis.Jedis;
  19. import redis.clients.jedis.JedisPool;
  20. import redis.clients.util.Pool;
  21. @Configuration
  22. @EnableMethodCache(basePackages = "com.company.mypackage")
  23. @EnableCreateCacheAnnotation
  24. public class JetCacheConfig {
  25. @Bean
  26. public Pool<Jedis> pool(){
  27. GenericObjectPoolConfig pc = new GenericObjectPoolConfig();
  28. pc.setMinIdle( 2);
  29. pc.setMaxIdle( 10);
  30. pc.setMaxTotal( 10);
  31. return new JedisPool(pc, "localhost", 6379);
  32. }
  33. @Bean
  34. public SpringConfigProvider springConfigProvider() {
  35. return new SpringConfigProvider();
  36. }
  37. @Bean
  38. public GlobalCacheConfig config(SpringConfigProvider configProvider, Pool<Jedis> pool){
  39. Map localBuilders = new HashMap();
  40. EmbeddedCacheBuilder localBuilder = LinkedHashMapCacheBuilder
  41. .createLinkedHashMapCacheBuilder()
  42. .keyConvertor(FastjsonKeyConvertor.INSTANCE);
  43. localBuilders.put(CacheConsts.DEFAULT_AREA, localBuilder);
  44. Map remoteBuilders = new HashMap();
  45. RedisCacheBuilder remoteCacheBuilder = RedisCacheBuilder.createRedisCacheBuilder()
  46. .keyConvertor(FastjsonKeyConvertor.INSTANCE)
  47. .valueEncoder(JavaValueEncoder.INSTANCE)
  48. .valueDecoder(JavaValueDecoder.INSTANCE)
  49. .jedisPool(pool);
  50. remoteBuilders.put(CacheConsts.DEFAULT_AREA, remoteCacheBuilder);
  51. GlobalCacheConfig globalCacheConfig = new GlobalCacheConfig();
  52. globalCacheConfig.setConfigProvider(configProvider);
  53. globalCacheConfig.setLocalCacheBuilders(localBuilders);
  54. globalCacheConfig.setRemoteCacheBuilders(remoteBuilders);
  55. globalCacheConfig.setStatIntervalMinutes( 15);
  56. globalCacheConfig.setAreaInCacheName( false);
  57. return globalCacheConfig;
  58. }
  59. }

进一步阅读

  • CreateCache的详细使用说明可以看这里
  • 使用@CacheCache创建的Cache接口实例,它的API使用可以看这里
  • 关于方法缓存(@Cached, @CacheUpdate, @CacheInvalidate)的详细使用看这里
  • 详细的配置说明看这里

基本Cache API

简介

JetCache2.0的核心是com.alicp.jetcache.Cache接口(以下简写为Cache),它提供了部分类似于javax.cache.CacheJSR107)的API操作。没有完整实现JSR107的原因包括:

  1. 希望维持API的简单易用。
  2. 对于特定的远程缓存系统来说,javax.cache.Cache中定义的有些操作无法高效率的实现,比如一些原子操作方法和类似removeAll()这样的方法。
  3. JSR107比较复杂,完整实现要做的工作很多。

JSR107 style API

以下是Cache接口中和JSR107javax.cache.Cache接口一致的方法,除了不会抛出异常,这些方法的签名和行为和JSR107都是一样的。


  
  
  1. V get(K key)
  2. void put (K key, V value);
  3. boolean putIfAbsent(K key, V value); //多级缓存MultiLevelCache不支持此方法
  4. boolean remove(K key);
  5. <T> T unwrap(Class<T> clazz); //2.2版本前,多级缓存MultiLevelCache不支持此方法
  6. Map<K,V> getAll(Set<? extends K> keys);
  7. void putAll(Map<? extends K,? extends V> map);
  8. void removeAll(Set<? extends K> keys);

JetCache特有API

V computeIfAbsent(K key, Function<K, V> loader)
  
  

key对应的缓存不存在时,使用loader加载。通过这种方式,loader的加载时间可以被统计到。

V computeIfAbsent(K key, Function<K, V> loader, boolean cacheNullWhenLoaderReturnNull)
  
  

key对应的缓存不存在时,使用loader加载。cacheNullWhenLoaderReturnNull参数指定了当loader加载出来时null值的时候,是否要进行缓存(有时候即使是null值也是通过很繁重的查询才得到的,需要缓存)。

V computeIfAbsent(K key, Function<K, V> loader, boolean cacheNullWhenLoaderReturnNull, long expire, TimeUnit timeUnit)
  
  

key对应的缓存不存在时,使用loader加载。cacheNullWhenLoaderReturnNull参数指定了当loader加载出来时null值的时候,是否要进行缓存(有时候即使是null值也是通过很繁重的查询才得到的,需要缓存)。expiretimeUnit指定了缓存的超时时间,会覆盖缓存的默认超时时间。

void put(K key, V value, long expire, TimeUnit timeUnit)
  
  

put操作,expiretimeUnit指定了缓存的超时时间,会覆盖缓存的默认超时时间。

AutoReleaseLock tryLock(K key, long expire, TimeUnit timeUnit)
  
  
boolean tryLockAndRun(K key, long expire, TimeUnit timeUnit, Runnable action)
  
  

非堵塞的尝试获取一个锁,如果对应的key还没有锁,返回一个AutoReleaseLock,否则立即返回空。如果Cache实例是本地的,它是一个本地锁,在本JVM中有效;如果是redis等远程缓存,它是一个不十分严格的分布式锁。锁的超时时间由expiretimeUnit指定。多级缓存的情况会使用最后一级做tryLock操作。用法如下:


  
  
  1. // 使用try-with-resource方式,可以自动释放锁
  2. try(AutoReleaseLock lock = cache.tryLock( "MyKey", 100, TimeUnit.SECONDS)){
  3. if(lock != null){
  4. // do something
  5. }
  6. }

上面的代码有个潜在的坑是忘记判断if(lock!=null),所以一般可以直接用tryLockAndRun更加简单


  
  
  1. boolean hasRun = tryLockAndRun( "MyKey", 100, TimeUnit.SECONDS), () -> {
  2. // do something
  3. };

tryLock内部会在访问远程缓存失败时重试,会自动释放,而且不会释放不属于自己的锁,比你自己做这些要简单。当然,基于远程缓存实现的任何分布式锁都不会是严格的分布式锁,不能和基于ZooKeeperConsul做的锁相比。

大写API

Vget(K key)这样的方法虽然用起来方便,但有功能上的缺陷,当get返回null的时候,无法断定是对应的key不存在,还是访问缓存发生了异常,所以JetCache针对部分操作提供了另外一套API,提供了完整的返回值,包括:


  
  
  1. CacheGetResult<V> GET(K key);
  2. MultiGetResult<K, V> GET_ALL(Set<? extends K> keys);
  3. CacheResult PUT(K key, V value);
  4. CacheResult PUT(K key, V value, long expireAfterWrite, TimeUnit timeUnit);
  5. CacheResult PUT_ALL(Map<? extends K, ? extends V> map);
  6. CacheResult PUT_ALL(Map<? extends K, ? extends V> map, long expireAfterWrite, TimeUnit timeUnit);
  7. CacheResult REMOVE(K key);
  8. CacheResult REMOVE_ALL(Set<? extends K> keys);
  9. CacheResult PUT_IF_ABSENT(K key, V value, long expireAfterWrite, TimeUnit timeUnit);

这些方法的特征是方法名为大写,与小写的普通方法对应,提供了完整的返回值,用起来也稍微繁琐一些。例如:


  
  
  1. CacheGetResult<OrderDO> r = cache.GET(orderId);
  2. if( r.isSuccess() ){
  3. OrderDO order = r.getValue();
  4. } else if (r.getResultCode() == CacheResultCode.NOT_EXISTS) {
  5. System.out.println( "cache miss:" + orderId);
  6. } else if(r.getResultCode() == CacheResultCode.EXPIRED) {
  7. System.out.println( "cache expired:" + orderId));
  8. } else {
  9. System.out.println( "cache get error:" + orderId);
  10. }

通过@CreateCache注解创建Cache实例

简介

Springbean中使用@CreateCache注解创建一个Cache实例。例如


  
  
  1. @CreateCache(expire = 100)
  2. private Cache<Long, UserDO> userCache;

@CreateCache属性表

属性

默认值

说明

area

“default”

如果需要连接多个缓存系统,可在配置多个cache area,这个属性指定要使用的那个areaname

name

未定义

指定缓存的名称,不是必须的,如果没有指定,会使用类名+方法名。name会被用于远程缓存的key前缀。另外在统计中,一个简短有意义的名字会提高可读性。如果两个@CreateCachenamearea相同,它们会指向同一个Cache实例

expire

未定义

Cache实例的默认超时时间定义,注解上没有定义的时候会使用全局配置,如果此时全局配置也没有定义,则取无穷大

timeUnit

TimeUnit.SECONDS

指定expire的单位

cacheType

CacheType.REMOTE

缓存的类型,包括CacheType.REMOTECacheType.LOCALCacheType.BOTH。如果定义为BOTH,会使用LOCALREMOTE组合成两级缓存

localLimit

未定义

如果cacheTypeCacheType.LOCALCacheType.BOTH,这个参数指定本地缓存的最大元素数量,以控制内存占用。注解上没有定义的时候会使用全局配置,如果此时全局配置也没有定义,则取100

serialPolicy

未定义

如果cacheTypeCacheType.REMOTECacheType.BOTH,指定远程缓存的序列化方式。JetCache内置的可选值为SerialPolicy.JAVASerialPolicy.KRYO。注解上没有定义的时候会使用全局配置,如果此时全局配置也没有定义,则取SerialPolicy.JAVA

keyConvertor

未定义

指定KEY的转换方式,用于将复杂的KEY类型转换为缓存实现可以接受的类型,JetCache内置的可选值为KeyConvertor.FASTJSONKeyConvertor.NONENONE表示不转换,FASTJSON通过fastjson将复杂对象KEY转换成String。如果注解上没有定义,则使用全局配置。

默认值

对于以上未定义默认值的参数,如果没有指定,将使用yml中指定的全局配置,请参考配置详解

通过注解实现方法缓存

JetCache方法缓存和SpringCache比较类似,它原生提供了TTL支持,以保证最终一致,并且支持二级缓存。JetCache2.4以后支持基于注解的缓存更新和删除。

spring环境下,使用@Cached注解可以为一个方法添加缓存,@CacheUpdate用于更新缓存,@CacheInvalidate用于移除缓存元素。注解可以加在接口上也可以加在类上,加注解的类必须是一个spring bean,例如:


  
  
  1. public interface UserService {
  2. @Cached(name= "userCache.", key= "#userId", expire = 3600)
  3. User getUserById(long userId);
  4. @CacheUpdate(name= "userCache.", key= "#user.userId", value= "#user")
  5. void updateUser(User user);
  6. @CacheInvalidate(name= "userCache.", key= "#userId")
  7. void deleteUser(long userId);
  8. }

key使用SpringSpEL脚本来指定。如果要使用参数名(比如这里的key="#userId"),项目编译设置target必须为1.8格式,并且指定javac-parameters参数,否则就要使用key="args[0]"这样按下标访问的形式。

@CacheUpdate@CacheInvalidatenamearea属性必须和@Cached相同,name属性还会用做cachekey前缀。

@Cached注解和@CreateCache的属性非常类似,但是多几个:

属性

默认值

说明

area

“default”

如果在配置中配置了多个缓存area,在这里指定使用哪个area

name

未定义

指定缓存的唯一名称,不是必须的,如果没有指定,会使用类名+方法名。name会被用于远程缓存的key前缀。另外在统计中,一个简短有意义的名字会提高可读性。

key

未定义

使用SpEL指定key,如果没有指定会根据所有参数自动生成。

expire

未定义

超时时间。如果注解上没有定义,会使用全局配置,如果此时全局配置也没有定义,则为无穷大

timeUnit

TimeUnit.SECONDS

指定expire的单位

cacheType

CacheType.REMOTE

缓存的类型,包括CacheType.REMOTECacheType.LOCALCacheType.BOTH。如果定义为BOTH,会使用LOCALREMOTE组合成两级缓存

localLimit

未定义

如果cacheTypeLOCALBOTH,这个参数指定本地缓存的最大元素数量,以控制内存占用。如果注解上没有定义,会使用全局配置,如果此时全局配置也没有定义,则为100

serialPolicy

未定义

指定远程缓存的序列化方式。可选值为SerialPolicy.JAVASerialPolicy.KRYO。如果注解上没有定义,会使用全局配置,如果此时全局配置也没有定义,则为SerialPolicy.JAVA

keyConvertor

未定义

指定KEY的转换方式,用于将复杂的KEY类型转换为缓存实现可以接受的类型,当前支持KeyConvertor.FASTJSONKeyConvertor.NONENONE表示不转换,FASTJSON可以将复杂对象KEY转换成String。如果注解上没有定义,会使用全局配置。

enabled

true

是否激活缓存。例如某个dao方法上加缓存注解,由于某些调用场景下不能有缓存,所以可以设置enabledfalse,正常调用不会使用缓存,在需要的地方可使用CacheContext.enableCache在回调中激活缓存,缓存激活的标记在ThreadLocal上,该标记被设置后,所有enable=false的缓存都被激活

cacheNullValue

false

当方法返回值为null的时候是否要缓存

condition

未定义

使用SpEL指定条件,如果表达式返回true的时候才进行缓存

@CacheInvalidate注解说明:

属性

默认值

说明

area

“default”

如果在配置中配置了多个缓存area,在这里指定使用哪个area,指向对应的@Cached定义。

name

未定义

指定缓存的唯一名称,指向对应的@Cached定义。

key

未定义

使用SpEL指定key

condition

未定义

使用SpEL指定条件,如果表达式返回true才执行删除

@CacheUpdate注解说明:

属性

默认值

说明

area

“default”

如果在配置中配置了多个缓存area,在这里指定使用哪个area,指向对应的@Cached定义。

name

未定义

指定缓存的唯一名称,指向对应的@Cached定义。

key

未定义

使用SpEL指定key

value

未定义

使用SpEL指定value

condition

未定义

使用SpEL指定条件,如果表达式返回true才执行更新

使用@CacheUpdate@CacheInvalidate的时候,相关的缓存操作可能会失败(比如网络IO错误),所以指定缓存的超时时间是非常重要的。

@CacheRefresh注解说明:

属性

默认值

说明

refresh

未定义

刷新间隔

timeUnit

TimeUnit.SECONDS

时间单位

stopRefreshAfterLastAccess

未定义

指定该key多长时间没有访问就停止刷新,如果不指定会一直刷新

refreshLockTimeout

60

类型为BOTH/REMOTE的缓存刷新时,同时只会有一台服务器在刷新,这台服务器会在远程缓存放置一个分布式锁,此配置指定该锁的超时时间

对于以上未定义默认值的参数,如果没有指定,将使用yml中指定的全局配置,全局配置请参考配置说明

配置详解

yml配置文件案例(如果没使用springboot,直接配置GlobalCacheConfig是类似的,参考快速入门教程):


  
  
  1. jetcache:
  2. statIntervalMinutes: 15
  3. areaInCacheName: false
  4. hiddenPackages: com.alibaba
  5. local:
  6. default:
  7. type: caffeine
  8. limit: 100
  9. keyConvertor: fastjson
  10. expireAfterWriteInMillis: 100000
  11. otherArea:
  12. type: linkedhashmap
  13. limit: 100
  14. keyConvertor: none
  15. expireAfterWriteInMillis: 100000
  16. remote:
  17. default:
  18. type: redis
  19. keyConvertor: fastjson
  20. valueEncoder: java
  21. valueDecoder: java
  22. poolConfig:
  23. minIdle: 5
  24. maxIdle: 20
  25. maxTotal: 50
  26. host: ${redis.host}
  27. port: ${redis.port}
  28. otherArea:
  29. type: redis
  30. keyConvertor: fastjson
  31. valueEncoder: kryo
  32. valueDecoder: kryo
  33. poolConfig:
  34. minIdle: 5
  35. maxIdle: 20
  36. maxTotal: 50
  37. host: ${redis.host}
  38. port: ${redis.port}

配置通用说明如下

属性

默认值

说明

jetcache.statIntervalMinutes

0

统计间隔,0表示不统计

jetcache.areaInCacheName

true

jetcache-annocacheName作为远程缓存key前缀,2.4.3以前的版本总是把areaName加在cacheName中,因此areaName也出现在key前缀中。2.4.4以后可以配置,为了保持远程key兼容默认值为true,但是新项目的话false更合理些。

jetcache.hiddenPackages

@Cached@CreateCache自动生成name的时候,为了不让name太长,hiddenPackages指定的包名前缀被截掉

jetcache.[local|remote].${area}.type

缓存类型。tairredis为当前支持的远程缓存;linkedhashmapcaffeine为当前支持的本地缓存类型

jetcache.[local|remote].${area}.keyConvertor

key转换器的全局配置,当前只有一个已经实现的keyConvertorfastjson。仅当使用@CreateCache且缓存类型为LOCAL时可以指定为none,此时通过equals方法来识别key。方法缓存必须指定keyConvertor

jetcache.[local|remote].${area}.valueEncoder

java

序列化器的全局配置。仅remote类型的缓存需要指定,可选javakryo

jetcache.[local|remote].${area}.valueDecoder

java

序列化器的全局配置。仅remote类型的缓存需要指定,可选javakryo

jetcache.[local|remote].${area}.limit

100

每个缓存实例的最大元素的全局配置,仅local类型的缓存需要指定。注意是每个缓存实例的限制,而不是全部,比如这里指定100,然后用@CreateCache创建了两个缓存实例(并且注解上没有设置localLimit属性),那么每个缓存实例的限制都是100

jetcache.[local|remote].${area}.expireAfterWriteInMillis

无穷大

以毫秒为单位指定超时时间的全局配置(以前为defaultExpireInMillis)

jetcache.local.${area}.expireAfterAccessInMillis

0

需要jetcache2.2以上,以毫秒为单位,指定多长时间没有访问,就让缓存失效,当前只有本地缓存支持。0表示不使用这个功能。

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

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

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

高级Cache API

CacheBuilder

CacheBuilder提供使用代码直接构造Cache实例的方式,使用说明看这里。如果没有使用Spring,可以使用CacheBuilder,否则没有必要直接使用CacheBuilder

异步API

JetCache2.2版本开始,所有的大写API返回的CacheResult都支持异步。当底层的缓存实现支持异步的时候,大写API返回的结果都是异步的。当前支持异步的实现只有jetcacheredis-luttece实现,其他的缓存实现(内存中的、TairJedis等),所有的异步接口都会同步堵塞,这样API仍然是兼容的。

以下的例子假设使用redis-luttece访问cache,例如:

CacheGetResult<UserDO> r = cache.GET(userId);
  
  

这一行代码执行完以后,缓存操作可能还没有完成,如果此时调用r.isSuccess()或者r.getValue()或者r.getMessage()将会堵塞直到缓存操作完成。如果不想被堵塞,并且需要在缓存操作完成以后执行后续操作,可以这样做:


  
  
  1. CompletionStage<ResultData> future = r.future();
  2. future.thenRun(() -> {
  3. if(r.isSuccess()){
  4. System.out.println(r.getValue());
  5. }
  6. });

以上代码将会在缓存操作异步完成后,在完成异步操作的线程中调用thenRun中指定的回调。CompletionStageJava8新增的功能,如果对此不太熟悉可以先查阅相关的文档。需要注意的是,既然已经选择了异步的开发方式,在回调中不能调用堵塞方法,以免堵塞其他的线程(回调方法很可能是在event loop线程中执行的)。

部分小写的api不需要任何修改,就可以直接享受到异步开发的好处。比如putremoveAll方法,由于它们没有返回值,所以此时就直接优化成异步调用,能够减少RT;而get方法由于需要取返回值,所以仍然会堵塞。

自动load(read through)

LoadingCache类提供了自动load的功能,它是一个包装,基于decorator模式,也实现了Cache接口。如果CacheBuilder指定了loader,那么buildCache返回的Cache实例就是经过LoadingCache包装过的。例如:


  
  
  1. Cache<Long,UserDO> userCache = LinkedHashMapCacheBuilder.createLinkedHashMapCacheBuilder()
  2. .loader(key -> loadUserFromDatabase(key))
  3. .buildCache();

LoadingCachegetgetAll方法,在缓存未命中的情况下,会调用loader,如果loader抛出一场,getgetAll会抛出CacheInvokeException

需要注意

  1. GET、GET_ALL这类大写API只纯粹访问缓存,不会调用loader。
  2. 如果使用多级缓存,loader应该安装在MultiLevelCache上,不要安装在底下的缓存上。

注解的属性只能是常量,所以没有办法在CreateCache注解中指定loader,不过我们可以这样:


  
  
  1. @CreateCache
  2. private Cache<Long,UserDO> userCache;
  3. @PostConstruct
  4. public void init(){
  5. userCache.config().setLoader( this::loadUserFromDatabase);
  6. }

@CreateCache总是初始化一个经过LoadingCache包装的Cache,直接在config中设置loader,可以实时生效。

自动刷新缓存

JetCache2.2版本开始,RefreshCache基于decorator模式提供了自动刷新的缓存的能力,目的是为了防止缓存失效时造成的雪崩效应打爆数据库。同时设置了loaderrefreshPolicy的时候,CacheBuilderbuildCache方法返回的Cache实例经过了RefreshCache的包装。


  
  
  1. RefreshPolicy policy = RefreshPolicy.newPolicy( 1, TimeUnit.MINUTES)
  2. .stopRefreshAfterLastAccess( 30, TimeUnit.MINUTES);
  3. Cache<String, Long> orderSumCache = LinkedHashMapCacheBuilder
  4. .createLinkedHashMapCacheBuilder()
  5. .loader(key -> loadOrderSumFromDatabase(key))
  6. .refreshPolicy(policy)
  7. .buildCache();

对一些key比较少,实时性要求不高,加载开销非常大的缓存场景,适合使用自动刷新。上面的代码指定每分钟刷新一次,30分钟如果没有访问就停止刷新。如果缓存是redis或者多级缓存最后一级是redis,缓存加载行为是全局唯一的,也就是说不管有多少台服务器,同时只有一个服务器在刷新,这是通过tryLock实现的,目的是为了降低后端的加载负担。

LoadingCache一样,使用@CreateCache时,我们需要这样来添加自动刷新功能


  
  
  1. @CreateCache
  2. private Cache<String, Long> orderSumCache;
  3. @PostConstruct
  4. public void init(){
  5. RefreshPolicy policy = RefreshPolicy.newPolicy( 1, TimeUnit.MINUTES)
  6. .stopRefreshAfterLastAccess( 30, TimeUnit.MINUTES);
  7. orderSumCache.config().setLoader( this::loadOrderSumFromDatabase);
  8. orderSumCache.config().setRefreshPolicy(policy);
  9. }

Redis支持(两种redis客户端二选一即可)

使用jedis客户端连接redis

redis有多种java版本的客户端,JetCache2.2以前使用jedis客户端访问redis。从JetCache2.2版本开始,增加了对luttece客户端的支持,jetcacheluttece支持提供了异步操作和redis集群支持。

如果选用jedis访问redis,对应的maven artifactjetcache-redisjetcache-starter-redis(spring boot)

spring boot环境下的jedis支持

application.yml文件如下(这里省去了local相关的配置):


  
  
  1. jetcache:
  2. areaInCacheName: false
  3. remote:
  4. default:
  5. type: redis
  6. keyConvertor: fastjson
  7. poolConfig:
  8. minIdle: 5
  9. maxIdle: 20
  10. maxTotal: 50
  11. host: ${redis.host}
  12. port: ${redis.port}
  13. #sentinels: 127.0.0.1: 26379 , 127.0.0.1: 26380, 127.0.0.1: 26381
  14. #masterName: mymaster
 
  
  

如果需要直接操作JedisPool,可以通过以下方式获取


  
  
  1. @Bean(name = "defaultPool")
  2. @DependsOn(RedisAutoConfiguration.AUTO_INIT_BEAN_NAME) //jetcache2.2+
  3. //@DependsOn("redisAutoInit")//jetcache2.1
  4. public JedisPoolFactory defaultPool() {
  5. return new JedisPoolFactory( "remote.default", JedisPool.class);
  6. }

然后可以直接使用


  
  
  1. @Autowired
  2. private Pool<Jedis> defaultPool;

也可以用Cache接口上的<T> Tunwrap(Class<T> clazz)方法来获取JedisPool,参见RedisCache.unwrap源代码。

不使用spring boot

 


  
  
  1. @Configuration
  2. @EnableMethodCache(basePackages = "com.company.mypackage")
  3. @EnableCreateCacheAnnotation
  4. public class JetCacheConfig {
  5. @Bean
  6. public Pool<Jedis> pool(){
  7. // build jedis pool ...
  8. }
  9. @Bean
  10. public SpringConfigProvider springConfigProvider() {
  11. return new SpringConfigProvider();
  12. }
  13. @Bean
  14. public GlobalCacheConfig config(SpringConfigProvider configProvider, Pool<Jedis> pool){
  15. Map localBuilders = new HashMap();
  16. EmbeddedCacheBuilder localBuilder = LinkedHashMapCacheBuilder
  17. .createLinkedHashMapCacheBuilder()
  18. .keyConvertor(FastjsonKeyConvertor.INSTANCE);
  19. localBuilders.put(CacheConsts.DEFAULT_AREA, localBuilder);
  20. Map remoteBuilders = new HashMap();
  21. RedisCacheBuilder remoteCacheBuilder = RedisCacheBuilder.createRedisCacheBuilder()
  22. .keyConvertor(FastjsonKeyConvertor.INSTANCE)
  23. .valueEncoder(JavaValueEncoder.INSTANCE)
  24. .valueDecoder(JavaValueDecoder.INSTANCE)
  25. .jedisPool(pool);
  26. remoteBuilders.put(CacheConsts.DEFAULT_AREA, remoteCacheBuilder);
  27. GlobalCacheConfig globalCacheConfig = new GlobalCacheConfig();
  28. globalCacheConfig.setConfigProvider(configProvider);
  29. globalCacheConfig.setLocalCacheBuilders(localBuilders);
  30. globalCacheConfig.setRemoteCacheBuilders(remoteBuilders);
  31. globalCacheConfig.setStatIntervalMinutes( 15);
  32. globalCacheConfig.setAreaInCacheName( false);
  33. return globalCacheConfig;
  34. }
  35. }

Builder API

如果不通过@CreateCache@Cached注解,可以通过下面的方式创建RedisCache。通过注解创建的缓存会自动设置keyPrefix,这里是手工创建缓存,对于远程缓存需要设置keyPrefix属性,以免不同Cache实例的key发生冲突。


  
  
  1. GenericObjectPoolConfig pc = new GenericObjectPoolConfig();
  2. pc.setMinIdle( 2);
  3. pc.setMaxIdle( 10);
  4. pc.setMaxTotal( 10);
  5. JedisPool pool = new JedisPool(pc, "localhost", 6379);
  6. Cache<Long,OrderDO> orderCache = RedisCacheBuilder.createRedisCacheBuilder()
  7. .keyConvertor(FastjsonKeyConvertor.INSTANCE)
  8. .valueEncoder(JavaValueEncoder.INSTANCE)
  9. .valueDecoder(JavaValueDecoder.INSTANCE)
  10. .jedisPool(pool)
  11. .keyPrefix( "orderCache")
  12. .expireAfterWrite( 200, TimeUnit.SECONDS)
  13. .buildCache();

常见问题

如果遇到这个错误

java.lang.NoSuchMethodError: redis.clients.jedis.JedisPool.<init>(Lorg/apache/commons/pool2/impl/GenericObjectPoolConfig;Ljava/lang/String;IILjava/lang/String;ILjava/lang/String;Z)V
  
  

请确保jedis的版本在2.9.0以上,spring boot 1.5以下版本的spring-boot-dependencies会引入较低版本的jedis,可以在自己的pom中强制直接依赖jedis版本2.9.0


  
  
  1. <dependency>
  2. <groupId>redis.clients </groupId>
  3. <artifactId>jedis </artifactId>
  4. <version>2.9.0 </version>
  5. </dependency>

使用lettuce客户端连接redis

redis有多种java版本的客户端,JetCache2.2以前使用jedis客户端访问redis。从JetCache2.2版本开始,增加了对lettuce客户端的支持,JetCachelettuce支持提供了异步操作和redis集群支持。

使用lettuce访问redis,对应的maven artifactjetcache-redis-lettucejetcache-starter-redis-lettucelettuce使用Netty建立单个连接连redis,所以不需要配置连接池。

注意:新发布的lettuce5更换了groupId和包名,2.3版本的JetCache同时支持lettuce45jetcache-redis-lettucejetcache-starter-redis-lettuce提供lettuce5支持,jetcache-redis-lettuce4jetcache-starter-redis-lettuce4提供lettuce4支持。

注意:JetCache2.2版本中,lettuce单词存在错误的拼写,错写为“luttece”,该错误存在于包名、类名和配置中,2.3已经改正。

spring boot环境下的lettuce支持

application.yml文件如下(这里省去了local相关的配置):


  
  
  1. jetcache:
  2. areaInCacheName: false
  3. remote:
  4. default:
  5. type: redis.lettuce
  6. keyConvertor: fastjson
  7. uri: redis: //127.0.0.1:6379/
 
  
  

如果使用sentinel做自动主备切换,uri可以配置为redis-sentinel://127.0.0.1:26379,127.0.0.1:26380,127.0.0.1:26381/?sentinelMasterId=mymaster

如果是集群:


  
  
  1. jetcache:
  2. areaInCacheName: false
  3. remote:
  4. default:
  5. type: redis.lettuce
  6. keyConvertor: fastjson
  7. uri:
  8. - redis: //127.0.0.1:7000
  9. - redis: //127.0.0.1:7001
  10. - redis: //127.0.0.1:7002
 
  
  

如果需要直接使用lettuceRedisClient


  
  
  1. @Bean(name = "defaultClient")
  2. @DependsOn(RedisLettuceAutoConfiguration.AUTO_INIT_BEAN_NAME)
  3. public LettuceFactory defaultClient() {
  4. return new LettuceFactory( "remote.default", RedisClient.class);
  5. }

然后可以直接使用


  
  
  1. @Autowired
  2. private RedisClient defaultClient;

也可以用Cache接口上的<T> Tunwrap(Class<T> clazz)方法来获取RedisClientRedisCommands等。参考RedisLettuceCache.unwrap源代码。

不使用spring boot

 


  
  
  1. @Configuration
  2. @EnableMethodCache(basePackages = "com.company.mypackage")
  3. @EnableCreateCacheAnnotation
  4. public class JetCacheConfig {
  5. @Bean
  6. public RedisClient redisClient(){
  7. RedisClient client = RedisClient.create( "redis://127.0.0.1");
  8. return client;
  9. }
  10. @Bean
  11. public SpringConfigProvider springConfigProvider() {
  12. return new SpringConfigProvider();
  13. }
  14. @Bean
  15. public GlobalCacheConfig config(SpringConfigProvider configProvider,RedisClient redisClient){
  16. Map localBuilders = new HashMap();
  17. EmbeddedCacheBuilder localBuilder = LinkedHashMapCacheBuilder
  18. .createLinkedHashMapCacheBuilder()
  19. .keyConvertor(FastjsonKeyConvertor.INSTANCE);
  20. localBuilders.put(CacheConsts.DEFAULT_AREA, localBuilder);
  21. Map remoteBuilders = new HashMap();
  22. RedisLettuceCacheBuilder remoteCacheBuilder = RedisLettuceCacheBuilder.createRedisLettuceCacheBuilder()
  23. .keyConvertor(FastjsonKeyConvertor.INSTANCE)
  24. .valueEncoder(JavaValueEncoder.INSTANCE)
  25. .valueDecoder(JavaValueDecoder.INSTANCE)
  26. .redisClient(redisClient);
  27. remoteBuilders.put(CacheConsts.DEFAULT_AREA, remoteCacheBuilder);
  28. GlobalCacheConfig globalCacheConfig = new GlobalCacheConfig();
  29. globalCacheConfig.setConfigProvider(configProvider);
  30. globalCacheConfig.setLocalCacheBuilders(localBuilders);
  31. globalCacheConfig.setRemoteCacheBuilders(remoteBuilders);
  32. globalCacheConfig.setStatIntervalMinutes( 15);
  33. globalCacheConfig.setAreaInCacheName( false);
  34. return globalCacheConfig;
  35. }
  36. }

builder API

如果不通过@CreateCache@Cached注解,可以通过下面的方式创建Cache。通过注解创建的缓存会自动设置keyPrefix,这里是手工创建缓存,对于远程缓存需要设置keyPrefix属性,以免不同Cache实例的key发生冲突。


  
  
  1. RedisClient client = RedisClient.create( "redis://127.0.0.1");
  2. Cache<Long,OrderDO> orderCache = RedisLettuceCacheBuilder.createRedisLettuceCacheBuilder()
  3. .keyConvertor(FastjsonKeyConvertor.INSTANCE)
  4. .valueEncoder(JavaValueEncoder.INSTANCE)
  5. .valueDecoder(JavaValueDecoder.INSTANCE)
  6. .redisClient(client)
  7. .keyPrefix( "orderCache")
  8. .expireAfterWrite( 200, TimeUnit.SECONDS)
  9. .buildCache();

内存缓存LinkedHashMapCache和CaffeineCache

本地缓存当前有两个实现。如果自己用jetcache-coreCache API,可以不指定keyConvertor,此时本地缓存使用equals方法来比较key如果使用jetcache-anno中的@Cached@CreateCache等注解,必须指定keyConvertor

LinkedHashMapCache

LinkedHashMapCacheJetCache中实现的一个最简单的Cache,使用LinkedHashMapLRU方式淘汰。


  
  
  1. Cache<Long, OrderDO> cache = LinkedHashMapCacheBuilder.createLinkedHashMapCacheBuilder()
  2. .limit( 100)
  3. .expireAfterWrite( 200, TimeUnit.SECONDS)
  4. .buildCache();

CaffeineCache

caffeine cache的介绍看这里,它是guava cache的后续作品。


  
  
  1. Cache<Long, OrderDO> cache = CaffeineCacheBuilder.createCaffeineCacheBuilder()
  2. .limit( 100)
  3. .expireAfterWrite( 200, TimeUnit.SECONDS)
  4. .buildCache();

统计

yml中的jetcache.statIntervalMinutes大于0时,通过@CreateCache@Cached配置出来的Cache自带监控。JetCache会按指定的时间定期通过logger输出统计信息。默认输出信息类似如下:

2017-01-12 19:00:00,001 INFO  support.StatInfoLogger - jetcache stat from 2017-01-12 18:59:00,000 to 2017-01-12 19:00:00,000
cache                                                |       qps|   rate|           get|           hit|          fail|        expire|avgLoadTime|maxLoadTime
-----------------------------------------------------+----------+-------+--------------+--------------+--------------+--------------+-----------+-----------
default_AlicpAppChannelManager.getAlicpAppChannelById|      0.00|  0.00%|             0|             0|             0|             0|        0.0|          0
default_ChannelManager.getChannelByAccessToten       |     30.02| 99.78%|         1,801|         1,797|             0|             4|        0.0|          0
default_ChannelManager.getChannelByAppChannelId      |      8.30| 99.60%|           498|           496|             0|             1|        0.0|          0
default_ChannelManager.getChannelById                |      6.65| 98.75%|           399|           394|             0|             4|        0.0|          0
default_ConfigManager.getChannelConfig               |      1.97| 96.61%|           118|           114|             0|             4|        0.0|          0
default_ConfigManager.getGameConfig                  |      0.00|  0.00%|             0|             0|             0|             0|        0.0|          0
default_ConfigManager.getInstanceConfig              |     43.98| 99.96%|         2,639|         2,638|             0|             0|        0.0|          0
default_ConfigManager.getInstanceConfigSettingMap    |      2.45| 70.75%|           147|           104|             0|            43|        0.0|          0
default_GameManager.getGameById                      |      1.33|100.00%|            80|            80|             0|             0|        0.0|          0
default_GameManager.getGameUrlByUrlKey               |      7.33|100.00%|           440|           440|             0|             0|        0.0|          0
default_InstanceManager.getInstanceById              |     30.98| 99.52%|         1,859|         1,850|             0|             0|        0.0|          0
default_InstanceManager.getInstanceById_local        |     30.98| 96.40%|         1,859|         1,792|             0|            67|        0.0|          0
default_InstanceManager.getInstanceById_remote       |      1.12| 86.57%|            67|            58|             0|             6|        0.0|          0
default_IssueDao.getIssueById                        |      7.62| 81.40%|           457|           372|             0|            63|        0.0|          0
default_IssueDao.getRecentOnSaleIssues               |      8.00| 85.21%|           480|           409|             0|            71|        0.0|          0
default_IssueDao.getRecentOpenAwardIssues            |      2.52| 82.78%|           151|           125|             0|            26|        0.0|          0
default_PrizeManager.getPrizeMap                     |      0.82|100.00%|            49|            49|             0|             0|        0.0|          0
default_TopicManager.getOnSaleTopics                 |      0.97|100.00%|            58|            58|             0|             0|        0.0|          0
default_TopicManager.getOnSaleTopics_local           |      0.97| 91.38%|            58|            53|             0|             5|        0.0|          0
default_TopicManager.getOnSaleTopics_remote          |      0.08|100.00%|             5|             5|             0|             0|        0.0|          0
default_TopicManager.getTopicByTopicId               |      2.90| 98.85%|           174|           172|             0|             0|        0.0|          0
default_TopicManager.getTopicByTopicId_local         |      2.90| 96.55%|           174|           168|             0|             6|        0.0|          0
default_TopicManager.getTopicByTopicId_remote        |      0.10| 66.67%|             6|             4|             0|             2|        0.0|          0
default_TopicManager.getTopicList                    |      0.02|100.00%|             1|             1|             0|             0|        0.0|          0
default_TopicManager.getTopicList_local              |      0.02|  0.00%|             1|             0|             0|             1|        0.0|          0
default_TopicManager.getTopicList_remote             |      0.02|100.00%|             1|             1|             0|             0|        0.0|          0
-----------------------------------------------------+----------+-------+--------------+--------------+--------------+--------------+-----------+-----------

只有使用computeIfAbsent方法或者@Cached注解才会统计loadTime。用get方法取缓存,没有命中的话自己去数据库load,显然是无法统计到的。

如果需要定制输出,可以这样做:


  
  
  1. @Bean
  2. public SpringConfigProvider springConfigProvider() {
  3. return new SpringConfigProvider(){
  4. public Consumer<StatInfo> statCallback() {
  5. // return new StatInfoLogger(false);
  6. ... // 实现自己的logger
  7. }
  8. };
  9. }

JetCachestatIntervalMinutes指定的周期,定期调用statCallback返回着这个Consumer,传入的StatInfo是已经统计好的数据。这个方法默认的实现是:

returnnew StatInfoLogger(false);
  
  

StatInfoLogger的构造参数设置为true会有更详细的统计信息,包括put等操作的统计。StatInfoLogger输出的是给人读的信息,你也可以自定义logger将日志输出成特定格式,然后通过日志系统统一收集和统计。

如果想要让jetcache的日志输出到独立的文件中,在使用logback的情况下可以这样配置:


  
  
  1. <appender name="JETCACHE_LOGFILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  2. <file>jetcache.log </file>
  3. <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  4. <fileNamePattern>jetcache.log.%d{yyyy-MM-dd} </fileNamePattern>
  5. <maxHistory>30 </maxHistory>
  6. </rollingPolicy>
  7. <encoder>
  8. <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n </pattern>
  9. </encoder>
  10. </appender>
  11. <logger name="com.alicp.jetcache" level="INFO" additivity="false">
  12. <appender-ref ref="JETCACHE_LOGFILE" />
  13. </logger>

Builder:未使用Spring4(或者spring)的时候,通过Builder手工构造Cache

JetCache2版本的@Cached@CreateCache等注解都是基于Spring4.X版本实现的,在没有Spring支持的情况下,注解将不能使用。但是可以直接使用JetCacheAPI来创建、管理、监控Cache,多级缓存也可以使用。

创建缓存

创建缓存的操作类似guava/caffeinecache,例如下面的代码创建基于内存的LinkedHashMapCache


  
  
  1. Cache<String, Integer> cache = LinkedHashMapCacheBuilder.createLinkedHashMapCacheBuilder()
  2. .limit( 100)
  3. .expireAfterWrite( 200, TimeUnit.SECONDS)
  4. .buildCache();

创建RedisCache


  
  
  1. GenericObjectPoolConfig pc = new GenericObjectPoolConfig();
  2. pc.setMinIdle( 2);
  3. pc.setMaxIdle( 10);
  4. pc.setMaxTotal( 10);
  5. JedisPool pool = new JedisPool(pc, "localhost", 6379);
  6. Cache<Long, OrderDO> orderCache = RedisCacheBuilder.createRedisCacheBuilder()
  7. .keyConvertor(FastjsonKeyConvertor.INSTANCE)
  8. .valueEncoder(JavaValueEncoder.INSTANCE)
  9. .valueDecoder(JavaValueDecoder.INSTANCE)
  10. .jedisPool(pool)
  11. .keyPrefix( "orderCache")
  12. .expireAfterWrite( 200, TimeUnit.SECONDS)
  13. .buildCache();

多级缓存

2.2以后通过下面的方式创建多级缓存:


  
  
  1. Cache multiLevelCache = MultiLevelCacheBuilder.createMultiLevelCacheBuilder()
  2. .addCache(memoryCache, redisCache)
  3. .expireAfterWrite( 100, TimeUnit.SECONDS)
  4. .buildCache();

实际上,使用MultiLevelCache可以创建多级缓存,它的构造函数接收的是一个Cache数组(可变参数)。

如果是2.2之前的版本:


  
  
  1. Cache memoryCache = ...
  2. Cache redisCache = ...
  3. Cache multiLevelCache = new MultiLevelCache(memoryCache, redisCache);

监控统计

如果要对Cache进行监控统计:


  
  
  1. Cache orderCache = ...
  2. CacheMonitor orderCacheMonitor = new DefaultCacheMonitor( "OrderCache");
  3. orderCache.config().getMonitors().add(orderCacheMonitor); // jetcache 2.2+, or call builder.addMonitor() before buildCache()
  4. // Cache<Long, Order> monitedOrderCache = new MonitoredCache(orderCache, orderCacheMonitor); //before jetcache 2.2
  5. int resetTime = 1;
  6. boolean verboseLog = false;
  7. DefaultCacheMonitorManager cacheMonitorManager = new DefaultCacheMonitorManager(resetTime, TimeUnit.SECONDS, verboseLog);
  8. cacheMonitorManager.add(orderCacheMonitor);
  9. cacheMonitorManager.start();

首先创建一个CacheMonitor,每个DefaultCacheMonitor只能用于一个Cache。当DefaultCacheMonitorManager启动以后,会使用slf4j按指定的时间定期输出统计信息到日志中(简版输出格式参见统计),DefaultCacheMonitor构造时指定的名字会作为输出时cache的名字。

在组装多级缓存的过程中,可以给每个缓存安装一个Monitor,这样可以监控每一级的命中情况。

也可以自己对统计信息进行处理,调用下面的构造方法创建DefaultCacheMonitorManager

public DefaultCacheMonitorManager(int resetTime, TimeUnit resetTimeUnit, Consumer<StatInfo> stat
  
  

开发者文档

clone下来以后,可以按maven项目导入ideaeclipse

跑通单元测试,需要在本地运行redis,先安装docker,然后用下面的命令运行redis-sentinel

docker run --rm -it -p 6379-6381:6379-6381 -p 26379-26381:26379-26381 areyouok/redis-sentinel
  
  

接下来mvn cleantest可以跑通所有测试,如果在IDE里面,可能还需要给javac设置-parameters参数。需要注意的是机器繁忙时单元测试有可能会失败,因为很多单元测试使用了sleep,为了不让单元测试运行的时间过长,sleep的时间都设置的比较短,这样机器卡顿时可能导致检查失败,不过对于正常机器这并不经常发生。

使用snapshot版本,在自己的pom里面加上:


  
  
  1. <repositories>
  2. <repository>
  3. <id>sonatype-nexus-snapshots </id>
  4. <name>Sonatype Nexus Snapshots </name>
  5. <url>https://oss.sonatype.org/content/repositories/snapshots </url>
  6. <releases>
  7. <enabled>false </enabled>
  8. </releases>
  9. <snapshots>
  10. <enabled>true </enabled>
  11. </snapshots>
  12. </repository>
  13. </repositories>

升级和兼容性指南

2.5.0

  • 从2.3.3及更低版本升级到2.5.0会发生ClassCastException(如果你使用了MultiLevelCache或者cacheType.CacheType.BOTH)。 解决办法是先升级到2.4.4并且发布到生产环境,然后再升级到2.5.0。
  • 子类的注解会覆盖接口和父类。

猜你喜欢

转载自blog.csdn.net/xiaoanzi123/article/details/106786727
今日推荐