import org.springframework.beans.factory.annotation.Autowired
import org.springframework.beans.factory.annotation.Qualifier
import org.springframework.data.redis.core.RedisTemplate
import org.springframework.stereotype.Component
import org.springframework.util.CollectionUtils
import java.util.Collection
import java.util.List
import java.util.Map
import java.util.Set
import java.util.concurrent.TimeUnit
@Component
public final class RedisUtil {
@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){
return false
}
}
/*
根据key 获取过期时间
@param key 键 不能为null
@return 时间（秒）返回0代表永久有效
*/
public long getExpire(String key){
return redisTemplate.getExpire(key,TimeUnit.SECONDS)
}
/*
判断key 是否存在
@param key 键
@return ture 存在 false不存在
*/
public boolean hasKey(String key){
try {
return redisTemplate.hasKey(key)
}catch (Exception 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((Collection ) 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 turn 成功 false 失败
*/
public boolean set(String key,Object value){
try {
redisTemplate.opsForValue().set(key,value)
return true
}catch (Exception e){
return false
}
}
/*
普通缓存放入并设置时间
@param key 键
@param value 值
@param time 时间（秒） time要大于0 如果time小于0，将设置成无限制
@return turn 成功 false 失败
*/
public boolean set(String key,Object value,long time){
try {
if (time >0){
redisTemplate.opsForValue().set(key,value,time,TimeUnit.SECONDS)
}else {
redisTemplate.opsForValue().set(key,value)
}
return true
}catch (Exception e){
return false
}
}
/*
递增
@param key 键
@param delta 值 要增加几（大于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 delta 值 要减少几（大于0）
@return
*/
public long decr(String key,long delta){
if (delta <0){
throw new RuntimeException("递减因子必须大于0")
}
return redisTemplate.opsForValue().decrement(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 hmget(String key) {
return redisTemplate.opsForHash().entries(key)
}
/**
* HashSet
* @param key 键
* @param map 对应多个键值
* @return true 成功 false 失败
*/
public boolean hmset(String key, Map 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 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 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 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 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 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
}
}
}
不多说直接上代码：
<!-- redis -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
<exclusions>
<exclusion>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
</exclusion>
<exclusion>
<groupId>io.lettuce</groupId>
<artifactId>lettuce-core</artifactId>
</exclusion>
</exclusions>
</dependency>
<!-- 添加jedis客户端 -->
<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
</dependency>
<!--spring2.0集成redis所需common-pool2-->
<!-- 必须加上，jedis依赖此 -->
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-pool2</artifactId>
<version>2.5.0</version>
</dependency>
<!-- 将作为Redis对象序列化器 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.47</version>
</dependency>
#Matser的ip地址
redis.hostName=172.16.44.148
#端口号
redis.port=6379
#如果有密码
redis.password=
#客户端超时时间单位是毫秒 默认是2000
redis.timeout=10000
#最大空闲数
redis.maxIdle=300
#连接池的最大数据库连接数。设为0表示无限制,如果是jedis 2.4以后用redis.maxTotal
#redis.maxActive=600
#控制一个pool可分配多少个jedis实例,用来替换上面的redis.maxActive,如果是jedis 2.4以后用该属性
redis.maxTotal=1000
#最大建立连接等待时间。如果超过此时间将接到异常。设为-1表示无限制。
redis.maxWaitMillis=1000
#连接的最小空闲时间 默认1800000毫秒(30分钟)
redis.minEvictableIdleTimeMillis=300000
#每次释放连接的最大数目,默认3
redis.numTestsPerEvictionRun=1024
#逐出扫描的时间间隔(毫秒) 如果为负数,则不运行逐出线程, 默认-1
redis.timeBetweenEvictionRunsMillis=30000
#是否在从池中取出连接前进行检验,如果检验失败,则从池中去除连接并尝试取出另一个
redis.testOnBorrow=true
#在空闲时检查有效性, 默认false
redis.testWhileIdle=true
package com.junsi.demo.config
import org.springframework.beans.factory.annotation.Value
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
import org.springframework.context.annotation.PropertySource
import org.springframework.data.redis.connection.RedisConnectionFactory
import org.springframework.data.redis.connection.jedis.JedisConnectionFactory
import org.springframework.data.redis.core.RedisTemplate
import org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer
import org.springframework.data.redis.serializer.StringRedisSerializer
import com.junsi.demo.utils.RedisUtil
import redis.clients.jedis.JedisPoolConfig
/**
* Redis配置类
* @author pzx
* 2019年6月8日
*/
@Configuration
@PropertySource("classpath:redis.properties")
public class RedisConfig {
@Value("${redis.maxIdle}")
private Integer maxIdle
@Value("${redis.maxTotal}")
private Integer maxTotal
@Value("${redis.maxWaitMillis}")
private Integer maxWaitMillis
@Value("${redis.minEvictableIdleTimeMillis}")
private Integer minEvictableIdleTimeMillis
@Value("${redis.numTestsPerEvictionRun}")
private Integer numTestsPerEvictionRun
@Value("${redis.timeBetweenEvictionRunsMillis}")
private long timeBetweenEvictionRunsMillis
@Value("${redis.testOnBorrow}")
private boolean testOnBorrow
@Value("${redis.testWhileIdle}")
private boolean testWhileIdle
@Value("${spring.redis.cluster.nodes}")
private String clusterNodes
@Value("${spring.redis.cluster.max-redirects}")
private Integer mmaxRedirectsac
/**
* 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
}
/**
* @param jedisPoolConfig
* @return
*/
@Bean
public JedisConnectionFactory JedisConnectionFactory(JedisPoolConfig jedisPoolConfig){
JedisConnectionFactory JedisConnectionFactory = new JedisConnectionFactory(jedisPoolConfig)
//连接池
JedisConnectionFactory.setPoolConfig(jedisPoolConfig)
//IP地址
JedisConnectionFactory.setHostName("172.16.44.148")
//端口号
JedisConnectionFactory.setPort(6379)
//如果Redis设置有密码
//JedisConnectionFactory.setPassword(password)
//客户端超时时间单位是毫秒
JedisConnectionFactory.setTimeout(5000)
return JedisConnectionFactory
}
/**
* 实例化 RedisTemplate 对象
*
* @return
*/
@Bean
public RedisTemplate<String, Object>functionDomainRedisTemplate(RedisConnectionFactory redisConnectionFactory) {
RedisTemplate<String, Object>redisTemplate = new RedisTemplate<>()
initDomainRedisTemplate(redisTemplate, redisConnectionFactory)
return redisTemplate
}
/**
* 设置数据存入 redis 的序列化方式,并开启事务
*
* @param redisTemplate
* @param factory
*/
private void initDomainRedisTemplate(RedisTemplate<String, Object>redisTemplate, RedisConnectionFactory factory) {
//如果不配置Serializer，那么存储的时候缺省使用String，如果用User类型存储，那么会提示错误User can't cast to String！
redisTemplate.setKeySerializer(new StringRedisSerializer())
redisTemplate.setHashKeySerializer(new StringRedisSerializer())
redisTemplate.setHashValueSerializer(new GenericJackson2JsonRedisSerializer())
redisTemplate.setValueSerializer(new GenericJackson2JsonRedisSerializer())
// 开启事务
redisTemplate.setEnableTransactionSupport(true)
redisTemplate.setConnectionFactory(factory)
}
@Bean(name = "redisUtil")
public RedisUtil redisUtil(RedisTemplate<String, Object>redisTemplate) {
RedisUtil redisUtil = new RedisUtil()
redisUtil.setRedisTemplate(redisTemplate)
return redisUtil
}
}
Spring Boot是目前非常流行的Java Web开发框架，Redis是非关系型数据库的一种，以键值对的形式存储。Spring对Redis的支持是通过Spring Data Redis来实现的，给我们提供了RedisTemplate和StringRedisTemplate两种模板来 *** 作数据。Spring Boot框架也提供了对Redis的支持，下面我们来讲一下Spring Boot框架整合Redis的步骤。
工具/材料IntelliJ IDEA
Spring Boot整合Redis我们需要添加依赖的jar包，spring-boot-starter-data-redis中包含spring和redis相关的jar包，jedis作为redis的客户端也需要添加到工程中，Spring Boot的版本信息在父pom中已指定，子模块中的spring相关的jar包无需另外指定。<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>3.0.0-m1</version>
</dependency>
Spring Boot会根据application.properties中的配置对Redis的属性进行自动配置，并注入到RedisProperties类中。在application.properties配置文件中这些属性都是以spring.redis为前缀的，值得注意的是在Spring Boot 1.5.x版本中默认的Redis客户端是jedis，因此在配置文件中无需指定，如下图所示。
Spring Boot 1.5.x版本的整合配置网上可以搜索大量的文章，然而Spring Boot 2.x版本的整合资料却非常少，甚至提供的配置不能正常使用，因此本文主要讲解Spring Boot 2.x整合Redis以及Redis的使用情况。spring-boot 2.x版本有jedis和lettuce两种客户端，因此我们必须要去指定使用哪一种客户端，两个客户端的配置如下图所示，本文使用的是Jedis客户端连接池，具体的配置如下。
# Redis数据库索引（默认为0）
spring.redis.database=0
# Redis服务器地址
spring.redis.host=127.0.0.1
# Redis服务器连接端口
spring.redis.port=6379
# Redis服务器连接密码（默认为空）
spring.redis.password=xylx1.t!@#
# 配置jedis连接池
# 连接池最大连接数（使用负值表示没有限制）
spring.redis.jedis.pool.max-active=8
# 连接池最大阻塞等待时间（使用负值表示没有限制）
spring.redis.jedis.pool.max-wait=-1ms
# 连接池中的最大空闲连接
spring.redis.jedis.pool.max-idle=8
# 连接池中的最小空闲连接
spring.redis.jedis.pool.min-idle=0
# 连接超时时间（毫秒）
spring.redis.timeout=5000ms
由配置我们可以看到spring-boot 2.x版本时间设置需要加单位ms，因为参数的类型为Duration。另外spring.redis.timeout尽量不要配置0，否则可能会出现io.lettuce.core.RedisCommandTimeoutException: Command timed out超时错误。
配置文件编辑完成后，我们开始编写代码实现Redis数据的存储和读取。我们创建一个RedisUtil工具类，该类使用@Component注解表示交由Spring管理，StringRedisTemplate是Spring提供的，可以使用@Autowired注解直接注入，接下来便可以书写存和取的代码了。@Component
public class RedisUtil {
@Autowired
private StringRedisTemplate redisTemplate
/**
* 存字符串
* @param key 缓存键
* @param value 缓存值
* @param expireTime过期时间(s)
*/
public void setString(String key, String value, int expireTime){
ValueOperations<String, String>ops = redisTemplate.opsForValue()
if (expireTime != 0) {
ops.set(key, value, expireTime, TimeUnit.SECONDS)
} else {
ops.set(key,value)
}
}
/**
* 取字符串
* @param key 缓存键
* @return缓存值
*/
public String getString(String key){
ValueOperations<String, String>ops = this.redisTemplate.opsForValue()
return ops.get(key)
}
接下来我们编写Controller层代码去调用RedisUtil工具类，实现数据的存储和读取，代码比较简单可以参考下图。若想验证Redis是否可用，还需要编写启动类，如下图所示。
由上图可看到我们编写了一个post请求用于存储字符串，get请求用于取出字符串。启动类通过main方法启动应用，接下来我们使用postman去模拟浏览器调用post和get请求，由下图可以看到Redis存储的数据成功被取出。
接下来我们介绍Jedis，这是一个封装了Redis的客户端，在Spring Boot整合Redis的基础上，可以提供更简单的API *** 作。因此我们需要配置JedisPool的Bean，代码如下，其中@Configuration注解表明这是一个配置类，我们在该类中注入RedisProperties，并且使用@Bean注解指定JedisPool。
@Configuration
public class RedisConfiguration {
@Autowired
private RedisProperties properties
@Bean
public JedisPool getJedisPool(){
JedisPoolConfig config = new JedisPoolConfig()
config.setMaxIdle(properties.getJedis().getPool().getMaxIdle())
config.setMaxTotal(properties.getJedis().getPool().getMaxActive())
config.setMaxWaitMillis(properties.getJedis().getPool().getMaxWait().toMillis())
JedisPool pool = new JedisPool(config,properties.getHost(),
properties.getPort(),100,
properties.getPassword(), properties.getDatabase())
return pool
}
}
接下来我们编辑JedisUtil工具类，通过SpringBoot容器的@Component注解来自动创建，并且注入JedisPool，使用jedisPool.getResource()方法来获取Jedis，并最终实现 *** 作redis数据库，其代码如下。@Component
public class JedisUtil {
@Autowired
JedisPool jedisPool
//获取key的value值
public String get(String key) {
Jedis jedis = jedisPool.getResource()
String str = ""
try {
str = jedis.get(key)
} finally {
try {
jedis.close()
} catch (Exception e) {
e.printStackTrace()
}
}
return str
}
public String set(String key, String value) {
Jedis jedis = jedisPool.getResource()
String str = ""
try {
str = jedis.set(key, value)
} finally {
try {
jedis.close()
} catch (Exception e) {
e.printStackTrace()
}
}
return str
}
}
JedisUtil工具类编写完成后，我们修改之前的RedisController，并注入JedisUtil，代码如下图所示。然后再用postman分别调用post和get接口，我们可以看到成功取到了新的key的value值。
特别提示在Spring Boot整合Redis前本机需安装Redis，另外可以使用RedisDesktopManager这个Redis这个桌面管理工具查看Redis中的数据。
欢迎分享，转载请注明来源：内存溢出
微信扫一扫
支付宝扫一扫
评论列表（0条）