SpringBoot整合Redis及注解式开发

SpringBoot整合Redis及注解式开发

SpringBoot配置类

注解标签
@Configuration
@Configuration底层是含有@Component ,所以@Configuration 具有和 @Component 的作用。
@Configuration可理解为用spring的时候xml里面的标签。
注:

  1. 配置类必须以类的形式提供(不能是工厂方法返回的实例),允许通过生成子类在运行时增强(cglib 动态代理)。
  2. 配置类不能是 final 类(没法动态代理)。
  3. 配置注解通常为了通过 @Bean 注解生成 Spring 容器管理的类。
  4. 配置类必须是非本地的(即不能在方法中声明,不能是 private)。
  5. 任何嵌套配置类都必须声明为static。
  6. @Bean方法不能创建进一步的配置类(也就是返回的bean如果带有@Configuration,也不会被特殊处理,只会作为普通的 bean)。
    @EnableCaching
  7. @EnableCaching注解是spring framework中的注解驱动的缓存管理功能。自spring版本3.1起加入了该注解。
  8. 如果你使用了这个注解,那么你就不需要在XML文件中配置cache manager了。
  9. 当你在配置类(@Configuration)上使用@EnableCaching注解时,会触发一个post processor,这会扫描每一个spring bean,查看是否已经存在注解对应的缓存。如果找到了,就会自动创建一个代理拦截方法调用,使用缓存的bean执行处理。

@Bean
@Bean可理解为用spring的时候xml里面的标签。
注:

  1. @Bean注解在返回实例的方法上,如果未通过@Bean指定bean的名称,则默认与标注的方法名相同;

  2. @Bean注解默认作用域为单例singleton作用域,可通过@Scope(“prototype”)设置为原型作用域;

  3. 既然@Bean的作用是注册bean对象,那么完全可以使用@Component、@Controller、@Service、@Repository等注解注册bean(在需要注册的类上加注解),当然需要配置@ComponentScan注解进行自动扫描。

实践

导入redis的依赖

<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-data-redis</artifactId>
	</dependency>
	<dependency>
		<groupId>redis.clients</groupId>
		<artifactId>jedis</artifactId>
	</dependency>

配置application.yml

server:
  port: 80
  servlet:
    context-path: /

spring:
  datasource:
    #1.JDBC
    type: com.alibaba.druid.pool.DruidDataSource
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost:3306/liuchunming?useUnicode=true&characterEncoding=UTF-8&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC
    username: root
    password: 123
    druid:
      #2.连接池配置
      #初始化连接池的连接数量 大小,最小,最大
      initial-size: 5
      min-idle: 5
      max-active: 20
      #配置获取连接等待超时的时间
      max-wait: 60000
      #配置间隔多久才进行一次检测,检测需要关闭的空闲连接,单位是毫秒
      time-between-eviction-runs-millis: 60000
      # 配置一个连接在池中最小生存的时间,单位是毫秒
      min-evictable-idle-time-millis: 30000
      validation-query: SELECT 1 FROM DUAL
      test-while-idle: true
      test-on-borrow: true
      test-on-return: false
      # 是否缓存preparedStatement,也就是PSCache  官方建议MySQL下建议关闭   个人建议如果想用SQL防火墙 建议打开
      pool-prepared-statements: true
      max-pool-prepared-statement-per-connection-size: 20
      # 配置监控统计拦截的filters,去掉后监控界面sql无法统计,'wall'用于防火墙
      filter:
        stat:
          merge-sql: true
          slow-sql-millis: 5000
      #3.基础监控配置
      web-stat-filter:
        enabled: true
        url-pattern: /*
        #设置不统计哪些URL
        exclusions: "*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*"
        session-stat-enable: true
        session-stat-max-count: 100
      stat-view-servlet:
        enabled: true
        url-pattern: /druid/*
        reset-enable: true
        #设置监控页面的登录名和密码
        login-username: admin
        login-password: admin
        allow: 127.0.0.1
        #deny: 192.168.1.100
  redis:
    database: 0
    host: 192.168.254.130
    port: 6379
    password: 123456
    jedis:
      pool:
        max-active: 100
        max-idle: 3
        max-wait: -1
        min-idle: 0
    timeout: 1000

#pagehelper分页插件配置
pagehelper:
  helperDialect: mysql
  reasonable: true
  supportMethodsArguments: true
  params: count=countSql

#显示日志
logging:
  level:
    com.liuchunming.springboot02.mapper: debug

在这里插入图片描述

启动一下虚拟机redis库
在这里插入图片描述
在这里插入图片描述
测试连接成功!!

创建RedisConfig

什么叫做配置类呢?
就是被@Configuration注解所标记的类
@Configuration代替了以前的spring.某某xml配置文件的< beans>标签。
写一个配置类也就相当于新建的一个配置文件,只不过配置类比配置文件更加灵活。因为配置文件中不能写if判断这种类似的条件需求

RedisConfig类用于Redis数据缓存。
//继承CachingConfigurerSupport,为了自定义生成KEY的策略。可以不继承。

package com.liuchunming.springboot02.config;

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.cache.CacheManager;
import org.springframework.cache.annotation.CachingConfigurerSupport;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.cache.interceptor.KeyGenerator;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.cache.RedisCacheConfiguration;
import org.springframework.data.redis.cache.RedisCacheManager;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;

import java.lang.reflect.Method;
import java.time.Duration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;


/**
* redis配置类
**/
@Configuration
@EnableCaching//开启注解式缓存
//继承CachingConfigurerSupport,为了自定义生成KEY的策略。可以不继承。
public class RedisConfig extends CachingConfigurerSupport {

   /**
    * 生成key的策略 根据类名+方法名+所有参数的值生成唯一的一个key
    *
    * @return
    */
   @Bean
   @Override
   public KeyGenerator keyGenerator() {
       return new KeyGenerator() {
           @Override
           public Object generate(Object target, Method method, Object... params) {
               StringBuilder sb = new StringBuilder();
               sb.append(target.getClass().getName());
               sb.append(method.getName());
               for (Object obj : params) {
                   sb.append(obj.toString());
               }
               return sb.toString();
           }
       };
   }

   /**
    * 管理缓存
    *
    * @param redisConnectionFactory
    * @return
    */
   @Bean
  public CacheManager cacheManager(RedisConnectionFactory redisConnectionFactory) {
       //通过Spring提供的RedisCacheConfiguration类,构造一个自己的redis配置类,从该配置类中可以设置一些初始化的缓存命名空间
       // 及对应的默认过期时间等属性,再利用RedisCacheManager中的builder.build()的方式生成cacheManager:
       RedisCacheConfiguration config = RedisCacheConfiguration.defaultCacheConfig();  // 生成一个默认配置,通过config对象即可对缓存进行自定义配置
       config = config.entryTtl(Duration.ofMinutes(1))     // 1分钟 设置缓存的默认过期时间,也是使用Duration设置  
               .disableCachingNullValues();     // 不缓存空值

       // 设置一个初始化的缓存空间set集合
       Set<String> cacheNames = new HashSet<>();
       cacheNames.add("my-redis-cache1");
       cacheNames.add("my-redis-cache2");

       // 对每个缓存空间应用不同的配置
       Map<String, RedisCacheConfiguration> configMap = new HashMap<>();
       configMap.put("my-redis-cache1", config);
       configMap.put("my-redis-cache2", config.entryTtl(Duration.ofSeconds(120)));//120秒  定义为两分钟过期

       RedisCacheManager cacheManager = RedisCacheManager.builder(redisConnectionFactory)     // 使用自定义的缓存配置初始化一个cacheManager
               .initialCacheNames(cacheNames)  // 注意这两句的调用顺序,一定要先调用该方法设置初始化的缓存名,再初始化相关的配置
               .withInitialCacheConfigurations(configMap)
               .build();
       return cacheManager;
   }

   @Bean
   public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory connectionFactory) {
       RedisTemplate<Object, Object> template = new RedisTemplate<>();
       template.setConnectionFactory(connectionFactory);

       //使用Jackson2JsonRedisSerializer来序列化和反序列化redis的value值(默认使用JDK的序列化方式)
       Jackson2JsonRedisSerializer serializer = new Jackson2JsonRedisSerializer(Object.class);

       ObjectMapper mapper = new ObjectMapper();
       mapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
       mapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
       serializer.setObjectMapper(mapper);

       template.setValueSerializer(serializer);
       //使用StringRedisSerializer来序列化和反序列化redis的key值
       template.setKeySerializer(new StringRedisSerializer());
       template.afterPropertiesSet();
       return template;
   }

   @Bean
   public StringRedisTemplate stringRedisTemplate(RedisConnectionFactory factory) {
       StringRedisTemplate stringRedisTemplate = new StringRedisTemplate();
       stringRedisTemplate.setConnectionFactory(factory);
       return stringRedisTemplate;
   }

}

在这里插入图片描述
详细针对下面这段代码进行讲解
在这里插入图片描述
在整合ehcache的时候,会有一个配置文件spring-ehcache.xml如下

<!-- 使用ehcache缓存 -->
    <bean id="cacheManagerFactory" class="org.springframework.cache.ehcache.EhCacheManagerFactoryBean">
        <property name="configLocation" value="classpath:ehcache.xml"/>
        <property name="shared" value="true"></property>
    </bean>
    <!-- 默认是cacheManager -->
    <bean id="cacheManager" class="org.springframework.cache.ehcache.EhCacheCacheManager">
        <property name="cacheManager" ref="cacheManagerFactory"/>
    </bean>

ehcache.xml

<!--defaultCache:默认的管理策略-->
    <!--eternal:设定缓存的elements是否永远不过期。如果为true,则缓存的数据始终有效,如果为false那么还要根据timeToIdleSeconds,timeToLiveSeconds判断-->
    <!--maxElementsInMemory:在内存中缓存的element的最大数目-->
    <!--overflowToDisk:如果内存中数据超过内存限制,是否要缓存到磁盘上-->
    <!--diskPersistent:是否在磁盘上持久化。指重启jvm后,数据是否有效。默认为false-->
    <!--timeToIdleSeconds:对象空闲时间(单位:秒),指对象在多长时间没有被访问就会失效。只对eternal为false的有效。默认值0,表示一直可以访问-->
    <!--timeToLiveSeconds:对象存活时间(单位:秒),指对象从创建到失效所需要的时间。只对eternal为false的有效。默认值0,表示一直可以访问-->
    <!--memoryStoreEvictionPolicy:缓存的3 种清空策略-->
    <!--FIFO:first in first out (先进先出)-->
    <!--LFU:Less Frequently Used (最少使用).意思是一直以来最少被使用的。缓存的元素有一个hit 属性,hit 值最小的将会被清出缓存-->
    <!--LRU:Least Recently Used(最近最少使用). (ehcache 默认值).缓存的元素有一个时间戳,当缓存容量满了,而又需要腾出地方来缓存新的元素的时候,那么现有缓存元素中时间戳离当前时间最远的元素将被清出缓存-->
    <defaultCache eternal="false" maxElementsInMemory="1000" overflowToDisk="false" diskPersistent="false"
                  timeToIdleSeconds="0" timeToLiveSeconds="600" memoryStoreEvictionPolicy="LRU"/>
所以截图中代码的意思是:从RedisCacheConfiguration获取一个默认的缓存策略,针对这一策略做对应的调整,生成一个全新的策略。然后,初始化两个缓存槽,赋予名字my-redis-cache1和my-redis-cache2,,赋予再基于之前的缓存策略,初始化两个缓存策略,存储与configMap,然后策略与缓存槽对应上,生成缓存管理器交个spring进行管理,替代掉SSM时代的配置文件

ssm框架中如果整合redis,那么会有个spring-redis.xml配置文件,里面的配置内容如下

<!-- 1. 引入properties配置文件 -->
    <!--<context:property-placeholder location="classpath:redis.properties" />-->

    <!-- 2. redis连接池配置-->
    <bean id="poolConfig" class="redis.clients.jedis.JedisPoolConfig">
        <!--最大空闲数-->
        <property name="maxIdle" value="${redis.maxIdle}"/>
        <!--连接池的最大数据库连接数  -->
        <property name="maxTotal" value="${redis.maxTotal}"/>
        <!--最大建立连接等待时间-->
        <property name="maxWaitMillis" value="${redis.maxWaitMillis}"/>
        <!--逐出连接的最小空闲时间 默认1800000毫秒(30分钟)-->
        <property name="minEvictableIdleTimeMillis" value="${redis.minEvictableIdleTimeMillis}"/>
        <!--每次逐出检查时 逐出的最大数目 如果为负数就是 : 1/abs(n), 默认3-->
        <property name="numTestsPerEvictionRun" value="${redis.numTestsPerEvictionRun}"/>
        <!--逐出扫描的时间间隔(毫秒) 如果为负数,则不运行逐出线程, 默认-1-->
        <property name="timeBetweenEvictionRunsMillis" value="${redis.timeBetweenEvictionRunsMillis}"/>
        <!--是否在从池中取出连接前进行检验,如果检验失败,则从池中去除连接并尝试取出另一个-->
        <property name="testOnBorrow" value="${redis.testOnBorrow}"/>
        <!--在空闲时检查有效性, 默认false  -->
        <property name="testWhileIdle" value="${redis.testWhileIdle}"/>
    </bean>

    <!-- 3. redis连接工厂 -->
    <bean id="connectionFactory" class="org.springframework.data.redis.connection.jedis.JedisConnectionFactory"
          destroy-method="destroy">
        <property name="poolConfig" ref="poolConfig"/>
        <!--IP地址 -->
        <property name="hostName" value="${redis.hostName}"/>
        <!--端口号  -->
        <property name="port" value="${redis.port}"/>
        <!--如果Redis设置有密码  -->
        <property name="password" value="${redis.password}"/>
        <!--客户端超时时间单位是毫秒  -->
        <property name="timeout" value="${redis.timeout}"/>
    </bean>

    <!-- 4. redis操作模板,使用该对象可以操作redis  -->
    <bean id="redisTemplate" class="org.springframework.data.redis.core.RedisTemplate">
        <property name="connectionFactory" ref="connectionFactory"/>
        <!--如果不配置Serializer,那么存储的时候缺省使用String,如果用User类型存储,那么会提示错误User can't cast to String!!  -->
        <property name="keySerializer">
            <bean class="org.springframework.data.redis.serializer.StringRedisSerializer"/>
        </property>
        <property name="valueSerializer">
            <bean class="org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer"/>
        </property>
        <property name="hashKeySerializer">
            <bean class="org.springframework.data.redis.serializer.StringRedisSerializer"/>
        </property>
        <property name="hashValueSerializer">
            <bean class="org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer"/>
        </property>
        <!--开启事务  -->
        <property name="enableTransactionSupport" value="true"/>
    </bean>

    <!-- 5.使用中间类解决RedisCache.RedisTemplate的静态注入,从而使MyBatis实现第三方缓存 -->
    <bean id="redisCacheTransfer" class="com.javaxl.ssm2.util.RedisCacheTransfer">
        <property name="redisTemplate" ref="redisTemplate"/>
    </bean>

其中前面redis链接工厂的创建,已经交于springboot中的application.yml文件来完成。所以,springboot整合redis我们只需要关注下面这部分配置。
在这里插入图片描述

常用缓存注解

@Cacheable:作用是主要针对方法配置,能够根据方法的请求参数对其结果进行缓存
主要参数说明:

  1. value :
    缓存的名称,在 spring 配置文件中定义,必须指定至少一个,
    例如:@Cacheable(value=”mycache”) 或者 @Cacheable(value={”cache1”,”cache2”}。
  2. key :缓存的 key,可以为空,
    如果指定要按照 SpEL 表达式编写,如果不指定,则缺省按照方法的所有参数进行组合,
    例如:@Cacheable(value=”testcache”,key=”#userName”)。
  3. condition :缓存的条件,可以为空,

案例测试

service层

package com.liuchunming.springboot02.service;

import com.liuchunming.springboot02.entity.Book;
import com.liuchunming.springboot02.utils.PageBean;
import org.springframework.cache.annotation.CacheEvict;
import org.springframework.cache.annotation.CachePut;

import java.util.List;

/**
 * @author liuchunming
 * @site www.liuchunming.com
 * @company xxx公司
 * @create  2020-11-29 15:42
 */
public interface BookService {
    int deleteByPrimaryKey(Integer bid);

    @Cacheable(value = "my-redis-cache1",condition = "#bid>30",key = "'bookid'+#bid")
//表示使用my-redis-cache1缓存空间,key的生成策略为book+bid,当bid>10的时候才会使用缓存
    Book selectByPrimaryKey(Integer bid);

    List<Book> listPager(Book book, PageBean pageBean);

}

测试代码

package com.liuchunming.springboot02.service.impl;


import com.liuchunming.springboot02.entity.Book;
import com.liuchunming.springboot02.service.BookService;
import com.liuchunming.springboot02.utils.PageBean;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;

/**
 * @author liuchunming
 * @site www.liuchunming.com
 * @company xxx公司
 * @create  2020-11-29 15:49
 */
@SpringBootTest
public class BookServiceImplTest   {
    
    @Autowired
    private BookService service;

    @Test
    public void deleteByPrimaryKey() {
        service.deleteByPrimaryKey(2);
    }

    @Test
    public void listPager() {
        Book book =new Book();
        book.setBname("%圣墟%");
        PageBean pageBean=new PageBean();
        pageBean.setPage(2);
        List<Book> books = service.listPager(book,pageBean);
        for (Book book1 : books) {
            System.out.println(book1);
        }
    }

    @Test
    public void selectByPrimaryKey() {
        System.out.println(service.selectByPrimaryKey(33));
        System.out.println(service.selectByPrimaryKey(33));
    }

    
}

效果展示
不使用redis缓存查询两次数据库
在这里插入图片描述
在这里插入图片描述
key的生成策略为bookid+参数
在这里插入图片描述
@CachePut:作用是主要针对方法配置,能够根据方法的请求参数对其结果进行缓存,和 @Cacheable 不同的是,它每次都会触发真实查询
方法的调用
主要参数说明:
参数配置和@Cacheable一样。

@CacheEvict:作用是主要针对方法配置,能够根据一定的条件对缓存进行清空

主要参数说明:
1)value , key 和 condition 参数配置和@Cacheable一样。
2) allEntries :
是否清空所有缓存内容,缺省为 false,
如果指定为 true,则方法调用后将立即清空所有缓存,
例如:@CachEvict(value=”testcache”,allEntries=true)。
service层

package com.liuchunming.springboot02.service;

import com.liuchunming.springboot02.entity.Book;
import com.liuchunming.springboot02.utils.PageBean;
import org.springframework.cache.annotation.CacheEvict;
import org.springframework.cache.annotation.CachePut;

import java.util.List;

/**
 * @author liuchunming
 * @site www.liuchunming.com
 * @company xxx公司
 * @create  2020-11-29 15:42
 */
public interface BookService {
    int deleteByPrimaryKey(Integer bid);


    @CachePut(value = "my-redis-cache2",condition = "#bid>30",key = "'bookid'+#bid") //与Cacheable注解一样的,但是它是将结果存放到redis中去,下次执行方法还是查询数据库不会查redis 只负责存!
//    @Cacheable(value = "my-redis-cache1",condition = "#bid>30",key = "'bookid'+#bid")
    Book selectByPrimaryKey(Integer bid);

    @CachePut(value = "my-redis-cache1")
    List<Book> listPager(Book book, PageBean pageBean);

    @CacheEvict(value = "my-redis-cache2",allEntries = true)
    void clear();
}

测试代码

package com.liuchunming.springboot02.service.impl;


import com.liuchunming.springboot02.entity.Book;
import com.liuchunming.springboot02.service.BookService;
import com.liuchunming.springboot02.utils.PageBean;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;

/**
 * @author liuchunming
 * @site www.liuchunming.com
 * @company xxx公司
 * @create  2020-11-29 15:49
 */
@SpringBootTest
public class BookServiceImplTest   {
    
    @Autowired
    private BookService service;

    @Test
    public void deleteByPrimaryKey() {
        service.deleteByPrimaryKey(2);
    }

    @Test
    public void listPager() {
        Book book =new Book();
        book.setBname("%圣墟%");
        PageBean pageBean=new PageBean();
        pageBean.setPage(2);
        List<Book> books = service.listPager(book,pageBean);
        for (Book book1 : books) {
            System.out.println(book1);
        }
    }

    @Test
    public void selectByPrimaryKey() {
        System.out.println(service.selectByPrimaryKey(33));
        System.out.println(service.selectByPrimaryKey(33));
    }

    
}

验证只存不取

在这里插入图片描述
在这里插入图片描述
验证清空
在这里插入图片描述
在这里插入图片描述
延续上篇博客工程写的

END…

已标记关键词 清除标记
©️2020 CSDN 皮肤主题: 数字20 设计师:CSDN官方博客 返回首页