JetCache的配置和注解属性的使用说明_Java

一、配置说明

yml配置文件案例（如果没使用springboot，直接配置globalcacheconfig是类似的，参考快速入门教程）：

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}

配置通用说明如下：

属性	默认值	说明
jetcache.statintervalminutes	0	统计间隔，0表示不统计
jetcache.areaincachename	true	jetcache-anno把cachename作为远程缓存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	无	缓存类型。tair、redis为当前支持的远程缓存；linkedhashmap、caffeine为当前支持的本地缓存类型
jetcache.[local\|remote].${area}.keyconvertor	无	key转换器的全局配置，当前只有一个已经实现的keyconvertor：`fastjson`。仅当使用@createcache且缓存类型为local时可以指定为`none`，此时通过equals方法来识别key。方法缓存必须指定keyconvertor
jetcache.[local\|remote].${area}.valueencoder	java	序列化器的全局配置。仅remote类型的缓存需要指定，可选java和kryo
jetcache.[local\|remote].${area}.valuedecoder	java	序列化器的全局配置。仅remote类型的缓存需要指定，可选java和kryo
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和@createcache的area属性。注意如果注解上没有指定area，默认值是"default"。

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

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

二、注解属性说明

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的缓存刷新时，同时只会有一台服务器在刷新，这台服务器会在远程缓存放置一个分布式锁，此配置指定该锁的超时时间