Spring和Redis整合详解

谁践踏了优雅 2022-04-23 12:00 188阅读 0赞

## Spring和Redis整合详解 ##

### 官方主页 ###

[Spring][]

[Spring Redis][]

### 概述 ###

Redis是一个开源（BSD许可）的内存数据结构存储，用作数据库，缓存和消息代理。  
简单来说,它是一个以(key,value)的形式存储数据的数据库.

官网：[https://redis.io/download][https_redis.io_download] 去下载对应的版本。

Spring已经为我们对Redis做了很好的封装，我们需要做的就是配置和Sercice的调用。

Git地址：  
[Gitee][]

项目地址：  
[品茗IT-同步发布][IT-]

[品茗IT][IT] 提供在线支持：

[一键快速构建Spring项目工具][Spring 1]

[一键快速构建SpringBoot项目工具][SpringBoot]

[一键快速构建SpringCloud项目工具][SpringCloud]

[一站式Springboot项目生成][Springboot]

**如果大家正在寻找一个java的学习环境，或者在开发中遇到困难，可以[加入我们的java学习圈，点击即可加入][java]，共同学习，节约学习时间，减少很多在学习中遇到的难题。**

### 开始搭建 ###

#### 依赖Jar包 ####

<dependency>
    	<groupId>redis.clients</groupId>
    	<artifactId>jedis</artifactId>
    	<version>${redis.version}</version>
    </dependency>
    <dependency>
    	<groupId>org.springframework.data</groupId>
    	<artifactId>spring-data-redis</artifactId>
    	<version>${spring.redis.version}</version>
    </dependency>

#### Spring-redis配置 ####

在spring的xml中，配置redis的连接池，并按照spring的规范，定义redisTemplate，方便service的调用。

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aop="http://www.springframework.org/schema/aop" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd ">
    
    	<bean id="annotationPropertyConfigurerRedis" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
    		<property name="order" value="1" />
    		<property name="ignoreUnresolvablePlaceholders" value="true" />
    		<property name="locations">
    			<list>
    				<value>classpath:redis.properties</value>
    			</list>
    		</property>
    	</bean>
    
    	
        <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}" />
            
            <property name="testOnBorrow" value="${redis.testOnBorrow}" />
        </bean>
    
        
        <bean id="jedisConnectionFactory" class="org.springframework.data.redis.connection.jedis.JedisConnectionFactory">
            
            <property name="hostName" value="${redis.host}" />
            
            <property name="port" value="${redis.port}" />
    		<property name="password" value="${redis.password}" />
            
            <property name="timeout" value="${redis.timeout}" />
            
            <property name="poolConfig" ref="poolConfig" />
            
            <property name="usePool" value="true"/>
        </bean>
    
        
        <bean id="redisTemplate" class="org.springframework.data.redis.core.RedisTemplate">
            <property name="connectionFactory" ref="jedisConnectionFactory" />
            <property name="keySerializer">
                <bean class="org.springframework.data.redis.serializer.StringRedisSerializer" />
            </property>
            <property name="valueSerializer">
                <bean class="org.springframework.data.redis.serializer.JdkSerializationRedisSerializer" />
            </property>
            <property name="hashKeySerializer">
                <bean class="org.springframework.data.redis.serializer.StringRedisSerializer" />
            </property>
            <property name="hashValueSerializer">
                <bean class="org.springframework.data.redis.serializer.JdkSerializationRedisSerializer" />
            </property>
               
            <property name="enableTransactionSupport" value="true"></property>  
        </bean>
    	
    	  
        <bean id="redisService" class="com.cff.springwork.redis.service.RedisService">  
            <property name="redisTemplate" ref="redisTemplate" />  
        </bean>
    </beans>

这里，我们用到了redis.properties配置文件。

redis.properties：

redis.maxTotal=10
    redis.maxIdle=5
    redis.maxWaitMillis=2000
    redis.testOnBorrow=true
    redis.host=192.168.0.1
    redis.port=20806
    redis.timeout=0
    redis.password=test
    redis.testWhileIdle=true 
    redis.timeBetweenEvictionRunsMillis=30000  
    redis.numTestsPerEvictionRun=50

#### Redis调用的service ####

我们可以编写一个完整的service，方便以后使用。  
RedisService：

package com.cff.springwork.redis.service;
    
    import java.util.List;
    import java.util.Map;
    import java.util.Set;
    import java.util.concurrent.TimeUnit;
    
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    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.ZSetOperations;
    import org.springframework.util.CollectionUtils;
    
    public class RedisService { 
    	
    	private Logger log = LoggerFactory.getLogger(this.getClass());
    	
        private final RedisTemplate<String, Object> redisTemplate;
        
        public RedisService(RedisTemplate<String, Object> redisTemplate) { 
            this.redisTemplate = redisTemplate;
        }
    
        /** * 指定缓存失效时间 * * @param key 键 * @param time 时间(秒) * @return */
        public boolean expire(String key, long time) { 
            try { 
                if (time > 0) { 
                    redisTemplate.expire(key, time, TimeUnit.SECONDS);
                }
                return true;
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return false;
            }
        }
    
        /** * 根据key 获取过期时间 * * @param key 键 不能为null * @return 时间(秒) 返回0代表为永久有效 */
        public long getExpire(String key) { 
            return redisTemplate.getExpire(key, TimeUnit.SECONDS);
        }
    
        /** * 判断key是否存在 * * @param key 键 * @return true 存在 false不存在 */
        public boolean hasKey(String key) { 
            try { 
                return redisTemplate.hasKey(key);
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return false;
            }
        }
    
        /** * 删除缓存 * * @param key 可以传一个值 或多个 */
        @SuppressWarnings("unchecked")
        public void del(String... key) { 
            if (key != null && key.length > 0) { 
                if (key.length == 1) { 
                    redisTemplate.delete(key[0]);
                } else { 
                    redisTemplate.delete(CollectionUtils.arrayToList(key));
                }
            }
        }
    
        // ============================String=============================
    
        /** * 普通缓存获取 * * @param key 键 * @return 值 */
        public Object get(String key) { 
            return key == null ? null : redisTemplate.opsForValue().get(key);
        }
    
        /** * 普通缓存放入 * * @param key 键 * @param value 值 * @return true成功 false失败 */
        public boolean set(String key, Object value) { 
            try { 
                redisTemplate.opsForValue().set(key, value);
                return true;
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return false;
            }
    
        }
    
        /** * 普通缓存放入并设置时间 * * @param key 键 * @param value 值 * @param time 时间(秒) time要大于0 如果time小于等于0 将设置无限期 * @return true成功 false 失败 */
        public boolean set(String key, Object value, long time) { 
            try { 
                if (time > 0) { 
                    redisTemplate.opsForValue().set(key, value, time, TimeUnit.SECONDS);
                } else { 
                    set(key, value);
                }
                return true;
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return false;
            }
        }
    
        /** * 递增 * * @param key 键 * @param by 要增加几(大于0) * @return */
        public long incr(String key, long delta) { 
            if (delta < 0) { 
                throw new RuntimeException("递增因子必须大于0");
            }
            return redisTemplate.opsForValue().increment(key, delta);
        }
    
        /** * 递减 * * @param key 键 * @param by 要减少几(小于0) * @return */
        public long decr(String key, long delta) { 
            if (delta < 0) { 
                throw new RuntimeException("递减因子必须大于0");
            }
            return redisTemplate.opsForValue().increment(key, -delta);
        }
    
        // ================================Map=================================
    
        /** * 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 对应多个键值 * @return true 成功 false 失败 */
        public boolean hmset(String key, Map<String, Object> map) { 
            try { 
                redisTemplate.opsForHash().putAll(key, map);
                return true;
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return false;
            }
        }
    
        /** * HashSet 并设置时间 * * @param key 键 * @param map 对应多个键值 * @param time 时间(秒) * @return true成功 false失败 */
        public boolean hmset(String key, Map<String, Object> map, long time) { 
            try { 
                redisTemplate.opsForHash().putAll(key, map);
                if (time > 0) { 
                    expire(key, time);
                }
                return true;
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return false;
            }
        }
    
        /** * 向一张hash表中放入数据,如果不存在将创建 * * @param key 键 * @param item 项 * @param value 值 * @return true 成功 false失败 */
        public boolean hset(String key, String item, Object value) { 
            try { 
                redisTemplate.opsForHash().put(key, item, value);
                return true;
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return false;
            }
        }
    
        /** * 向一张hash表中放入数据,如果不存在将创建 * * @param key 键 * @param item 项 * @param value 值 * @param time 时间(秒) 注意:如果已存在的hash表有时间,这里将会替换原有的时间 * @return true 成功 false失败 */
        public boolean hset(String key, String item, Object value, long time) { 
            try { 
                redisTemplate.opsForHash().put(key, item, value);
                if (time > 0) { 
                    expire(key, time);
                }
                return true;
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return false;
            }
        }
    
        /** * 删除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 hHasKey(String key, String item) { 
            return redisTemplate.opsForHash().hasKey(key, item);
        }
    
        /** * hash递增 如果不存在,就会创建一个 并把新增后的值返回 * * @param key 键 * @param item 项 * @param by 要增加几(大于0) * @return */
        public double hincr(String key, String item, double by) { 
            return redisTemplate.opsForHash().increment(key, item, by);
        }
    
        /** * hash递减 * * @param key 键 * @param item 项 * @param by 要减少记(小于0) * @return */
        public double hdecr(String key, String item, double by) { 
            return redisTemplate.opsForHash().increment(key, item, -by);
        }
    
        // ============================set=============================
    
        /** * 根据key获取Set中的所有值 * * @param key 键 * @return */
        public Set<Object> sGet(String key) { 
            try { 
                return redisTemplate.opsForSet().members(key);
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return null;
            }
        }
    
        /** * 根据value从一个set中查询,是否存在 * * @param key 键 * @param value 值 * @return true 存在 false不存在 */
        public boolean sHasKey(String key, Object value) { 
            try { 
                return redisTemplate.opsForSet().isMember(key, value);
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return false;
            }
        }
    
        /** * 将数据放入set缓存 * * @param key 键 * @param values 值 可以是多个 * @return 成功个数 */
        public long sSet(String key, Object... values) { 
            try { 
                return redisTemplate.opsForSet().add(key, values);
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return 0;
            }
        }
    
        /** * 将set数据放入缓存 * * @param key 键 * @param time 时间(秒) * @param values 值 可以是多个 * @return 成功个数 */
        public long sSetAndTime(String key, long time, Object... values) { 
            try { 
                Long count = redisTemplate.opsForSet().add(key, values);
                if (time > 0)
                    expire(key, time);
                return count;
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return 0;
            }
        }
    
        /** * 获取set缓存的长度 * * @param key 键 * @return */
        public long sGetSetSize(String key) { 
            try { 
                return redisTemplate.opsForSet().size(key);
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return 0;
            }
        }
    
        /** * 移除值为value的 * * @param key 键 * @param values 值 可以是多个 * @return 移除的个数 */
        public long setRemove(String key, Object... values) { 
            try { 
                Long count = redisTemplate.opsForSet().remove(key, values);
                return count;
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return 0;
            }
        }
        // ===============================list=================================
    
        /** * 获取list缓存的内容 * * @param key 键 * @param start 开始 * @param end 结束 0 到 -1代表所有值 * @return */
        public List<Object> lGet(String key, long start, long end) { 
            try { 
                return redisTemplate.opsForList().range(key, start, end);
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return null;
            }
        }
    
        /** * 获取list缓存的长度 * * @param key 键 * @return */
        public long lGetListSize(String key) { 
            try { 
                return redisTemplate.opsForList().size(key);
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return 0;
            }
        }
    
        /** * 通过索引 获取list中的值 * * @param key 键 * @param index 索引 index>=0时， 0 表头，1 第二个元素，依次类推；index<0时，-1，表尾，-2倒数第二个元素，依次类推 * @return */
        public Object lGetIndex(String key, long index) { 
            try { 
                return redisTemplate.opsForList().index(key, index);
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return null;
            }
        }
    
        /** * 将list放入缓存 * * @param key 键 * @param value 值 * @param time 时间(秒) * @return */
        public boolean lSet(String key, Object value) { 
            try { 
                redisTemplate.opsForList().rightPush(key, value);
                return true;
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return false;
            }
        }
    
        /** * 将list放入缓存 * * @param key 键 * @param value 值 * @param time 时间(秒) * @return */
        public boolean lSet(String key, Object value, long time) { 
            try { 
                redisTemplate.opsForList().rightPush(key, value);
                if (time > 0)
                    expire(key, time);
                return true;
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return false;
            }
        }
    
        /** * 将list放入缓存 * * @param key 键 * @param value 值 * @param time 时间(秒) * @return */
        public boolean lSet(String key, List<Object> value) { 
            try { 
                redisTemplate.opsForList().rightPushAll(key, value);
                return true;
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return false;
            }
        }
    
        /** * 将list放入缓存 * * @param key 键 * @param value 值 * @param time 时间(秒) * @return */
        public boolean lSet(String key, List<Object> value, long time) { 
            try { 
                redisTemplate.opsForList().rightPushAll(key, value);
                if (time > 0)
                    expire(key, time);
                return true;
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return false;
            }
        }
    
        /** * 根据索引修改list中的某条数据 * * @param key 键 * @param index 索引 * @param value 值 * @return */
        public boolean lUpdateIndex(String key, long index, Object value) { 
            try { 
                redisTemplate.opsForList().set(key, index, value);
                return true;
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return false;
            }
        }
    
        /** * 移除N个值为value * * @param key 键 * @param count 移除多少个 * @param value 值 * @return 移除的个数 */
        public long lRemove(String key, long count, Object value) { 
            try { 
                Long remove = redisTemplate.opsForList().remove(key, count, value);
                return remove;
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return 0;
            }
        }
        
        // ===============================sorted set=================================
    
        /** * 向有序集合添加一个成员的 * * ZADD key score1 member1 [score2 member2] * */
        public boolean zadd(String key, Object member, double score, long time) { 
            try { 
                redisTemplate.opsForZSet().add(key, member, score);
                if (time > 0)
                    expire(key, time);
                return true;
            } catch (Exception e) { 
                log.error("redis error: ", e);
                return false;
            }
        }
        
        /** * ZRANGEBYSCORE key min max [WITHSCORES] [LIMIT] 通过分数返回有序集合指定区间内的成员 * */
        public Set<Object> zRangeByScore(String key, double minScore, double maxScore) { 
        	try { 
        		return redisTemplate.opsForZSet().rangeByScore(key, minScore, maxScore);
        	} catch (Exception e) { 
        		log.error("redis error: ", e);
        		return null;
        	}
        }
        
        /** * ZSCORE key member 返回有序集中，成员的分数值 * */
        public Double zscore(String key, Object member) { 
        	try { 
        		return redisTemplate.opsForZSet().score(key, member);
        	} catch (Exception e) { 
        		log.error("redis error: ", e);
        		return null;
        	}
        }
        
        /** * ZRANK key member 返回有序集合中指定成员的索引 * */
        public Long zrank(String key, Object member) { 
        	try { 
        		return redisTemplate.opsForZSet().rank(key, member);
        	} catch (Exception e) { 
        		log.error("redis error: ", e);
        		return null;
        	}
        }
        
        /** * Zscan 迭代有序集合中的元素（包括元素成员和元素分值） * */
        public Cursor<ZSetOperations.TypedTuple<Object>> zscan(String key) { 
        	try { 
        		Cursor<ZSetOperations.TypedTuple<Object>> cursor = redisTemplate.opsForZSet().scan(key, ScanOptions.NONE);
        		return cursor;
        	} catch (Exception e) { 
        		log.error("redis error: ", e);
        		return null;
        	}
        }
    }

详细完整代码，可以在[Spring组件化构建][Spring 1]中选择查看，并下载。

### 快速构建项目 ###

[Spring组件化构建][Spring 1]

喜欢这篇文章么，喜欢就加入我们一起讨论Spring技术吧！  
![品茗IT交流群][IT 1]

[Spring]: https://docs.spring.io/spring/docs/5.0.12.RELEASE/spring-framework-reference/core.html#spring-core
[Spring Redis]: http://spring.io/projects/spring-data-redis
[https_redis.io_download]: https://redis.io/download
[Gitee]: https://gitee.com/ffch/springwork/tree/master/springwork-redis
[IT-]: https://www.pomit.cn/p/178577835077888
[IT]: https://www.pomit.cn
[Spring 1]: https://www.pomit.cn/java/spring/spring.html
[SpringBoot]: https://www.pomit.cn/java/spring/springboot.html
[SpringCloud]: https://www.pomit.cn/java/spring/springcloud.html
[Springboot]: https://www.pomit.cn/java/java/sqlToSpringboot.html
[java]: https://jq.qq.com/?_wv=1027&k=52sgH1J
[IT 1]: /images/20220319/c09e0ecd79424f928df01ace0a4ebc61.png