spring boot整合redis及redis注解开发

spring boot整合redis

 

步骤一：导入pom依赖

<!--  redis与springboot 依赖 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<!-- redis使用jedis操作数据库 依赖 -->
<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
</dependency>

步骤二： redis配置到spring boot全局配置文件application.yml

spring:
  redis:
      database: 0
      host: 192.168.147.144
      port: 6379
      password: 123456
         jedis:
          pool:
              max-active: 100
              max-idle: 3
              max-wait: -1
              min-idle: 0
      timeout: 1000

这里spring boot配置redis,相较于ssm配置redis，这里配置了 redis 的注册信息，jedis 连接池 jedis pool 以及jedisConnectionfactory 

步骤三：创建 RedisConfig 帮助类

package com.practice.springboot3.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.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;

/**
 * @author Giraffe Wld
 * @site www.grf.com
 * @company grf公司
 * @create  2019-03-15 16:08
 * redis配置类
 */
@Configuration
/** @Configuration底层是含有@Component ，所以@Configuration 具有和 @Component 的作用。
 @Configuration可理解为用spring的时候xml里面的<beans>标签。 */
@EnableCaching//开启注解式缓存
//继承CachingConfigurerSupport，为了自定义生成KEY的策略。可以不继承。
public class RedisConfig {

    /** RedisTemplate与 StringRedisTemplate的区别
     *    详解：
     *      1，两者是独立的 各有自己的工作空间，也就是它俩都是使用的redis数据库，但是彼此互不干涉彼此的数据信息
     *      2，两者实现各不相同的序列化接口，RedisTemplate使用的是JdkSerializationRedisSerializer 存入数据会将数据先序列化成字节数组然后在存入Redis数据库。
     * 　　 StringRedisTemplate使用的是StringRedisSerializer
     *      （以map作栗子）
     *      3，RedisTemplate数据返回的是<String,Object> 当你需要获取该数据时，使用redisTemplate则是不需要做类型转换的
     *         StringRedisTemplate数据返回的是<String, String> 类型，所以你在存取数据时，如果是字符串类型的数据，则可以使用stringRedisTemplate
     *
     * */

    /**
     * 生成key的策略 根据类名+方法名+所有参数的值生成唯一的一个key
     *
     * @return
     */
    @Bean
    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();
            }
        };
    }

    /**
     * 管理缓存
     *      返回一个redis的缓存空间，然后在方法里头设置添加在该空间的缓存槽，最终就可以将每个element存放到redis
     *
     * @param redisConnectionFactory   已经在yml文件中，成功注入
     * @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))     // 设置缓存的默认过期时间，也是使用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)));

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

    /** 到这里,我们回想一下之前学习hibernate时，我们是通过hibernateTemplate操作数据库，
     *       而后，我们再联想到该方法，返回一个redisTemplate,redis是一个非关系型数据库，所以这里我们要操作redis数据库时，
     *         也是需要获取一个相对应template去操作redis数据库 */
    @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;
    }

    /**  使用stringRedisTemplate操作redis数据库， */
    @Bean
    public StringRedisTemplate stringRedisTemplate(RedisConnectionFactory factory) {
        StringRedisTemplate stringRedisTemplate = new StringRedisTemplate();
        stringRedisTemplate.setConnectionFactory(factory);
        return stringRedisTemplate;
    }
}

步骤四：注解式开发redis使用缓存

在指定的方法上添加你想使用的注解方式

/**  redis注解式开发
     * @Cacheable 开启指定方法，缓存数据到redis,可存可取
     * @CachePut  缓存数据到redis,每次都会触发真实的方法数据调用，只存不取
     * @CacheEvict  清空缓存到redis数据库的信息
     *     allEntries ：是否清空所有缓存内容；beforeInvocation ：是否在方法执行前就清空
     * */

    /** value的意思：在该redis缓存空间使用指定的缓存槽 ; condition：设置redis缓存数据的条件,布尔表达式 ; key: 设置你缓存在redis的数据的key名称*/
    @Cacheable(value = "my-redis-cache1",key = "'book'+#book_id", condition = "#book_id > 0")
    Book selectByPrimaryKey(Integer book_id);

好了，去玩吧！！！