赞
踩
目录
本篇主要讲解springboot集成redis的使用方式,工具类的封装及使用。
- <!-- 加入redis的处理 -->
- <dependency>
- <groupId>org.springframework.boot</groupId>
- <artifactId>spring-boot-starter-data-redis</artifactId>
- </dependency>
- <!-- lettuce pool 缓存连接池 -->
- <dependency>
- <groupId>org.apache.commons</groupId>
- <artifactId>commons-pool2</artifactId>
- </dependency>
如果没有引用commons-pool2依赖
项目启动控制台报错:org.apache.commons.pool2.impl.GenericObjectPoolConfig
- Caused by: java.lang.ClassNotFoundException: org.apache.commons.pool2.impl.GenericObjectPoolConfig
- at java.base/jdk.internal.loader.BuiltinClassLoader.loadClass(BuiltinClassLoader.java:641) ~[na:na]
- at java.base/jdk.internal.loader.ClassLoaders$AppClassLoader.loadClass(ClassLoaders.java:188) ~[na:na]
- at java.base/java.lang.ClassLoader.loadClass(ClassLoader.java:521) ~[na:na]
- ... 58 common frames omitted
- # Redis服务器地址
- spring.redis.host=127.0.0.1
- # Redis服务器连接端口
- spring.redis.port=6379
- # Redis服务器连接密码(默认为空)
- #spring.redis.password=redis
- # Redis数据库索引(默认为0)
- spring.redis.database=0
- # 连接超时时间(毫秒)
- spring.redis.timeout=10000
- # Redis默认情况下有16个分片,这里配置具体使用的分片,默认是0
- spring.redis.database=0
- # 连接池最大连接数(使用负值表示没有限制) 默认 8
- spring.redis.lettuce.pool.max-active=8
- # 连接池最大阻塞等待时间(使用负值表示没有限制) 默认 -1
- spring.redis.lettuce.pool.max-wait=-1
- # 连接池中的最大空闲连接 默认 8
- spring.redis.lettuce.pool.max-idle=8
- # 连接池中的最小空闲连接 默认 0
- spring.redis.lettuce.pool.min-idle=0
配置项中指定了数据库索引:
# Redis数据库索引(默认为0)
spring.redis.database=0
redis有十六个库,相当于一个数据库的中的十六张表,可以用来数据分类,或者不同测试环境数据区分。
- import org.springframework.data.redis.core.RedisTemplate;
- import org.springframework.web.bind.annotation.RequestMapping;
- import org.springframework.web.bind.annotation.RestController;
-
- import javax.annotation.Resource;
-
- /**
- * @ClassName: DataController
- * @Description redis链接测试
- * @author 月夜烛峰
- * @date 2022/9/5 19:40
- */
- @RestController
- @RequestMapping("data")
- public class DataController {
-
- @Resource
- RedisTemplate<String, Object> redisTemplate;
-
- @RequestMapping("redis")
- public Object showRedis(){
- redisTemplate.opsForValue().set("zhufeng-test", "测试");
- return redisTemplate.opsForValue().get("zhufeng-test");
- }
- }
@Resource
RedisTemplate<String, Object> redisTemplate;
完成配置后,在项目启动时,会完成redis的自动装配,springboot可以获取到redisTemplate。
springboot自动装配的原理可参考:
《深入理解springboot的自动配置「源码分析/图文详解」》
启动项目,访问http://127.0.0.1:8080/data/redis
通过redis客户端进入查看:
代码中添加的key是 zhufeng-test,好像有些出入。
RedisTemplate设置redis的key时出现\xac\xed\x00\x05t\x00\x0f前缀
出现这种乱码前缀的原因是没有进行序列化,因此导致在传输过程出现乱码问题。
RedisTemplate类中默认是没有设置序列化的。
- import com.fasterxml.jackson.annotation.JsonAutoDetect;
- import com.fasterxml.jackson.annotation.PropertyAccessor;
- import com.fasterxml.jackson.databind.ObjectMapper;
- import org.springframework.cache.annotation.CachingConfigurerSupport;
- 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.Jackson2JsonRedisSerializer;
- import org.springframework.data.redis.serializer.StringRedisSerializer;
-
- /**
- * @ClassName: RedisConfig
- * @Description redis序列化配置
- * @author 月夜烛峰
- * @date 2022/9/13 18:47
- */
- @Configuration
- public class RedisConfig extends CachingConfigurerSupport {
-
- /**
- * 重新定义redisTemplate序列化方式
- * @param factory
- * @return
- */
- @Bean
- public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory factory) {
- RedisTemplate<Object, Object> template = new RedisTemplate<Object, Object>();
- template.setConnectionFactory(factory);
- Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<Object>(Object.class);
- ObjectMapper om = new ObjectMapper();
- om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
- jackson2JsonRedisSerializer.setObjectMapper(om);
- StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();
- // key采用String的序列化方式
- template.setKeySerializer(stringRedisSerializer);
- // hash的key也采用String的序列化方式
- template.setHashKeySerializer(stringRedisSerializer);
- // value序列化方式采用jackson
- template.setValueSerializer(jackson2JsonRedisSerializer);
- // hash的value序列化方式采用jackson
- template.setHashValueSerializer(jackson2JsonRedisSerializer);
- template.afterPropertiesSet();
- return template;
- }
- }
重新运行项目:
变化:
key和value都没有了前缀
key通过String格式进行序列化,显示正常。
value通过jackson方式序列化,显示序列化后结果。
value也可以不做序列化处理,但容易出现安全隐患,例如:信息泄露。
在使用过程中,有时候使用RedisTemplate不是很方便,尤其是一些静态方法,所以可以把RedisTemplate进行改造,封装到静态工具类中。
- import java.util.HashSet;
- import java.util.List;
- import java.util.Map;
- import java.util.Set;
- import java.util.concurrent.TimeUnit;
- import lombok.extern.slf4j.Slf4j;
- import org.springframework.dao.DataAccessException;
- import org.springframework.data.redis.connection.RedisConnection;
- import org.springframework.data.redis.core.Cursor;
- import org.springframework.data.redis.core.RedisCallback;
- import org.springframework.data.redis.core.RedisTemplate;
- import org.springframework.data.redis.core.ScanOptions;
- import org.springframework.util.CollectionUtils;
-
- /**
- * @ClassName: ZFRedisUtil
- * @Description redis工具类
- * @author 月夜烛峰
- * @date 2022/9/14 11:15
- */
- @Slf4j
- public class ZFRedisUtil {
-
- private static RedisTemplate<String, Object> redisTemplate = (RedisTemplate<String, Object>)SpringContextUtil.getBean("redisTemplate");
-
- /**
- * 指定缓存失效时间
- * @param key 键
- * @param time 时间(秒)
- * @return
- */
- public static boolean expire(String key,long time){
- try {
- if(time>0){
- redisTemplate.expire(key, time, TimeUnit.SECONDS);
- }
- return true;
- } catch (Exception e) {
- log.error("RedisUtils expire(String key,long time) failure.",e);
- return false;
- }
- }
-
- /**
- * 根据key 获取过期时间
- * @param key 键 不能为null
- * @return 时间(秒) 返回0代表为永久有效
- */
- public static long getExpire(String key){
- return redisTemplate.getExpire(key,TimeUnit.SECONDS);
- }
-
- /**
- * 判断key是否存在
- * @param key 键
- * @return true 存在 false不存在
- */
- public static boolean hasKey(String key){
- try {
- return redisTemplate.hasKey(key);
- } catch (Exception e) {
- log.error("RedisUtils hasKey(String key) failure.",e);
- return false;
- }
- }
-
- /**
- * 删除缓存
- * @param key 可以传一个值 或多个
- */
- @SuppressWarnings("unchecked")
- public static void del(String ... key){
- if(key!=null&&key.length>0){
- if(key.length==1){
- redisTemplate.delete(key[0]);
- }else{
- redisTemplate.delete(CollectionUtils.arrayToList(key));
- }
- }
- }
-
- /**
- * 普通缓存获取
- * @param key 键
- * @return 值
- */
- public static Object get(String key){
- return key==null?null:redisTemplate.opsForValue().get(key);
- }
-
- /**
- * 普通缓存放入
- * @param key 键
- * @param value 值
- * @return true成功 false失败
- */
- public static boolean set(String key,Object value) {
- try {
- redisTemplate.opsForValue().set(key, value);
- return true;
- } catch (Exception e) {
- log.error("RedisUtils set(String key,Object value) failure.",e);
- return false;
- }
-
- }
-
- /**
- * 普通缓存放入并设置时间
- * @param key 键
- * @param value 值
- * @param time 时间(秒) time要大于0 如果time小于等于0 将设置无限期
- * @return true成功 false 失败
- */
- public static 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("RedisUtils set(String key,Object value,long time) failure.",e);
- return false;
- }
- }
-
- /**
- * 移除N个值为value
- * @param key 键
- * @return 移除的个数
- */
- public static boolean removeObj(String key) {
- try {
- return redisTemplate.delete(key);
- } catch (Exception e) {
- log.error("RedisUtils lRemove(String key,long count,Object value) failure.",e);
- return false;
- }
- }
-
- /**
- * 递增
- * @param key 键
- * @param delta
- * @return
- */
- public static long incr(String key, long delta){
- if(delta<0){
- throw new RuntimeException("递增因子必须大于0");
- }
- return redisTemplate.opsForValue().increment(key, delta);
- }
-
- /**
- * 递减
- * @param key 键
- * @param delta 要减少几(小于0)
- * @return
- */
- public static long decr(String key, long delta){
- if(delta<0){
- throw new RuntimeException("递减因子必须大于0");
- }
- return redisTemplate.opsForValue().increment(key, -delta);
- }
-
- /**
- * HashGet
- * @param key 键 不能为null
- * @param item 项 不能为null
- * @return 值
- */
- public static Object hget(String key,String item){
- return redisTemplate.opsForHash().get(key, item);
- }
-
- /**
- * 获取hashKey对应的所有键值
- * @param key 键
- * @return 对应的多个键值
- */
- public static Map<Object,Object> hmget(String key){
- return redisTemplate.opsForHash().entries(key);
- }
-
- /**
- * HashSet
- * @param key 键
- * @param map 对应多个键值
- * @return true 成功 false 失败
- */
- public static boolean hmset(String key, Map<String,Object> map){
- try {
- redisTemplate.opsForHash().putAll(key, map);
- return true;
- } catch (Exception e) {
- log.error("RedisUtils hmset(String key, Map<String,Object> map) failure.",e);
- return false;
- }
- }
-
- /**
- * HashSet 并设置时间
- * @param key 键
- * @param map 对应多个键值
- * @param time 时间(秒)
- * @return true成功 false失败
- */
- public static 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("RedisUtils hmset(String key, Map<String,Object> map, long time) failure.",e);
- return false;
- }
- }
-
- /**
- * 向一张hash表中放入数据,如果不存在将创建
- * @param key 键
- * @param item 项
- * @param value 值
- * @return true 成功 false失败
- */
- public static boolean hset(String key,String item,Object value) {
- try {
- redisTemplate.opsForHash().put(key, item, value);
- return true;
- } catch (Exception e) {
- log.error("RedisUtils hset(String key,String item,Object value) failure.",e);
- return false;
- }
- }
-
- /**
- * 向一张hash表中放入数据,如果不存在将创建
- * @param key 键
- * @param item 项
- * @param value 值
- * @param time 时间(秒) 注意:如果已存在的hash表有时间,这里将会替换原有的时间
- * @return true 成功 false失败
- */
- public static 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("RedisUtils hset(String key,String item,Object value,long time) failure.",e);
- return false;
- }
- }
-
- /**
- * 删除hash表中的值
- * @param key 键 不能为null
- * @param item 项 可以使多个 不能为null
- */
- public static void hdel(String key, Object... item){
- redisTemplate.opsForHash().delete(key,item);
- }
-
- /**
- * 判断hash表中是否有该项的值
- * @param key 键 不能为null
- * @param item 项 不能为null
- * @return true 存在 false不存在
- */
- public static boolean hHasKey(String key, String item){
- return redisTemplate.opsForHash().hasKey(key, item);
- }
-
- /**
- * hash递增 如果不存在,就会创建一个 并把新增后的值返回
- * @param key 键
- * @param item 项
- * @param by 要增加几(大于0)
- * @return
- */
- public static 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 static double hdecr(String key, String item,double by){
- return redisTemplate.opsForHash().increment(key, item,-by);
- }
-
- /**
- * 根据key获取Set中的所有值
- * @param key 键
- * @return
- */
- public static Set<Object> sGet(String key){
- try {
- return redisTemplate.opsForSet().members(key);
- } catch (Exception e) {
- log.error("RedisUtils sGet(String key) failure.",e);
- return null;
- }
- }
-
- /**
- * 根据value从一个set中查询,是否存在
- * @param key 键
- * @param value 值
- * @return true 存在 false不存在
- */
- public static boolean sHasKey(String key,Object value){
- try {
- return redisTemplate.opsForSet().isMember(key, value);
- } catch (Exception e) {
- log.error("RedisUtils sHasKey(String key,Object value) failure.",e);
- return false;
- }
- }
-
- /**
- * 将数据放入set缓存
- * @param key 键
- * @param values 值 可以是多个
- * @return 成功个数
- */
- public static long sSet(String key, Object...values) {
- try {
- return redisTemplate.opsForSet().add(key, values);
- } catch (Exception e) {
- log.error("RedisUtils sSet(String key, Object...values) failure.",e);
- return 0;
- }
- }
-
- /**
- * 将set数据放入缓存
- * @param key 键
- * @param time 时间(秒)
- * @param values 值 可以是多个
- * @return 成功个数
- */
- public static 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("RedisUtils sSetAndTime(String key,long time,Object...values) failure.",e);
- return 0;
- }
- }
-
- /**
- * 获取set缓存的长度
- * @param key 键
- * @return
- */
- public static long sGetSetSize(String key){
- try {
- return redisTemplate.opsForSet().size(key);
- } catch (Exception e) {
- log.error("RedisUtils sGetSetSize(String key) failure.",e);
- return 0;
- }
- }
-
- /**
- * 移除值为value的
- * @param key 键
- * @param values 值 可以是多个
- * @return 移除的个数
- */
- public static long setRemove(String key, Object ...values) {
- try {
- Long count = redisTemplate.opsForSet().remove(key, values);
- return count;
- } catch (Exception e) {
- log.error("RedisUtils setRemove(String key, Object ...values) failure.",e);
- return 0;
- }
- }
-
- /**
- * 获取list缓存的内容
- * @param key 键
- * @param start 开始
- * @param end 结束 0 到 -1代表所有值
- * @return
- */
- public static List<Object> lGet(String key, long start, long end){
- try {
- return redisTemplate.opsForList().range(key, start, end);
- } catch (Exception e) {
- log.error("RedisUtils lGet(String key, long start, long end) failure.",e);
- return null;
- }
- }
-
- /**
- * 获取list缓存的长度
- * @param key 键
- * @return
- */
- public static long lGetListSize(String key){
- try {
- return redisTemplate.opsForList().size(key);
- } catch (Exception e) {
- log.error("RedisUtils lGetListSize(String key) failure.",e);
- return 0;
- }
- }
-
- /**
- * 通过索引 获取list中的值
- * @param key 键
- * @param index 索引 index>=0时, 0 表头,1 第二个元素,依次类推;index<0时,-1,表尾,-2倒数第二个元素,依次类推
- * @return
- */
- public static Object lGetIndex(String key,long index){
- try {
- return redisTemplate.opsForList().index(key, index);
- } catch (Exception e) {
- log.error("RedisUtils lGetIndex(String key,long index) failure.",e);
- return null;
- }
- }
-
- /**
- * 将list放入缓存
- * @param key 键
- * @param value 值
- * @return
- */
- public static boolean lSet(String key, Object value) {
- try {
- redisTemplate.opsForList().rightPush(key, value);
- return true;
- } catch (Exception e) {
- log.error("RedisUtils lSet(String key, Object value) failure.",e);
- return false;
- }
- }
-
- /**
- * 将list放入缓存
- * @param key 键
- * @param value 值
- * @param time 时间(秒)
- * @return
- */
- public static 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("RedisUtils lSet(String key, Object value, long time) failure.",e);
- return false;
- }
- }
-
- /**
- * 将list放入缓存
- * @param key 键
- * @param value 值
- * @return
- */
- public static boolean lSet(String key, List<Object> value) {
- try {
- redisTemplate.opsForList().rightPushAll(key, value);
- return true;
- } catch (Exception e) {
- log.error("RedisUtils lSet(String key, List<Object> value) failure.",e);
- return false;
- }
- }
-
- /**
- * 将list放入缓存
- * @param key 键
- * @param value 值
- * @param time 时间(秒)
- * @return
- */
- public static 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("RedisUtils lSet(String key, List<Object> value, long time) failure.",e);
- return false;
- }
- }
-
- /**
- * 根据索引修改list中的某条数据
- * @param key 键
- * @param index 索引
- * @param value 值
- * @return
- */
- public static boolean lUpdateIndex(String key, long index,Object value) {
- try {
- redisTemplate.opsForList().set(key, index, value);
- return true;
- } catch (Exception e) {
- log.error("RedisUtils lUpdateIndex(String key, long index,Object value) failure.",e);
- return false;
- }
- }
-
- /**
- * 移除N个值为value
- * @param key 键
- * @param count 移除多少个
- * @param value 值
- * @return 移除的个数
- */
- public static long lRemove(String key,long count,Object value) {
- try {
- Long remove = redisTemplate.opsForList().remove(key, count, value);
- return remove;
- } catch (Exception e) {
- log.error("RedisUtils lRemove(String key,long count,Object value) failure.",e);
- return 0;
- }
- }
- /**
- * 使用scan命令 查询某些前缀的key
- * @param key
- * @return
- */
- public static Set<String> scan(String key){
- Set<String> execute = redisTemplate.execute(new RedisCallback<Set<String>>() {
-
- @Override
- public Set<String> doInRedis(RedisConnection connection) throws DataAccessException {
-
- Set<String> binaryKeys = new HashSet<>();
-
- Cursor<byte[]> cursor = connection.scan(new ScanOptions.ScanOptionsBuilder().match(key).count(1000).build());
- while (cursor.hasNext()) {
- binaryKeys.add(new String(cursor.next()));
- }
- return binaryKeys;
- }
- });
- return execute;
- }
-
- /**
- * 使用scan命令 查询某些前缀的key 有多少个
- * 用来获取当前session数量,也就是在线用户
- * @param key
- * @return
- */
- public static Long scanSize(String key){
- long dbSize = redisTemplate.execute(new RedisCallback<Long>() {
-
- @Override
- public Long doInRedis(RedisConnection connection) throws DataAccessException {
- long count = 0L;
- Cursor<byte[]> cursor = connection.scan(ScanOptions.scanOptions().match(key).count(1000).build());
- while (cursor.hasNext()) {
- cursor.next();
- count++;
- }
- return count;
- }
- });
- return dbSize;
- }
- }
-
获取spring上下文代码:
- package com.zhufeng.base.redis;
-
- import org.springframework.beans.BeansException;
- import org.springframework.context.ApplicationContext;
- import org.springframework.context.ApplicationContextAware;
- import org.springframework.stereotype.Component;
-
- /**
- * @ClassName: SpringContextUtil
- * @Description 获取spring上下文信息
- * @author 月夜烛峰
- * @date 2022/9/13 18:18
- */
- @Component
- public class SpringContextUtil implements ApplicationContextAware {
-
- private static ApplicationContext applicationContext = null;
-
- @Override
- public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
- if (SpringContextUtil.applicationContext == null) {
- SpringContextUtil.applicationContext = applicationContext;
- }
- }
-
-
- //获取applicationContext
- public static ApplicationContext getApplicationContext() {
- return applicationContext;
- }
-
- //通过name获取 Bean.
- public static Object getBean(String name) {
- return getApplicationContext().getBean(name);
- }
-
- //通过class获取Bean.
- public static <T> T getBean(Class<T> clazz) {
- return getApplicationContext().getBean(clazz);
- }
-
- //通过name,以及Clazz返回指定的Bean
- public static <T> T getBean(String name, Class<T> clazz) {
- return getApplicationContext().getBean(name, clazz);
-
- }
- }
测试:
- @RequestMapping("redis")
- public Object showRedis(){
- redisTemplate.opsForValue().set("zhufeng-test", "测试");
- //return redisTemplate.opsForValue().get("zhufeng-test");
- return ZFRedisUtil.get("zhufeng-test");
- }
可以正常获取value。
RedisTemplate使用起来虽然非常方便,但是在高并发场景下需要做一些性能优化,一般项目使用时,没什么问题。
Copyright © 2003-2013 www.wpsshop.cn 版权所有,并保留所有权利。