springboot 整合redis 操作
修改xml配置文件 pom.xml
在pom.xml文件中新增maven依赖如图
<!--redis--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> </dependency>
修改配置文件application.yml 文件
具体配置内容如下:
spring: #redis配置信息 redis: #redis 服务器地址 hostName: redis.confedu.com #redis端口 port: 6379 #redis 密码 password: 123456 #客户端超时时间单位是毫秒 默认是2000 timeout: 5000 #最大空闲数 maxIdle: 20 #连接池的最大数据库连接数 maxActive: -1 #控制一个pool可分配多少个jedis实例,用来替换上面的maxActive maxTotal: 100 #最大建立连接等待时间。如果超过此时间将接到异常 maxWaitMillis: 100 #连接的最小空闲时间 minEvictableIdleTimeMillis: 864000000 #每次释放连接的最大数目 numTestsPerEvictionRun: 10 #逐出扫描的时间间隔(毫秒) 如果为负数,则不运行逐出线程 timeBetweenEvictionRunsMillis: 300000 #是否在从池中取出连接前进行检验,如果检验失败,则从池中去除连接并尝试取出另一个 testOnBorrow: true #在空闲时检查有效性 testWhileIdle: false #数据库 database: 0
增加RedisConfig.java配置类
package com.example.framework.config; import com.fasterxml.jackson.annotation.JsonAutoDetect; import com.fasterxml.jackson.annotation.PropertyAccessor; import com.fasterxml.jackson.databind.ObjectMapper; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.data.redis.cache.RedisCacheManager; import org.springframework.data.redis.connection.RedisConnectionFactory; import org.springframework.data.redis.connection.RedisStandaloneConfiguration; import org.springframework.data.redis.connection.jedis.JedisClientConfiguration; import org.springframework.data.redis.connection.jedis.JedisConnectionFactory; import org.springframework.data.redis.core.RedisTemplate; import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer; import org.springframework.data.redis.serializer.RedisSerializer; import org.springframework.data.redis.serializer.StringRedisSerializer; import redis.clients.jedis.JedisPoolConfig; import java.nio.charset.Charset; /** * redis 配置类 * @author: example * @create: 2019/5/31 */ @Configuration public class RedisConfig { @Autowired private MyStringSerializer myStringSerializer; @Value("${spring.redis.hostName}") private String hostName; @Value("${spring.redis.port}") private Integer port; @Value("${spring.redis.password}") private String password; @Value("${spring.redis.timeout}") private Integer timeout; @Value("${spring.redis.maxIdle}") private Integer maxIdle; @Value("${spring.redis.maxActive}") private String maxActive; @Value("${spring.redis.maxTotal}") private Integer maxTotal; @Value("${spring.redis.maxWaitMillis}") private Long maxWaitMillis; @Value("${spring.redis.minEvictableIdleTimeMillis}") private Long minEvictableIdleTimeMillis; @Value("${spring.redis.numTestsPerEvictionRun}") private Integer numTestsPerEvictionRun; @Value("${spring.redis.timeBetweenEvictionRunsMillis}") private Long timeBetweenEvictionRunsMillis; @Value("${spring.redis.testOnBorrow}") private boolean testOnBorrow; @Value("${spring.redis.testWhileIdle}") private boolean testWhileIdle; @Value("${spring.redis.database}") private Integer database; /** * JedisPoolConfig 连接池 * @return */ @Bean public JedisPoolConfig jedisPoolConfig() { JedisPoolConfig jedisPoolConfig = new JedisPoolConfig(); // 最大空闲数 jedisPoolConfig.setMaxIdle(maxIdle); // 连接池的最大数据库连接数 jedisPoolConfig.setMaxTotal(maxTotal); // 最大建立连接等待时间 jedisPoolConfig.setMaxWaitMillis(maxWaitMillis); // 逐出连接的最小空闲时间 默认1800000毫秒(30分钟) jedisPoolConfig.setMinEvictableIdleTimeMillis(minEvictableIdleTimeMillis); // 每次逐出检查时 逐出的最大数目 如果为负数就是 : 1/abs(n), 默认3 jedisPoolConfig.setNumTestsPerEvictionRun(numTestsPerEvictionRun); // 逐出扫描的时间间隔(毫秒) 如果为负数,则不运行逐出线程, 默认-1 jedisPoolConfig.setTimeBetweenEvictionRunsMillis(timeBetweenEvictionRunsMillis); // 是否在从池中取出连接前进行检验,如果检验失败,则从池中去除连接并尝试取出另一个 jedisPoolConfig.setTestOnBorrow(testOnBorrow); // 在空闲时检查有效性, 默认false jedisPoolConfig.setTestWhileIdle(testWhileIdle); return jedisPoolConfig; } /** * jedis连接工厂 * @param jedisPoolConfig * @return */ @Bean public RedisConnectionFactory redisConnectionFactory(JedisPoolConfig jedisPoolConfig) { RedisStandaloneConfiguration redisStandaloneConfiguration = new RedisStandaloneConfiguration(); //设置redis服务器的host或者ip地址 redisStandaloneConfiguration.setHostName(hostName); redisStandaloneConfiguration.setPort(port); redisStandaloneConfiguration.setPassword(password); redisStandaloneConfiguration.setDatabase(database); //获得默认的连接池构造 //这里需要注意的是,edisConnectionFactoryJ对于Standalone模式的没有(RedisStandaloneConfiguration,JedisPoolConfig)的构造函数,对此 //我们用JedisClientConfiguration接口的builder方法实例化一个构造器,还得类型转换 JedisClientConfiguration.JedisPoolingClientConfigurationBuilder jpcf = (JedisClientConfiguration.JedisPoolingClientConfigurationBuilder) JedisClientConfiguration.builder(); //修改我们的连接池配置 jpcf.poolConfig(jedisPoolConfig); //通过构造器来构造jedis客户端配置 JedisClientConfiguration jedisClientConfiguration = jpcf.build(); return new JedisConnectionFactory(redisStandaloneConfiguration, jedisClientConfiguration); } @Bean public RedisCacheManager cacheManager(RedisConnectionFactory connectionFactory){ return RedisCacheManager.create(connectionFactory); } /** * 实例化 RedisTemplate * @param redisConnectionFactory * @return */ @Bean(name = "redisTemplate") public RedisTemplate<String, Object> functionDomainRedisTemplate(RedisConnectionFactory redisConnectionFactory) { RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>(); redisTemplate.setConnectionFactory(redisConnectionFactory); // 使用Jackson2JsonRedisSerialize 替换默认序列化 Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class); ObjectMapper objectMapper = new ObjectMapper(); objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY); objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL); jackson2JsonRedisSerializer.setObjectMapper(objectMapper); //设置value的序列化规则和 key的序列化规则 RedisSerializer stringSerializer = new StringRedisSerializer(Charset.forName("UTF8")); redisTemplate.setKeySerializer(stringSerializer ); redisTemplate.setValueSerializer(jackson2JsonRedisSerializer); redisTemplate.setHashKeySerializer(stringSerializer ); redisTemplate.setHashValueSerializer(jackson2JsonRedisSerializer); redisTemplate.afterPropertiesSet(); return redisTemplate; } }
创建RedisUtils.java工具类
package com.example.framework.util; import com.example.common.utils.spring.SpringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.data.redis.core.RedisTemplate; import org.springframework.util.CollectionUtils; import java.util.List; import java.util.Map; import java.util.Set; import java.util.concurrent.TimeUnit; /** * redis 工具类 * @author: example * @create: 2019/5/31 */ public class RedisUtils { /** * 日志对象 */ private static Logger logger = LoggerFactory.getLogger(RedisUtils.class); /** * The constant RUN_MESSAGE. */ private static RedisTemplate redisTemplate = SpringUtils.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) { logger.error("RedisUtils expire(String key,long time) failure."+e.getMessage()); 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) { logger.error("RedisUtils hasKey(String key) failure."+e.getMessage()); 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) { logger.error("RedisUtils set(String key,Object value) failure."+e.getMessage()); 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) { logger.error("RedisUtils set(String key,Object value,long time) failure."+e.getMessage()); 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) { logger.error("RedisUtils hmset(String key, Map<String,Object> map) failure."+e.getMessage()); 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) { logger.error("RedisUtils hmset(String key, Map<String,Object> map, long time) failure."+e.getMessage()); 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) { logger.error("RedisUtils hset(String key,String item,Object value) failure."+e.getMessage()); 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) { logger.error("RedisUtils hset(String key,String item,Object value,long time) failure."+e.getMessage()); 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) { logger.error("RedisUtils sGet(String key) failure."+e.getMessage()); 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) { logger.error("RedisUtils sHasKey(String key,Object value) failure."+e.getMessage()); 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) { logger.error("RedisUtils sSet(String key, Object...values) failure."+e.getMessage()); 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) { logger.error("RedisUtils sSetAndTime(String key,long time,Object...values) failure."+e.getMessage()); return 0; } } /** * 获取set缓存的长度 * @param key 键 * @return */ public static long sGetSetSize(String key){ try { return redisTemplate.opsForSet().size(key); } catch (Exception e) { logger.error("RedisUtils sGetSetSize(String key) failure."+e.getMessage()); 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) { logger.error("RedisUtils setRemove(String key, Object ...values) failure."+e.getMessage()); 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) { logger.error("RedisUtils lGet(String key, long start, long end) failure."+e.getMessage()); return null; } } /** * 获取list缓存的长度 * @param key 键 * @return */ public static long lGetListSize(String key){ try { return redisTemplate.opsForList().size(key); } catch (Exception e) { logger.error("RedisUtils lGetListSize(String key) failure."+e.getMessage()); 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) { logger.error("RedisUtils lGetIndex(String key,long index) failure."+e.getMessage()); 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) { logger.error("RedisUtils lSet(String key, Object value) failure."+e.getMessage()); 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) { logger.error("RedisUtils lSet(String key, Object value, long time) failure."+e.getMessage()); 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) { logger.error("RedisUtils lSet(String key, List<Object> value) failure."+e.getMessage()); 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) { logger.error("RedisUtils lSet(String key, List<Object> value, long time) failure."+e.getMessage()); 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) { logger.error("RedisUtils lUpdateIndex(String key, long index,Object value) failure."+e.getMessage()); 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) { logger.error("RedisUtils lRemove(String key,long count,Object value) failure."+e.getMessage()); return 0; } } }
注:欢迎指正