SpringBoot如何集成Redis？

你的名字 2024-03-22 13:50 59阅读 0赞

### 第一步，导入jar包 ###

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-data-redis</artifactId>
            </dependency>
            
    复制代码

### 第二步，编写配置类 ###

这是一个使用FastJson序列化器，配置RedisTemplate的Spring Bean的Java类。该类使用了@Configuration注释来标识这是一个配置类，并使用@Bean注释来标识该方法是创建一个Bean的工厂方法。该方法名为redisTemplate，并使用了@ConditionalOnMissingBean注释，表示如果在上下文中没有StringRedisTemplate类型的Bean，则会自动创建一个该类型的Bean。该方法返回一个RedisTemplate类型的对象，该对象被配置为使用FastJson序列化器，以便将对象序列化为JSON格式进行存储和检索。在方法内部，通过setConnectionFactory方法设置了RedisTemplate的连接工厂，并通过setKeySerializer和setValueSerializer方法设置了键和值的序列化器。此外，该类还提供了一个名为stringRedisTemplate的方法，用于创建StringRedisTemplate类型的Bean。

import com.alibaba.fastjson.support.spring.FastJsonRedisSerializer;
    import com.fasterxml.jackson.annotation.JsonAutoDetect;
    import com.fasterxml.jackson.annotation.JsonTypeInfo;
    import com.fasterxml.jackson.annotation.PropertyAccessor;
    import com.fasterxml.jackson.databind.ObjectMapper;
    import com.fasterxml.jackson.databind.jsontype.impl.LaissezFaireSubTypeValidator;
    import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    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.StringRedisSerializer;
    
    @Configuration
    public class RedisConfig {
    
        /**
         * 重写Redis序列化方式，使用Json方式: * 当我们的数据存储到Redis的时候，我们的键（key）和值（value）
         * 都是通过Spring提供的Serializer序列化到数据库的。RedisTemplate默认使用的是JdkSerializationRedisSerializer，
         * StringRedisTemplate默认使用的是StringRedisSerializer。
         * Spring Data JPA为我们提供了下面的Serializer：
         * GenericToStringSerializer、Jackson2JsonRedisSerializer、JacksonJsonRedisSerializer、
         * JdkSerializationRedisSerializer、OxmSerializer、StringRedisSerializer。
         * 在此我们将自己配置RedisTemplate并定义Serializer。
         *
         * @param redisConnectionFactory * @return
         */
        @Bean("getRedisTemplate")
        public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
            RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
            /**
             * 配置连接工厂
             */
            redisTemplate.setConnectionFactory(redisConnectionFactory);
            /**
             * 使用FJackson2JsonRedisSerializer序列化工具
             */
            FastJsonRedisSerializer fastJsonRedisSerializer = new FastJsonRedisSerializer(Object.class);
            ObjectMapper objectMapper = new ObjectMapper();
            /**
             * 指定要序列化的域Field、set、get，以及修饰符范围
             * ANY是都有，包括private、public
             */
            objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
            /**
             * 指定序列化输入的类型，类必须是非final修饰的，
             * final修饰的类，比如
             * public final class User implements Serializable{},会包异常
             */
            objectMapper.activateDefaultTyping(LaissezFaireSubTypeValidator.instance,
                    ObjectMapper.DefaultTyping.NON_FINAL, JsonTypeInfo.As.PROPERTY);
    
    
            /**
             *设置键（key）的序列化采用StringRedisSerializer。
             */
            redisTemplate.setKeySerializer(new StringRedisSerializer());
            redisTemplate.setHashKeySerializer(new StringRedisSerializer());
    
            /**
             * 设置值（value）的序列化采用jackson2JsonRedisSerializer。
             */
            redisTemplate.setValueSerializer(fastJsonRedisSerializer);
            redisTemplate.setHashValueSerializer(fastJsonRedisSerializer);
            redisTemplate.afterPropertiesSet();
            return redisTemplate;
        }
    
        /**
         * 配置stringRedisTemplate序列化方式
         *
         * @param redisConnectionFactory
         * @return
         */
        @Bean
        @ConditionalOnMissingBean(StringRedisTemplate.class)
        public StringRedisTemplate stringRedisTemplate(RedisConnectionFactory redisConnectionFactory) {
            StringRedisTemplate template = new StringRedisTemplate();
            template.setConnectionFactory(redisConnectionFactory);
            return template;
        }
    
    }
    复制代码

### 第三步，编写util类 ###

这段代码是一个基于Spring框架和Redis实现的工具类，封装了一些常见的操作方法。它依赖于另一个Redis配置类，通过@Autowired注解和@Qualifier注解来获取到RedisTemplate实例，从而进行操作。

具体的操作方法有：

*  set：设置键值对，将value存储到key中。
 *  set：设置键值对并指定过期时间，将value存储到key中，并设置过期时间。
 *  remove：删除一个或多个key对应的值。
 *  exists：判断指定的key是否存在于缓存中。
 *  get：获取指定key对应的值。

需要注意的是，get方法返回的是一个经过JSON序列化的字符串，而不是原始的对象。如果要使用对象，需要在调用get方法之后进行反序列化。

package com.wangfugui.apprentice.common.util;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.beans.factory.annotation.Qualifier;
    import org.springframework.data.redis.core.RedisTemplate;
    import org.springframework.data.redis.core.ValueOperations;
    import org.springframework.stereotype.Component;
    
    import java.io.Serializable;
    import java.util.concurrent.TimeUnit;
    
    /**
     * RedisUtils:redis工具类
     */
    @Component
    public class RedisUtils {
    
        @Autowired
        @Qualifier("getRedisTemplate")
        private RedisTemplate redisTemplate;
    
    
        /**
         * 设置键值
         *
         * @Param: [key, value]
         * @return: boolean
         * @Author: MaSiyi
         * @Date: 2021/11/20
         */
        public boolean set(final String key, Object value) {
            boolean result = false;
            try {
                ValueOperations<Serializable, Object> operations = redisTemplate.opsForValue();
                operations.set(key, value);
                result = true;
            } catch (Exception e) {
                e.printStackTrace();
            }
            return result;
        }
    
        /**
         * 写入缓存设置失效时间
         *
         * @param key
         * @param value
         * @return
         */
        public boolean set(final String key, Object value, Long expireTime) {
            boolean result = false;
            try {
                ValueOperations<Serializable, Object> operations = redisTemplate.opsForValue();
                operations.set(key, value);
                redisTemplate.expire(key, expireTime, TimeUnit.SECONDS);
                result = true;
            } catch (Exception e) {
                e.printStackTrace();
            }
            return result;
        }
    
        /**
         * 批量删除对应的value
         */
        public void remove(final String... keys) {
            for (String key : keys) {
                remove(key);
            }
        }
    
        /**
         * 删除对应的value
         */
        public void remove(final String key) {
            if (exists(key)) {
                redisTemplate.delete(key);
            }
        }
    
        /**
         * 判断缓存当中是否有对应的value
         *
         * @param key
         * @return
         */
        public boolean exists(final String key) {
            return redisTemplate.hasKey(key);
        }
        
     /**
         * 根据key，获取到对应的value值
         *
         * @param key
         *            key-value对应的key
         * @return  该key对应的值。
         *          注: 若key不存在， 则返回null。
         *
         * @date 2020/3/8 16:27:41
         */
        public String get(String key) {
            return JSONObject.toJSONString(redisTemplate.opsForValue().get(key));
        }
    
    }
    复制代码

### 第四步，配置yml ###

这是一个YAML格式的Spring Boot配置文件，配置了Redis数据库的连接信息，包括：

*  database: Redis数据库的编号，默认为0。
 *  host: Redis服务器的IP地址。
 *  port: Redis服务器的端口号。

这些配置信息会被Spring Boot自动加载并注入到对应的Bean中，可以在代码中使用这些Bean来连接和操作Redis数据库。

spring:
      redis:
        database: 0
        host: 127.0.0.1
        port: 6379