2. Spring-boot 整合缓存服务之Redis 注解方式使用

最新推荐文章于 2023-08-11 09:42:09 发布
最新推荐文章于 2023-08-11 09:42:09 发布
阅读量375 收藏 4
点赞数 1
分类专栏： spring boot redis 文章标签： java spring redis spring boot
本文链接：https://blog.youkuaiyun.com/peishaokai/article/details/115090971
版权
本文详细介绍了Spring Boot如何使用注解整合Redis缓存服务，包括@Cacheable、@CachePut、@CacheEvict和@CacheConfig的参数及使用示例，帮助开发者理解并掌握Spring Boot缓存管理。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

目录

简介

注解

@Cacheable

注解参数

代码案例

@CachePut

注解参数

代码案例

@CacheEvict

注解参数

代码案例

@Cacheing

注解参数

代码案例

@CacheConfig

使用自定义注解

创建自定义注解

使用

参考博客

简介

spring boot 整合缓存服务redis 注解方式使用。整合服务请参考上篇文章Spring-boot 整合缓存服务之Redis简单集成。

注解

@Cacheable

读取缓存数据，无数据则会更新缓存中数据。配置在方法或类上。作用：本方法执行后，先去缓存看有没有数据，如果没有，从数据库中查找出来，给缓存中存一份，返回结果会将方法的返回值作为value进行缓存，下次本方法执行，在缓存未过期情况下，先在缓存中查找，有的话直接返回，没有的话从数据库查找

注解参数

参数类型解释样例
valueString[]缓存位置名称(可以认为其为组的概念）@Cacheable(value = "CREATE_NUMBER_RECORDING", key = "#infoDate",unless="#result == null")
cacheNamesString[]同上方value同理（具体使用请参考@CacheConfig）@Cacheable(cacheNames= "CREATE_NUMBER_RECORDING", key = "#infoDate",unless="#result == null")
keyString缓存键，可使用“：”分割，分割后为组的概念，#后为方法上的参数名称，如果参数为对象，则#对象.get对应的属性值@Cacheable(value = "CREATE_NUMBER_RECORDING", key = "#infoDate+':'+#companyId+':'+#type+':'+#param1")
keyGeneratorString自定义生成key方式，与key()不可以共用。其值为spring注入的类，其类实现implements KeyGenerator 接口@Cacheable(cacheNames = "ids_cache",keyGenerator = "setKeyGrenerator")
cacheManagerString----
cacheResolverString----
conditionString使用SpEL表达式设定出发缓存的条件，在方法执行前生效 
unlessString使用SpEL设置出发缓存的条件，方法执行完生效，所以条件中可以有方法执行后的value。函数返回值符合条件的排除掉、只缓存其余不符合条件的@Cacheable(unless="#result == null") 排除值为null  的情况
syncboolean是否同步，默认false 

代码案例

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.zbintel.mom.factory.dao.NumberCreateDao;
import com.zbintel.mom.factory.entity.NumberCreateEntity;
import com.zbintel.mom.factory.service.NumberCreateCacheService;
import org.springframework.cache.annotation.CachePut;
import org.springframework.cache.annotation.Cacheable;
import org.springframework.stereotype.Service;


@Service("numberCreateCacheService")
public class NumberCreateCacheServiceImpl extends ServiceImpl<NumberCreateDao, NumberCreateEntity>  implements NumberCreateCacheService {


    /**
     * 设置其 value : CREATE_NUMBER_RECORDING  (组的概念)
     *       key : infoDate:companyId:type  (获取请求参数中的对应值， ： 号分割后给其进行组分割)
     *       unless : 排除result 为 null的情况
     * @param companyId
     * @param type
     * @param infoDate
     * @return
     */
    @Cacheable(value = "CREATE_NUMBER_RECORDING", key = "#infoDate+':'+#companyId+':'+#type+':'+#param1",unless="#result == null")
    public NumberCreateEntity queryCache(String companyId,String type, String param1, String infoDate) {

        QueryWrapper<NumberCreateEntity> queryWrapper = new QueryWrapper<>();
        queryWrapper.lambda().eq(NumberCreateEntity::getType,type).eq(NumberCreateEntity::getInfoDate,infoDate)
                .eq(NumberCreateEntity::getCompanyId,companyId).eq(NumberCreateEntity::getParam1,param1);

        return baseMapper.selectOne(queryWrapper);
    }
}

 

redis 中数据保存结果
 

@CachePut

更新缓存中的值。配置到方法上。 类似于更新操作，即每次不管缓存中有没有结果，都从数据库查找结果，并将结果更新到缓存，并返回结果。

注解参数

参数类型解释样例
valueString[]缓存位置名称(可以认为其为组的概念）@Cacheable(value = "CREATE_NUMBER_RECORDING", key = "#infoDate",unless="#result == null")
cacheNamesString[]同上方value同理（具体使用请参考@CacheConfig）@Cacheable(cacheNames= "CREATE_NUMBER_RECORDING", key = "#infoDate",unless="#result == null")
keyString缓存键，可使用“：”分割，分割后为组的概念，#后为方法上的参数名称，如果参数为对象，则#对象.get对应的属性值@Cacheable(value = "CREATE_NUMBER_RECORDING", key = "#infoDate+':'+#companyId+':'+#type+':'+#param1")
keyGeneratorString自定义生成key方式，与key()不可以共用。其值为spring注入的类，其类实现implements KeyGenerator 接口@Cacheable(cacheNames = "ids_cache",keyGenerator = "setKeyGrenerator")
cacheManagerString----
cacheResolverString----
conditionString使用SpEL表达式设定出发缓存的条件，在方法执行前生效 
unlessString使用SpEL设置出发缓存的条件，方法执行完生效，所以条件中可以有方法执行后的value。函数返回值符合条件的排除掉、只缓存其余不符合条件的@Cacheable(unless="#result == null") 排除值为null  的情况

代码案例

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.zbintel.mom.factory.dao.NumberCreateDao;
import com.zbintel.mom.factory.entity.NumberCreateEntity;
import com.zbintel.mom.factory.service.NumberCreateCacheService;
import org.springframework.cache.annotation.CachePut;
import org.springframework.cache.annotation.Cacheable;
import org.springframework.stereotype.Service;


@Service("numberCreateCacheService")
public class NumberCreateCacheServiceImpl extends ServiceImpl<NumberCreateDao, NumberCreateEntity>  implements NumberCreateCacheService {

    /**
     * 设置其 value : CREATE_NUMBER_RECORDING  (组的概念)
     *       key : infoDate:companyId:type  (获取请求参数中的对应值， ： 号分割后给其进行组分割)
     * @return
     */
    @CachePut(value = "CREATE_NUMBER_RECORDING", key = "#entity.getInfoDate()+':'+#entity.getCompanyId()+':'+#entity.getType()")
    public NumberCreateEntity saveOrUpdateCaCheParamIsNull(NumberCreateEntity entity){
        saveOrUpdate(entity);
        return entity;
    }
}
redis 中数据保存结果
 

@CacheEvict

删除缓存数据，配置到方法上。用来清除用在本方法或者类上的缓存数据。

注解参数

参数类型解释样例
valueString[]缓存位置名称(可以认为其为组的概念）@Cacheable(value = "CREATE_NUMBER_RECORDING", key = "#infoDate")
cacheNamesString[]同上方value同理（具体使用请参考@CacheConfig）@Cacheable(cacheNames= "CREATE_NUMBER_RECORDING", key = "#infoDate")
keyString缓存键，可使用“：”分割，分割后为组的概念，#后为方法上的参数名称，如果参数为对象，则#对象.get对应的属性值@Cacheable(value = "CREATE_NUMBER_RECORDING", key = "#infoDate+':'+#companyId+':'+#type+':'+#param1")
keyGeneratorString自定义生成key方式，与key()不可以共用。其值为spring注入的类，其类实现implements KeyGenerator 接口@Cacheable(cacheNames = "ids_cache",keyGenerator = "setKeyGrenerator")
cacheManagerString----
cacheResolverString----
conditionString使用SpEL表达式设定出发缓存的条件，在方法执行前生效 
allEntriesbooleanallEntries是boolean类型，表示是否需要清除缓存中的所有元素。默认为false，表示不需要。当指定了allEntries为true时，Spring Cache将忽略指定的key。有的时候我们需要Cache一下清除所有的元素，这比一个一个清除元素更有效率。 
beforeInvocationboolean清除操作默认是在对应方法成功执行之后触发的，即方法如果因为抛出异常而未能成功返回时也不会触发清除操作。使用beforeInvocation可以改变触发清除操作的时间，当我们指定该属性值为true时，Spring会在调用该方法之前清除缓存中的指定元素。 

代码案例

@CacheEvict(value="users", beforeInvocation=true)
   public void delete(Integer id) {
      System.out.println("delete user by id: " + id);
}

@Cacheing

同时指定多个Spring Cache相关的注解,配置到方法或者类上。其拥有三个属性：cacheable、put和evict，分别用于指定@Cacheable、@CachePut和@CacheEvict。

注解参数

参数类型解释样例
cacheableCacheable[]配置多个Cacheable

@Caching(cacheable = @Cacheable("users"), evict = { @CacheEvict("cache2"),@CacheEvict(value = "cache3", allEntries = true) })

putCachePut[]配置多个CachePut@Cacheable(cacheNames= "CREATE_NUMBER_RECORDING", key = "#infoDate",unless="#result == null")
evictCacheEvict[]配置多个CacheEvict@Cacheable(value = "CREATE_NUMBER_RECORDING", key = "#infoDate+':'+#companyId+':'+#type+':'+#param1")

代码案例

 @Caching(cacheable = @Cacheable("users"), evict = { @CacheEvict("cache2"),
   @CacheEvict(value = "cache3", allEntries = true) })
   public User find(Integer id) {
      return null;
}

@CacheConfig

公共配置。配置在类上。cacheNames即定义了本类中所有用到缓存的地方，都去找这个库。只要使用了这个注解，在方法上@Cacheable @CachePut @CacheEvict就可以不用写value去找具体库名了。

注解参数

参数类型解释样例
cacheNamesString[]同上方value同理（具体使用请参考@CacheConfig）@Cacheable(cacheNames= "CREATE_NUMBER_RECORDING", key = "#infoDate",unless="#result == null")
keyGeneratorString自定义生成key方式，与key()不可以共用。其值为spring注入的类，其类实现implements KeyGenerator 接口@Cacheable(cacheNames = "ids_cache",keyGenerator = "setKeyGrenerator")
cacheManagerString----
cacheResolverString----

使用自定义注解

Spring允许我们在配置可缓存的方法时使用自定义的注解，前提是自定义的注解上必须使用对应的注解进行标注。(使用场景：可以配置公共的注解， 进行分组统一管理)

创建自定义注解

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Cacheable(value="selInfo")
public @interface SelCacheable {

}

使用

   @SelCacheable
   public Number findById(String id) {
       Number n = new Number(); 
       return n; 
   }

参考博客

Spring整合Redis注解实现

Spring Boot缓存注解@Cacheable、@CacheEvict、@CachePut使用

 

SpringBoot缓存注解学习笔记之Redis
qq_20954959的博客
01-30 864
之前用SpringBoot+MyBatisPlus+SpringMVC整合搭建了一个基础web开发框架，使用这三个框架搭建出来项目结构非常的清爽，没有过多的配置文件，各个模块之间有清晰的联系，非常适合敏捷开发。 最近学习了Redis这个基于内存的，Key-Value数据形式的高性能数据库，感觉学习了入门之后很简单，没有体会到它具体能干嘛，我就想着使用Redis这个数据库来整合之前搭建的框架
【SpringBoot】整合Redis（使用spring-boot-starter-data-redis）
qq_27579471的博客
08-03 1万+
前言 Jedis是Redis官方推荐的面向Java的操作Redis的客户端，而RedisTemplate是SpringDataRedis中对JedisApi的高度封装。SpringDataRedis相对于Jedis来说可以方便地更换Redis的Java客户端，比Jedis多了自动管理连接池的特性，方便与其他Spring框架进行搭配使用如：SpringCache。 Lettuce 和 Jedis 的都是连接Redis Server的客户端程序。Jedis在实现上是直连redis server，多线程环境下非线
Redis注解的使用方式
热门推荐
宿久
09-17 1万+
这篇文章主要介绍了详解Spring缓存注解@Cacheable,@CachePut , @CacheEvict使用，非常具有实用价值，需要的朋友可以参考下 注释介绍 @Cacheable @Cacheable 的作用 主要针对方法配置，能够根据方法的请求参数对其结果进行缓存 @Cacheable 作用和配置方法   参数 解释 example value 缓存的名称...
Springboot - redis缓存注解
qq_36782325的博客
09-30 821
当数据库中存在大量数据，更新频率低，且查询速度较慢时，应该如何提高查询速度？
Redis 注解使用
诺诺的博客
07-05 1774
1.引入依赖 org.springframework.boot spring-boot-starter-cache 2.启用类上加上注解 @EnableCaching 3.方法上加注解(查询方法) @Cacheable(cacheNames =“product”,key = “#productId”,condition=“true”,unless = “#productId.length() < 10”) public ProductInfo findOne(String prod
redis注解方式使用
最新发布
m0_59562330的博客
08-11 1102
可以减少重复代码，使用注解还有一个好处是可拔插，不适用的时候，直接拿掉注解就可以了，不会影响的业务逻辑，更换使用的缓存方式也是，不需要替换缓存的实现方式，只需要把启用缓存注解的配置放到别的类型的缓存中即可。
spring-boot-redis-annotation-demo:spring boot —— redis 缓存注解使用示例项目
05-01
spring boot —— redis 缓存注解使用教程 示例项目地址： 依赖 在pom文件添加如下依赖 <groupId>org.springframework.boot <artifactId>spring-boot-starter-data-redis 配置 在application.yml配置文件添加...
spring boot 通过 spring-boot-starter-data-redis 整合redis
白桦栎的博客
12-11 1785
redis依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> <version>2.1.6.RELE...
autoload-cache-spring-boot-starter：自动加载缓存spring boot starter
01-30
- 在代码中使用Spring Cache注解，如`@Cacheable`、`@CacheEvict`等来控制缓存的行为。 - 应用启动后，自动加载缓存机制会根据配置自动填充缓存。 8. **最佳实践**: 开发者应理解缓存策略的重要性，例如缓存更新...
spring-boot-redis-guava-caffeine-cache:springboot 使用 redis guava caffeine 缓存示例
05-17
在这个项目中，开发者可能展示了如何在Spring Boot应用中同时使用这三种缓存方式，并比较它们的性能和适用场景。通过`@EnableCaching`注解启用缓存支持，然后可以定义多个`@CacheConfig`注解来区分不同缓存的配置。...
springboot使用redis缓存注解
qq_27700991的博客
05-10 789
Cacheable：将方法的返回值缓存起来，下次调用时直接从缓存中获取，如果缓存中不存在，则执行方法并将返回值缓存起来。@CachePut：将方法的返回值缓存起来，下次调用时直接从缓存中获取，同时更新缓存中的值。以上就是关于springboot下redisCache的使用的详细介绍，希望能对你有所帮助。@CacheEvict：从缓存中删除指定的缓存项。@Caching：可以同时指定多个缓存注解。RedisCacheConfig配置类。一、集成redisCache。
SpringBoot用注解实现redis缓存
weixin_53604412的博客
09-14 544
每次查询都会查询数据库。缓存中有就不查数据库。
springboot搭配redis缓存注解
qq_30177469的博客
12-14 872
启动类+注解 @EnableCaching controller: /** * 缓存测试 * @param baseRequest * @return * @throws BizException */ @PostMapping("/testRedisCache") public BaseResponse testRedisCache(CustomerDeliveryDetailRequest baseRequest) throws BizException { WmsEntityRes.
SpringBoot使用缓存注解操作Redis
学无止境
10-07 2100
目录 配置 具体实现 用户实体类 接口 接口实现类 缓存注解说明 @CachePut @Cacheable @CacheEvict 测试结果 saveUser getUser updateUser removeUser 配置 首先在POM文件中加入Redis相关的依赖 <dependency> <grou...
SpringBoot整合redis作为缓存（注解法）
sinat_40036740的博客
08-19 174
<1>导入jar包 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> <version>1.4.1.RELEASE</version> </dependency> <2>编写redis配置类 /
SpringBoot使用注解方式集成Redis缓存
Jaemon
12-19 496
SpringBoot使用注解方式集成Redis缓存
springboot整合redis 使用缓存注解
lin1214000999的博客
02-08 1802
1.启动类标明@EnableCaching @SpringBootApplication @MapperScan("com.jx.luckyDraw.mapper") @EnableCaching public class LuckyDrawApplication { public static void main(String[] args) { SpringApplication.run(LuckyDrawApplication.class, args); } }
Shiro与Spring Boot 2.x集成Redis注解完整项目实战
本项目“shiro+springboot2.x+redis注解方式完整项目”即是在这一背景下开发的。该项目利用了注解的方式，实现了自定义的Realm，以及整合了Redis作为缓存管理器，同时自定义了sessionId和session，这些都是现代安全...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值