Springboot集成redis (使用注解)

本文涉及的产品
Redis 开源版,标准版 2GB
推荐场景:
搭建游戏排行榜
简介: Springboot集成redis (使用注解),在一定程度上能够方便开发

springboot集成redis (使用注解)

注意:一般开发中小型快速应用,适合redis注解开发。但是想要合理点的设置缓存,建议还是手动配置

为什么要使用注解版?

  1. 注解版使用方便
  2. 注解版功能多样化,适合多种环境

哪种不适合缓存

  1. insert插入数据库后,返回一个int值,这个值有必要缓存???

    没必要。因为一般情况下我不会从缓存中取出int值,例如我插入了一个数据,缓存一个int值,在再插入一个数据,这种缓存一般不会被使用。

    而且插入一条数据后,就应该让该命名空间下的所有key全部移除,所以一般写的是@CacheEvict(value allEntries=true)

  • @EnableCache 开启基于注解的缓存功能
  • @Cacheable注解 :先从redis数据库中 按照当前key查找,有没有。如果redis中有,是不会走当前该方法的,如果没有再调用方法返回结果,如果结果不为null将其缓存到数据库中(一般用于find)

    • 属性:
    • value:key的一部分(前缀),主要是指明数据放在那个key范围
    • key:key的主体,#p0:指明取出第一个参数 #p1:指明取出第二个参数。。。依此类推
    • unless:结果为true,将当前的数据结果不保存到redis,#result:指明取出数据库中返回的结果
    • condition 结果如果为true,将当前数据保存到redis
    • 实例

      @Cacheable(value = RedisConfig.REDIS_DATABASE_KEY, key = "'user-'+#p0",  unless = "#result==null")
          @Override
          public User getUserByName(String name) {
              UserExample example = new UserExample();
              example.createCriteria().andNameEqualTo(name);
              List<User> users = userMapper.selectByExample(example);
              if(users.size()==0){
                  return null;
              }
              return users.get(0);
          }
  • @CachePut: 主要用于向数据库中插入数据,向数据中插入数据的时候,会将返回的int类型,放入redis中缓存,当然是有选择性的(一般用于insert)
  • 属性:
  • value:key的一部分,命名空间
  • key:指定key的名称
  • unless:满足条件,则不将返回的结果放入redis
  • condition: 满足条件,则将返回的结果放入redis
  • 实例

    @CachePut(value = RedisConfig.REDIS_DATABASE_KEY,key = "'user-insert-'+#p0.id",unless = "#result==0")
        @Override
        public int insert(User record) {
            return userMapper.insert(record);
        }
  • @CacheEvict:满足条件则移除当前key在redis中的数据(一般用于update/delete)

    • 属性:
    • value: 同理命名空间
    • key: key名称
    • condition:满足什么条件从缓存中移除指定的key
    • AllEntries:true/false 是否移除命名空间下的所有key
    • 实例

      @CacheEvict(value = RedisConfig.REDIS_DATABASE_KEY,key = "'user-'+#p0.id",condition = "#result==1")
          @Override
          public int updateByPrimaryKey(User record) {
              return userMapper.updateByPrimaryKey(record);
          }
  • 问题

    我们知道如果进行查询的时候,会将数据缓存到redis中。一旦进行增删改,那么原本数据库中的数据可能会发生变化,那么增删改成功后,应该要指定的移除指定key的缓存。但是我们通过@CaheEvict移除指定key的数据,发现并不能行的通。

    为什么?

    例如:我们修改了一个product信息,那么应该移除product-id 这种key的数据,但是如果这个product数据关联,product-list等等这种key(即list中有当前修改前的数据),按理说我们应该移除这些相关联的key

    怎么做

    1. 第一种方法

      @CaheEvict(value=“nameSpace”,allEntries=true),移除这个命名空间下的所有数据

      @CaheEvict(value=“product”,allEntries=true),移除product命名空间下的所有keys

    2. 第二种

      通过redisTemplate手动移除相关联的key的数据(相对来说麻烦点)

  • 完整配置

    1. pom.xml

      <!--springboot中的redis依赖-->
      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-data-redis</artifactId>
      </dependency>
      <!-- lettuce pool 缓存连接池-->
      <dependency>
          <groupId>org.apache.commons</groupId>
          <artifactId>commons-pool2</artifactId>
      </dependency>
    2. redisConfig

      //开启基于注解的配置
      @EnableCaching
      @Configuration
      public class RedisConfig {
      
          /**
           * redis数据库自定义key的命名空间
           */
          public static final String REDIS_DATABASE_KEY="tmall_springboot";
          public static final String REDIS_CATEGORY_KEY="category";
          public static final String REDIS_ORDER_ITEM_KEY="orderItem";
          public static final String REDIS_ORDER_KEY="order";
          public static final String REDIS_PRODUCT_KEY="product";
          public static final String REDIS_PROPERTY_KEY="property";
          public static final String REDIS_PROPERTY_VALUE_KEY="propertyValue";
          public static final String REDIS_REVIEW_KEY="review";
          public static final String REDIS_USER_KEY="user";
          public static final String REDIS_PRODUCT_IMAGE_KEY="productImage";
      
      
          /**
           * 自动配置的redisTemplate,存在序列化问题,会导致存入redis数据库中的数据,不容易看清所以需要自己配置
           */
          /**
           * 配置自定义redisTemplate
           * @return
           */
          @Bean
          RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory,RedisSerializer redisSerializer) {
      
              RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
      
              redisTemplate.setConnectionFactory(redisConnectionFactory);
      
              // 设置键(key)的序列化采用StringRedisSerializer。
              redisTemplate.setKeySerializer(new StringRedisSerializer());
              // 设置值(value)的序列化采用Jackson2JsonRedisSerializer。
              redisTemplate.setValueSerializer(redisSerializer);
              //  设置hashKey的序列化
              redisTemplate.setHashKeySerializer(new StringRedisSerializer());
              redisTemplate.setHashValueSerializer(redisSerializer);
              redisTemplate.afterPropertiesSet();
              return redisTemplate;
          }
      
          /**
           * 配置json序列化器(我们使用jackson的序列化器)
           */
          @Bean
          public RedisSerializer redisSerializer(){
      
              Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
              ObjectMapper objectMapper = new ObjectMapper();
              objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
              objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
              jackson2JsonRedisSerializer.setObjectMapper(objectMapper);
      
              return jackson2JsonRedisSerializer;
          }
      
          /**
           * 配置redis缓存管理器,管理注解版的缓存
           */
          @Bean
          public RedisCacheManager redisCacheManager(RedisConnectionFactory redisConnectionFactory,RedisSerializer redisSerializer) {
              RedisCacheWriter redisCacheWriter = RedisCacheWriter.nonLockingRedisCacheWriter(redisConnectionFactory);
              //设置Redis缓存有效期为10分钟
              RedisCacheConfiguration redisCacheConfiguration = RedisCacheConfiguration.defaultCacheConfig()
                      .serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(redisSerializer))
                      //ttl
                      .entryTtl(Duration.ofHours(2));
              return new RedisCacheManager(redisCacheWriter, redisCacheConfiguration);
          }
      
      }
    3. application.yml

      # 配置redis
        redis:
          host: 115.29.111.155
          port: 6379
          database: 0       #默认使用0号数据库
          timeout: 2000     #设置连接超时时间
          lettuce:
            pool:
              max-idle: 10
    4. service层

      @Service
      public class UserServiceImpl implements UserService {
      
          @Autowired
          private UserMapper userMapper;
      
          @CacheEvict(value = RedisConfig.REDIS_USER_KEY,allEntries = true,condition = "#result==1")
          @Override
          public int deleteByPrimaryKey(Integer id) {
              return userMapper.deleteByPrimaryKey(id);
          }
      
          /**
           * @CachePut: 主要用户向数据库中插入数据,向数据中插入数据的时候,会将返回的int类型,放入redis中缓存,当然是有选择性的
           *      属性:
           *      value:key的一部分,命名空间
           *      key:指定key的名称
           *      unless:满足条件,则不将返回的结果放入redis
           *      condition: 满足条件,则将返回的结果放入redis
           */
      //    @CachePut(value = RedisConfig.REDIS_USER_KEY,key = "'insert-'+#p0.id",unless = "#result==0")
          @CacheEvict(value = RedisConfig.REDIS_USER_KEY,allEntries = true,condition = "#result==1")
          @Override
          public int insert(User record) {
              return userMapper.insert(record);
          }
      
      //    @CachePut(value = RedisConfig.REDIS_USER_KEY,key = "'insert-'+#p0.id",unless = "#result==0")
          @CacheEvict(value = RedisConfig.REDIS_USER_KEY,allEntries = true,condition = "#result==1")
          @Override
          public int insertSelective(User record) {
              return userMapper.insertSelective(record);
          }
      
          @Cacheable(value = RedisConfig.REDIS_USER_KEY,key = "'list'",unless = "#result==null")
          @Override
          public List<User> selectByExample() {
              UserExample example = new UserExample();
              example.setOrderByClause("id desc");
              List<User> users = userMapper.selectByExample(example);
              return users;
          }
      
          /**
           *   查找数据库是否存在与该名称相同的用户,如果存在true else false
           *
           *  我们这样规定,对于key而言,返回boolean的加一级 exist
           *
           */
          @Cacheable(value = RedisConfig.REDIS_USER_KEY , key = "'exist-'+#p0")
          @Override
          public boolean findUserByName(String name) {
              UserExample example = new UserExample();
              example.createCriteria().andNameEqualTo(name);
              List<User> users = userMapper.selectByExample(example);
              if(users.size()==0){
                  return false;
              }
              return true;
          }
      
          /**
           * 通过username获取用户,username是唯一的
           * redis中使用缓存缓存数据。
           *
           * @Cacheable 开启基于注解的缓存功能
           *
           * @Cacheable注解 :先从redis数据库中 按照当前key查找,有没有。如果没有再调用方法返回结果,如果结果不为null将其缓存到数据库中
           *      属性:
           *      value:key的一部分(前缀),主要是指明数据放在那个key范围
           *      key:key的主体,#p0:指明取出第一个参数  #p1:指明取出第二个参数。。。依此类推
           *      unless:结果为true,将当前的数据结果不保存到redis,#result:指明取出数据库中返回的结果
           *      condition 结果如果为true,将当前数据保存到redis
           *  此为生成的key,中文再redis中显示是这样的
           * "tmall_springboot::user-\xe5\xbc\xa0\xe4\xb8\x89"
           */
          @Cacheable(value = RedisConfig.REDIS_USER_KEY, key = "'one-name-'+#p0",  unless = "#result==null")
          @Override
          public User getUserByName(String name) {
      //        System.out.println("走该方法,数据应该缓冲");
              UserExample example = new UserExample();
              example.createCriteria().andNameEqualTo(name);
              List<User> users = userMapper.selectByExample(example);
              if(users.size()==0){
                  return null;
              }
              return users.get(0);
          }
      
          /**
           *   通过userName,password,查询是否有此用户
           */
          @Cacheable(value = RedisConfig.REDIS_USER_KEY,key = "'one-'+#p0.id",unless = "#result==null")
          @Override
          public User findOneByNameAndPassword(User user){
              UserExample example = new UserExample();
              example.createCriteria().andNameEqualTo(user.getName()).andPasswordEqualTo(user.getPassword());
              List<User> users = userMapper.selectByExample(example);
              if(users.size()==1){
                  return users.get(0);
              }
              return null;
          }
      
      
          @Cacheable(value = RedisConfig.REDIS_USER_KEY , key = "'one-'+#p0",unless = "#result==null")
          @Override
          public User selectByPrimaryKey(Integer id) {
              return userMapper.selectByPrimaryKey(id);
          }
      
          /**
           * @CacheEvict:满足条件则移除当前key在redis中的数据
           *      属性:
           *      value: 同理命名空间
           *      key: key名称
           *      condition:满足什么条件缓存到redis中
           *      allEntries: 移除value(命名空间)下,全部缓存
           */
          @CacheEvict(value = RedisConfig.REDIS_USER_KEY,allEntries = true,condition = "#result==1")
          @Override
          public int updateByPrimaryKeySelective(User record) {
              return userMapper.updateByPrimaryKeySelective(record);
          }
      
          @CacheEvict(value = RedisConfig.REDIS_USER_KEY,allEntries = true,condition = "#result==1")
          @Override
          public int updateByPrimaryKey(User record) {
              return userMapper.updateByPrimaryKey(record);
          }
      }
相关文章
|
2月前
|
缓存 监控 Java
SpringBoot @Scheduled 注解详解
使用`@Scheduled`注解实现方法周期性执行,支持固定间隔、延迟或Cron表达式触发,基于Spring Task,适用于日志清理、数据同步等定时任务场景。需启用`@EnableScheduling`,注意线程阻塞与分布式重复问题,推荐结合`@Async`异步处理,提升任务调度效率。
513 128
|
2月前
|
XML 安全 Java
使用 Spring 的 @Aspect 和 @Pointcut 注解简化面向方面的编程 (AOP)
面向方面编程(AOP)通过分离横切关注点,如日志、安全和事务,提升代码模块化与可维护性。Spring 提供了对 AOP 的强大支持,核心注解 `@Aspect` 和 `@Pointcut` 使得定义切面与切入点变得简洁直观。`@Aspect` 标记切面类,集中处理通用逻辑;`@Pointcut` 则通过表达式定义通知的应用位置,提高代码可读性与复用性。二者结合,使开发者能清晰划分业务逻辑与辅助功能,简化维护并提升系统灵活性。Spring AOP 借助代理机制实现运行时织入,与 Spring 容器无缝集成,支持依赖注入与声明式配置,是构建清晰、高内聚应用的理想选择。
407 0
|
2月前
|
Java 测试技术 API
将 Spring 的 @Embedded 和 @Embeddable 注解与 JPA 结合使用的指南
Spring的@Embedded和@Embeddable注解简化了JPA中复杂对象的管理,允许将对象直接嵌入实体,减少冗余表与连接操作,提升数据库设计效率。本文详解其用法、优势及适用场景。
291 126
|
3月前
|
XML JSON Java
Spring框架中常见注解的使用规则与最佳实践
本文介绍了Spring框架中常见注解的使用规则与最佳实践,重点对比了URL参数与表单参数的区别,并详细说明了@RequestParam、@PathVariable、@RequestBody等注解的应用场景。同时通过表格和案例分析,帮助开发者正确选择参数绑定方式,避免常见误区,提升代码的可读性与安全性。
|
1月前
|
NoSQL Java 网络安全
SpringBoot启动时连接Redis报错:ERR This instance has cluster support disabled - 如何解决?
通过以上步骤一般可以解决由于配置不匹配造成的连接错误。在调试问题时,一定要确保服务端和客户端的Redis配置保持同步一致。这能够确保SpringBoot应用顺利连接到正确配置的Redis服务,无论是单机模式还是集群模式。
198 5
|
1月前
|
XML Java 应用服务中间件
【SpringBoot(一)】Spring的认知、容器功能讲解与自动装配原理的入门,带你熟悉Springboot中基本的注解使用
SpringBoot专栏开篇第一章,讲述认识SpringBoot、Bean容器功能的讲解、自动装配原理的入门,还有其他常用的Springboot注解!如果想要了解SpringBoot,那么就进来看看吧!
358 2
|
2月前
|
XML Java 数据格式
常用SpringBoot注解汇总与用法说明
这些注解的使用和组合是Spring Boot快速开发和微服务实现的基础,通过它们,可以有效地指导Spring容器进行类发现、自动装配、配置、代理和管理等核心功能。开发者应当根据项目实际需求,运用这些注解来优化代码结构和服务逻辑。
288 12
|
2月前
|
Java 测试技术 数据库
使用Spring的@Retryable注解进行自动重试
在现代软件开发中,容错性和弹性至关重要。Spring框架提供的`@Retryable`注解为处理瞬时故障提供了一种声明式、可配置的重试机制,使开发者能够以简洁的方式增强应用的自我恢复能力。本文深入解析了`@Retryable`的使用方法及其参数配置,并结合`@Recover`实现失败回退策略,帮助构建更健壮、可靠的应用程序。
340 1
使用Spring的@Retryable注解进行自动重试