SpringBoot入门建站全系列（十四）集成Redis缓存

谁借莪１个温暖的怀抱￠ 2021-12-18 05:29 265阅读 0赞

## SpringBoot入门建站全系列（十四）集成Redis缓存 ##

#### 一、概述 ####

本地缓存，就是使用应用内使用本地内存将数据暂缓存储，一般数据库的查询如果不怎么改动，可以用本地缓存暂存。

远程缓存，比如redis，就是第三方缓存服务器，不是在当前应用的，需要用过tcp请求去获得的缓存。

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

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

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

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

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

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

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

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

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

[Mysql一键生成Mybatis注解Mapper][Mysql_Mybatis_Mapper]

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

### 二、配置 ###

本文假设你已经引入spring-boot-starter-web。已经是个SpringBoot项目了,如果不会搭建，可以打开这篇文章看一看[《SpringBoot入门建站全系列（一）项目建立》][SpringBoot 1]。

#### 2.1 Maven依赖 ####

这里要访问数据库进行缓存，所以要依赖数据库相关jar包，同时要依赖ehcache。

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

不配置commons-pool2，启动可能会报错，如果你引入了数据源相关jar包，这个jar包一般都会被引入的。

#### 2.2 配置文件 ####

在application.properties 中需要添加下面的配置：

spring.redis.database=0
    spring.redis.host=192.168.0.49
    spring.redis.port=6379
    spring.redis.password=test|test
    spring.redis.lettuce.pool.max-active=10
    spring.redis.lettuce.pool.max-wait=1000
    spring.redis.lettuce.pool.max-idle=8
    spring.redis.lettuce.pool.min-idle=5
    spring.redis.timeout=1000

这里的redis指定了使用lettuce做redis的连接池，也可以使用jedis。

lettuce和jedis的区别是，lettuce更屌一点，支持pipeline，但是如果你的redis不支持pipeline，还是用jedis吧，以免被坑。

### 2.3 替换lettuce，使用jedis ###

maven依赖修改：

<dependency>
    	<groupId>org.springframework.boot</groupId>
    	<artifactId>spring-boot-starter-data-redis</artifactId>
    	<exclusions>
    		<exclusion>
    			<groupId>io.lettuce</groupId>
    			<artifactId>lettuce-core</artifactId>
    		</exclusion>
    	</exclusions>
    </dependency>
    <dependency>
    	<groupId>redis.clients</groupId>
    	<artifactId>jedis</artifactId>
    </dependency>
    <dependency>
    	<groupId>org.apache.commons</groupId>
    	<artifactId>commons-pool2</artifactId>
    </dependency>

配置文件修改：

spring.redis.database=0
    spring.redis.host=192.168.0.49
    spring.redis.port=6379
    spring.redis.password=test|test
    spring.redis.jedis.pool.max-active=10
    spring.redis.jedis.pool.max-wait=1000
    spring.redis.jedis.pool.max-idle=8
    spring.redis.jedis.pool.min-idle=5
    spring.redis.timeout=1000

### 三、Redis配置 ###

配置RedisTemplate，以请求远程redis。

package com.cff.springbootwork.redis;
    
    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.serializer.RedisSerializer;
    import org.springframework.data.redis.serializer.StringRedisSerializer;
    
    @Configuration
    public class RedisConfig { 
    
        @Bean
        public RedisTemplate<String, String> redisTemplate(RedisConnectionFactory factory) { 
            RedisTemplate<String, String> redisTemplate = new RedisTemplate<String, String>();
            redisTemplate.setConnectionFactory(factory);   // key序列化方式;（不然会出现乱码;）,但是如果方法上有Long等非String类型的话，会报类型转换错误； // 所以在没有自己定义key生成策略的时候，以下这个代码建议不要这么写，可以不配置或者自己实现ObjectRedisSerializer // 或者JdkSerializationRedisSerializer序列化方式;
            RedisSerializer<String> redisSerializer =  new StringRedisSerializer();  // Long类型不可以会出现异常信息;
            redisTemplate.setKeySerializer(redisSerializer);
            redisTemplate.setHashKeySerializer(redisSerializer);
            return redisTemplate;
        }
    }

以上的Serializer，是配置redis的key的序列化和反序列化策略。这里用StringRedisSerializer就是把key当成一个字符串来序列化。

### 四、Redis请求大全 ###

下面的RedisService基本上涵盖了redis的所有操作：

RedisService：

package com.cff.springbootwork.redis;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.data.redis.core.RedisTemplate;
    import org.springframework.stereotype.Service;
    import org.springframework.util.CollectionUtils;
    
    import java.util.List;
    import java.util.Map;
    import java.util.Set;
    import java.util.concurrent.TimeUnit;
    
    @Service
    public class RedisService { 
    
    	@Autowired
    	private 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) { 
    			e.printStackTrace();
    			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) { 
    			e.printStackTrace();
    			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) { 
    			e.printStackTrace();
    			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) { 
    			e.printStackTrace();
    			return false;
    		}
    	}
    
    	/** * 递增 * * @param key * 键 * @return */
    	public long incr(String key, long delta) { 
    		if (delta < 0) { 
    			throw new RuntimeException("递增因子必须大于0");
    		}
    		return redisTemplate.opsForValue().increment(key, delta);
    	}
    
    	/** * 递减 * * @param key * 键 * @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) { 
    			e.printStackTrace();
    			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) { 
    			e.printStackTrace();
    			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) { 
    			e.printStackTrace();
    			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) { 
    			e.printStackTrace();
    			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) { 
    			e.printStackTrace();
    			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) { 
    			e.printStackTrace();
    			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) { 
    			e.printStackTrace();
    			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) { 
    			e.printStackTrace();
    			return 0;
    		}
    	}
    
    	/** * 获取set缓存的长度 * * @param key * 键 * @return */
    	public long sGetSetSize(String key) { 
    		try { 
    			return redisTemplate.opsForSet().size(key);
    		} catch (Exception e) { 
    			e.printStackTrace();
    			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) { 
    			e.printStackTrace();
    			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) { 
    			e.printStackTrace();
    			return null;
    		}
    	}
    
    	/** * 获取list缓存的长度 * * @param key * 键 * @return */
    	public long lGetListSize(String key) { 
    		try { 
    			return redisTemplate.opsForList().size(key);
    		} catch (Exception e) { 
    			e.printStackTrace();
    			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) { 
    			e.printStackTrace();
    			return null;
    		}
    	}
    
    	/** * 将list放入缓存 * * @param key * 键 * @param value * 值 * @return */
    	public boolean lSet(String key, Object value) { 
    		try { 
    			redisTemplate.opsForList().rightPush(key, value);
    			return true;
    		} catch (Exception e) { 
    			e.printStackTrace();
    			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) { 
    			e.printStackTrace();
    			return false;
    		}
    	}
    
    	/** * 将list放入缓存 * * @param key * 键 * @param value * 值 * @return */
    	public boolean lSet(String key, List<Object> value) { 
    		try { 
    			redisTemplate.opsForList().rightPushAll(key, value);
    			return true;
    		} catch (Exception e) { 
    			e.printStackTrace();
    			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) { 
    			e.printStackTrace();
    			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) { 
    			e.printStackTrace();
    			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) { 
    			e.printStackTrace();
    			return 0;
    		}
    	}
    }

### 五、测试 ###

写一个简单的get/set测试下redis：

RedisRest ：

详细完整的代码，可以访问[品茗IT-博客《SpringBoot入门建站全系列（十四）集成Redis缓存》][IT-]进行查看

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

[Spring组件化构建][Spring]

[SpringBoot组件化构建][SpringBoot]

[SpringCloud服务化构建][SpringCloud]

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

[https_redis.io_download]: https://redis.io/download
[IT-]: https://www.pomit.cn/p/193860461699328
[IT]: https://www.pomit.cn
[Spring]: 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
[Mysql_Mybatis_Mapper]: https://www.pomit.cn/java/java/sqlToMybatis.html
[java]: https://jq.qq.com/?_wv=1027&k=52sgH1J
[SpringBoot 1]: https://www.pomit.cn/p/169774771175680
[IT 1]: /images/20211218/cc2614ccb7fe499c9f5a54bd4d6cc3e6.png