SpringBoot与Redis的整合

##1. 添加redis的starter启动器

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

##2. 在 application.yml文件中进行redis的相关配置

spring: 
    redis: 
        host: ${redis_server:127.0.0.1}
        port: ${redis_port:6379}
        password: ${redis_pwd:123456}
        timeout: 8000
        database: 0
        jedis:
            pool:
                max-idle: 1000
                max-wait: -1
                min-idle: 0

##3. 添加redis的配置类信息

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.data.redis.RedisProperties;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.cache.CacheManager;
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.RedisOperations;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.RedisSerializationContext;
import org.springframework.data.redis.serializer.RedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;

import java.time.Duration;

@Configuration
@ConditionalOnClass({RedisOperations.class})
@EnableConfigurationProperties(RedisProperties.class)
public class RedisConfig {
    @Bean
    public RedisSerializer<Object> jackson2JsonRedisSerializer() {
        Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<Object>(Object.class);
        ObjectMapper objectMapper = new ObjectMapper();
        // 指定要序列化的域，field,get和set,以及修饰符范围，ANY是都有包括private和public
        objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        // 指定序列化输入的类型，类必须是非final修饰的，final修饰的类，比如String,Integer等会跑出异常
        objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        jackson2JsonRedisSerializer.setObjectMapper(objectMapper);
        return jackson2JsonRedisSerializer;
    }

    @Bean
    public KeyGenerator keyGenerator() {
        return (target, method, params) -> {
            StringBuilder result = new StringBuilder();
            result.append(target.getClass().getName());
            result.append(".").append(method.getName());

            StringBuilder strParams = new StringBuilder();
            for (Object param : params) {
                if (param != null) {
                    param = "null";
                }
                strParams.append(param.toString() + ":");
            }

            if (strParams.length() > 0) {
                result.append("_").append(strParams);
            }
            return result.toString();
        };
    }

    @Bean
    public CacheManager cacheManager(RedisConnectionFactory redisConnectionFactory) {
        RedisCacheConfiguration cacheConfiguration = RedisCacheConfiguration.defaultCacheConfig() // 开启默认配置
                .entryTtl(Duration.ofSeconds(60 * 60 * 24 * 90)) // 设置超时时间. 90天
                .serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(new StringRedisSerializer())) // 设置key序列化器
                .serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(jackson2JsonRedisSerializer())) // 设置value序列化器
                .disableCachingNullValues(); // 不允许存储null值

        return RedisCacheManager.builder(redisConnectionFactory) // 指定redis生产者
                .cacheDefaults(cacheConfiguration) // 指定redis配置
                .build(); // 构建
    }

    @Bean(name = "redisTemplate")
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
        RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(factory);

        StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();

        redisTemplate.setKeySerializer(stringRedisSerializer); // String对应key的序列化器
        redisTemplate.setHashKeySerializer(stringRedisSerializer); // HashKey对应key的序列化器
        redisTemplate.setDefaultSerializer(jackson2JsonRedisSerializer());// value对应key的序列化器

        redisTemplate.afterPropertiesSet();
        return redisTemplate;
    }

}

##4. 添加redis的工具service类

package com.example.demo.service;

import org.springframework.data.redis.core.Cursor;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.ScanOptions;
import org.springframework.data.redis.core.SessionCallback;
import org.springframework.stereotype.Service;
import org.springframework.util.StringUtils;

import javax.annotation.Resource;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;

@Service
public class RedisService {

    private static final List<String> WILDCARD = Arrays.asList("*", "?", "[", "]");

    @Resource(name = "redisTemplate")
    protected RedisTemplate<String, Object> redisTemplate = null;

    /**
     * 在同一个connection中执行redis命令
     *
     * @param sessionCallback
     */
    public Object execute(SessionCallback<Object> sessionCallback) {
        return redisTemplate.execute(sessionCallback);
    }

    /**
     * 指定缓存过期时间
     *
     * @param key  键
     * @param time 单位:秒
     * @return
     */
    public Boolean expire(String key, long time) {
        return redisTemplate.expire(key, time, TimeUnit.SECONDS);
    }

    /**
     * 根据key获取过期时间
     *
     * @param key 根据key 获取过期时间
     * @return 时间(秒) 返回0代表为永久有效
     */
    public Long ttl(String key) {
        if (!StringUtils.isEmpty(key)) {
            return redisTemplate.getExpire(key, TimeUnit.SECONDS);
        }
        return null;
    }

    /**
     * 判断key是否存在
     *
     * @param key 键
     * @return true:存在; false:不存在
     */
    public Boolean hasKey(String key) {
        return redisTemplate.hasKey(key);
    }

    /**
     * 清除缓存
     *
     * @param keys
     */
    public Long del(String... keys) {
        if (keys == null || keys.length < 1) {
            throw new RuntimeException("KEY must be not null or empty!");
        }
        Long result = 0L;
        for (String key : keys) {
            if (hasWildCard(key)) {
                // 包含通配符
                result += redisTemplate.delete(keys(key));
            } else {
                // 不包含通配符
                result += redisTemplate.delete(Arrays.asList(key));
            }
        }
        return result;
    }

    /**
     * 根据表达式获取对应的key集合
     *
     * @param pattern
     * @return
     */
    public Set<String> keys(String pattern) {
        return redisTemplate.keys(pattern);
    }

    // start============================String=============================start

    /**
     * 缓存获取
     *
     * @param key 键
     * @return 值
     */
    public Object get(String key) {
        return StringUtils.isEmpty(key) ? null : redisTemplate.opsForValue().get(key);
    }

    /**
     * 设置缓存并设置过期时间
     *
     * @param key        键
     * @param value      值
     * @param expireTime 过期时间, 单位秒,如果time小于等于0 将设置无限期
     * @return
     */
    public void set(String key,
                    Object value,
                    Long expireTime) {
        if (expireTime == null) {
            redisTemplate.opsForValue().set(key, value);
        } else {
            redisTemplate.opsForValue().set(key, value, expireTime, TimeUnit.SECONDS);
        }
    }

    /**
     * 设置缓存
     *
     * @param key   键
     * @param value 值
     * @return true:成功; false:失败
     */
    public void set(String key, Object value) {
        set(key, value, null);
    }

    /**
     * 只在键 key 不存在的情况下， 将键 key 的值设置为 value 。若键 key 已经存在， 则 SETNX 命令不做任何动作。
     *
     * @param key        键
     * @param value      值
     * @param expireTime 过期时间, 单位秒,如果time小于等于0 将设置无限期
     * @return
     */
    public Boolean setnx(String key, Object value, Long expireTime) {
        if (expireTime == null) {
            return redisTemplate.opsForValue().setIfAbsent(key, value);
        } else {
            return redisTemplate.opsForValue().setIfAbsent(key, value, expireTime, TimeUnit.SECONDS);
        }

    }

    /**
     * 只在键 key 不存在的情况下， 将键 key 的值设置为 value 。若键 key 已经存在， 则 SETNX 命令不做任何动作。
     *
     * @param key   键
     * @param value 值
     * @return
     */
    public Boolean setnx(String key, Object value) {
        return this.setnx(key, value, null);
    }

    /**
     * 递增
     *
     * @param key   键
     * @param delta 要增加多少
     * @return
     */
    public long incr(String key,
                     long delta) {
        if (delta < 0) {
            throw new RuntimeException("递增因子必须大于0");
        }
        return redisTemplate.opsForValue().increment(key, delta);
    }

    /**
     * 递减
     *
     * @param key   键
     * @param delta 要减少多少
     * @return
     */
    public long decr(String key,
                     long delta) {
        if (delta < 0) {
            throw new RuntimeException("递减因子必须大于0");
        }
        return redisTemplate.opsForValue().increment(key, -delta);
    }

    // end============================String=============================end

    // start============================Map=============================start

    /**
     * 返回Hash的元素个数
     *
     * @param key 键
     * @return
     */
    public Long hlen(String key) {
        return redisTemplate.opsForHash().size(key);
    }

    /**
     * HashGet
     *
     * @param key  键 不能为null
     * @param item 项 不能为null
     * @return 值
     */
    public Object hget(String key,
                       String item) {
        return redisTemplate.opsForHash().get(key, item);
    }

    /**
     * 获取hashKey对应的所有键值
     *
     * @param key 键
     * @return 对应的多个键值
     */
    public Map<Object, Object> hmget(String key) {
        return redisTemplate.opsForHash().entries(key);
    }


    /**
     * HashSet 并设置时间
     *
     * @param key        键
     * @param map        对应多个键值
     * @param expireTime 过期时间, 单位秒
     * @return true成功 false失败
     */
    public void hmset(String key, Map<String, Object> map, Long expireTime) {
        redisTemplate.opsForHash().putAll(key, map);
        if (expireTime != null) {
            expire(key, expireTime);
        }
    }

    /**
     * HashSet
     *
     * @param key 键
     * @param map 对应多个键值
     * @return true 成功 false 失败
     */
    public void hmset(String key, Map<String, Object> map) {
        hmset(key, map, null);
    }

    /**
     * 向一张hash表中放入数据,如果不存在将创建
     *
     * @param key   键
     * @param item  项
     * @param value 值
     * @return true 成功 false失败
     */
    public void hset(String key, String item, Object value) {
        redisTemplate.opsForHash().put(key, item, value);
    }

    /**
     * 删除hash表中的值
     *
     * @param key  键 不能为null
     * @param item 项 可以使多个 不能为null
     */
    public void hdel(String key,
                     Object... item) {
        redisTemplate.opsForHash().delete(key, item);
    }

    /**
     * 判断hash表中是否有该项的值
     *
     * @param key  键 不能为null
     * @param item 项 不能为null
     * @return true 存在 false不存在
     */
    public boolean hexists(String key, String item) {
        return redisTemplate.opsForHash().hasKey(key, item);
    }

    /**
     * hash递增 如果不存在,就会创建一个 并把新增后的值返回
     *
     * @param key   键
     * @param item  项
     * @param delta 要增加多少
     * @return
     */
    public double hincr(String key, String item, double delta) {
        return redisTemplate.opsForHash().increment(key, item, delta);
    }

    /**
     * hash递减
     *
     * @param key   键
     * @param item  项
     * @param delta 要减少多少(小于0)
     * @return
     */
    public double hdecr(String key, String item, double delta) {
        return redisTemplate.opsForHash().increment(key, item, -delta);
    }

    public Cursor<Map.Entry<Object, Object>> hscan(String key, ScanOptions scanOptions) {
        return redisTemplate.opsForHash().scan(key, scanOptions);
    }

    // end============================Map=============================end

    // start============================Set=============================start

    /**
     * 根据key获取Set中的所有值
     *
     * @param key 键
     * @return
     */
    public Set<Object> smembers(String key) {
        return redisTemplate.opsForSet().members(key);
    }

    /**
     * 根据value从一个set中查询,是否存在
     *
     * @param key   键
     * @param value 值
     * @return true 存在 false不存在
     */
    public boolean sismember(String key,
                             Object value) {
        return redisTemplate.opsForSet().isMember(key, value);
    }

    /**
     * 将数据放入set缓存
     *
     * @param key    键
     * @param values 值 可以是多个
     * @return 成功个数
     */
    public long sadd(String key, Object... values) {
        return redisTemplate.opsForSet().add(key, values);
    }

    /**
     * 将set数据放入缓存
     *
     * @param key        键
     * @param expireTime 过期时间(秒)
     * @param values     值 可以是多个
     * @return 成功个数
     */
    public long sadd(String key,
                     long expireTime,
                     Object... values) {
        Long count = redisTemplate.opsForSet().add(key, values);
        if (expireTime > 0) {
            expire(key, expireTime);
        }
        return count;
    }

    /**
     * 获取set缓存的长度
     *
     * @param key 键
     * @return
     */
    public long slen(String key) {
        return redisTemplate.opsForSet().size(key);
    }

    /**
     * 移除值为value的
     *
     * @param key    键
     * @param values 值 可以是多个
     * @return 移除的个数
     */
    public long srem(String key, Object... values) {
        return redisTemplate.opsForSet().remove(key, values);
    }
    // end============================Set=============================end

    // start============================List=============================start

    /**
     * 获取list缓存的内容
     *
     * @param key   键
     * @param start 开始
     * @param end   结束 0 到 -1代表所有值
     * @return
     */
    public List<Object> lrange(String key, long start, long end) {
        return redisTemplate.opsForList().range(key, start, end);
    }

    /**
     * 获取list缓存的长度
     *
     * @param key 键
     * @return
     */
    public long llen(String key) {
        return redisTemplate.opsForList().size(key);
    }

    /**
     * 通过索引 获取list中的值
     *
     * @param key   键
     * @param index 索引 index>=0时， 0 第一个元素，1 第二个元素，依次类推；index<0时，-1，表尾，-2倒数第二个元素，依次类推
     * @return
     */
    public Object lindex(String key, long index) {
        return redisTemplate.opsForList().index(key, index);
    }

    /**
     * 将list放入缓存
     *
     * @param key   键
     * @param value 值
     * @return
     */
    public Long rpush(String key, Object value) {
        return redisTemplate.opsForList().rightPush(key, value);
    }

    /**
     * 将list放入缓存
     *
     * @param key   键
     * @param value 值
     * @return
     */
    public Long lset(String key, List<Object> value) {
        return redisTemplate.opsForList().rightPushAll(key, value);
    }

    /**
     * 将list放入缓存
     *
     * @param key        键
     * @param value      值
     * @param expireTime 时间(秒)
     * @return
     */
    public Long lset(String key, List<Object> value, long expireTime) {
        Long result = redisTemplate.opsForList().rightPushAll(key, value);
        if (expireTime > 0) {
            expire(key, expireTime);
        }
        return result;
    }

    /**
     * 根据索引修改list中的某条数据
     *
     * @param key   键
     * @param index 索引
     * @param value 值
     * @return
     */
    public void lset(String key, long index, Object value) {
        redisTemplate.opsForList().set(key, index, value);
    }

    /**
     * 移除N个值为value
     *
     * @param key   键
     * @param count 移除多少个.count > 0 : 从表头开始向表尾搜索，移除与 value 相等的元素; count < 0 :
     *              从表尾开始向表头搜索，移除与 value 相等的元素; count = 0 : 移除表中所有与 value 相等的值
     * @param value 值
     * @return 移除的个数
     */
    public Long lrem(String key, long count, Object value) {
        return redisTemplate.opsForList().remove(key, count, value);
    }
    // end============================List=============================end

    // start============================SortedSet=============================start

    /**
     * 将一个member 元素及其 score 值加入到有序集 key 当中。
     *
     * @param key   键
     * @param value 值
     * @param score 分数
     */
    public boolean zadd(String key, Object value, double score) {
        return redisTemplate.opsForZSet().add(key, value, score);
    }

    /**
     * 返回有序集 key 中，所有 score 值介于 min 和 max 之间(包括等于 min 或 max )的成员。有序集成员按 score
     * 值递增(从小到大)次序排列。
     *
     * @param key 键
     * @param min 最小值
     * @param max 最大值
     * @return
     */
    public Set<Object> zrangebyscore(String key, double min, double max) {
        return redisTemplate.opsForZSet().rangeByScore(key, min, max);
    }

    /**
     * 返回有序集 key 中， score值在min和max之间(默认包括 score值等于min或max)的成员的数量
     *
     * @param key 键
     * @param min 最小值
     * @param max 最大值
     * @return
     */
    public long zcount(String key, double min, double max) {
        return redisTemplate.opsForZSet().count(key, min, max);
    }

    /**
     * 移除有序集 key 中，所有 score 值介于 min 和 max 之间(包括等于 min 或 max )的成员。
     *
     * @param key 键
     * @param min 最小值
     * @param max 最大值
     * @return
     */
    public long removeRangeByScore(String key, double min, double max) {
        return redisTemplate.opsForZSet().removeRangeByScore(key, min, max);
    }

    // end============================SortedSet=============================end

    // start============================HyperLogLog=============================start
    public Long pfadd(String key, Object... values) {
        return redisTemplate.opsForHyperLogLog().add(key, values);
    }

    public Long pfcount(String key) {
        return redisTemplate.opsForHyperLogLog().size(key);
    }

    public Long pfmerge(String key, String... keys) {
        return redisTemplate.opsForHyperLogLog().union(key, keys);
    }
    // end============================HyperLogLog=============================end


    /**
     * 判断key中是否包含redis的通配符
     *
     * @param key redis的键
     * @return 如果包含通配符则返回true, 否则返回false
     */
    private boolean hasWildCard(String key) {
        for (String wildcard : WILDCARD) {
            if (key.contains(wildcard)) {
                return true;
            }
        }
        return false;
    }
}

##附加：将springboot的web程序的session保存入session里
###1. 添加jar包

<dependency>
    <groupId>org.springframework.session</groupId>
    <artifactId>spring-session-data-redis</artifactId>
</dependency>

###2. 在启动类上添加注解@EnableRedisHttpSession

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
import org.springframework.session.data.redis.config.annotation.web.http.EnableRedisHttpSession;

@SpringBootApplication
@EnableRedisHttpSession(maxInactiveIntervalInSeconds = 60 * 15, redisNamespace = "${spring.application.name}")
public class Application extends SpringBootServletInitializer {
	public static void main(String[] args) {
		SpringApplication.run(Application.class, args);
	}
}