12-SpringCache常用注解介绍+框架案例实战

上一章介绍了什么是Mybatis-plus和SpringCache,并使用SpringBoot对这两个进行了整合,整合完成后编写CRUD接口进行测试,算是初步对Mybatis-plus初步了解,下面我们在了解一下SpringCache。

在本章我们会学习到SpringCache的常用注解,介绍注解的属性和使用方法。

SpringCache常用注解详解

在SpringBoot中也有许多的注解,每个注解都有不一样的功能,在SpringCache也是如此,下面重点了解一下几个常用的注解。

@Cacheable注解在方法上,表示被注解的该方法的返回结果是可以缓存的。也就是说添加该注解在方法上后,该方法的返回结果会存放到缓存当中,以便以后使用相同的参数调用该方法的时候,会返回缓存中的值,而不需要实际的该方法。

@Cacheable注解的属性:

(1)value:缓存名称(可以有多个)

(2)key:缓存key规则,可以使用SpringEL表达式

(3)condition:SpringEL表达式,结果为true,缓存数据到redis。结果为false,不缓存数据到redis.

//对象

@Cacheable(value = {"product"},key="#root.methodName")

//分⻚使用拼接方式

@Cacheable(value ={"product_page"},key="#root.methodName + #page+'_'+#size")

SpringCache框架自定义CacheManager配置和过期时间

当方法中的数据缓存到Redis中时,不可能让数据永久存在这是不现实的,所以我们可以配置缓存的过期时间。下面配置了好几种过期时间分别有1小时与1天,instanceConfig方法是接收传递过来的过期时间配置过期时间。当有方法要使用缓存的过期方法时,在@Cacheable注解体中添加cacheManager="方法名"即可,@Primary是使用默认的过期方法。

@Bean

    @Primary

    public RedisCacheManager cacheManager1Hour(RedisConnectionFactory connectionFactory) {

        RedisCacheConfiguration config = instanceConfig(3600L);

        return RedisCacheManager.builder(connectionFactory)

                        .cacheDefaults(config)

                        .transactionAware()

                        .build();

    }

    @Bean

    public RedisCacheManager cacheManager1Day(RedisConnectionFactory connectionFactory) {

        RedisCacheConfiguration config = instanceConfig(3600 * 24L);

        return RedisCacheManager.builder(connectionFactory)

                        .cacheDefaults(config)

                        .transactionAware()

                        .build();

    }

    private RedisCacheConfiguration instanceConfig(Long ttl) {

        Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<>(Object.class);

        ObjectMapper objectMapper = new ObjectMapper();

        objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);

        objectMapper.registerModule(new JavaTimeModule());

        // 去掉各种@JsonSerialize注解的解析

        objectMapper.configure(MapperFeature.USE_ANNOTATIONS, false);

        // 只针对⾮空的值进⾏序列化

        objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

        // 将类型序列化到属性json字符串中

        objectMapper.activateDefaultTyping(LaissezFaireSubTypeValidator.instance ,

                ObjectMapper.DefaultTyping.NON_FINAL,

                JsonTypeInfo.As.PROPERTY);

        jackson2JsonRedisSerializer.setObjectMapper(objectMapper);

        return RedisCacheConfiguration.defaultCacheConfig()

                        .entryTtl(Duration.ofSeconds(ttl))

                        .disableCachingNullValues()

                        .serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(jackson2JsonRedisSerializer));

    }

SpringCache框架自定义缓存KeyGenerator

一般在团队中为了开发方便与规范,通常会自定义个缓存key作为区分起来方便维护管理。使用方法也很简单,在@Cacheable注解体中,添加keyGenerator="方法名",注意keyGenerator和key不能同时存在。

@Bean

public KeyGenerator

springCacheDefaultKeyGenerator(){

return new KeyGenerator() {

@Override

public Object generate(Object o,Method method, Object... objects) {

return o.getClass().getSimpleName() + "_"+ method.getName() +"_"+ StringUtils.arrayToDelimitedString(objects,"_");

}

};

}

SpringCache框架@CachePut实战

@CachePut注解应用在写数据的方法上,比如:新增/修改方法,调用时会自动把相应的数据放入到缓存中,该注解的参数与@Cacheable注解类似

上面有说@CachePut注解是用于更新操作的,使用方法跟@Cacheble类似的,使用案例如下所示:

@CachePut(value = {"product"},key ="#productDO.id")

SpringCache框架@CacheEvict实战

@CacheEvict注解应用在移除数据的方法上,比如:删除方法,调用方法时会从缓存中移除相应的数据

注意:该注解的beforelnvocation=true/false,表示缓存的清除是否是在方法前执行,默认代表缓存清除操作是在方法执行之后执行,如果出现异常的话就不会清除。

@CacheEvict(value = {"product"},key ="#root.args[0]")

SpringCache框架@Caching实战

@Caching注解支持多个注解,有的时候在操作一个方法的时候会涉及到多个注解的使用,这时@Caching注解就起到了作用。

@Caching(

cacheable = {@Cacheable(value ="product",keyGenerator = "xdclassKeyGenerator")},

put = {@CachePut(value ="product",key = "#id"),

@CachePut(value ="product",key = "'stock:'+#id")

}

)

本章小结:通过本章能够较为清晰的认识到SpringCache注解的使用场景与使用方法,在方法中返回数据就存到缓存中,对项目的调优具有举足轻重的作用。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,928评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,192评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,468评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,186评论 1 286
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,295评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,374评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,403评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,186评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,610评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,906评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,075评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,755评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,393评论 3 320
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,079评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,313评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,934评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,963评论 2 351

推荐阅读更多精彩内容