SpringBoot 集成Redis

虾米姐 阅读:616 2021-03-31 20:57:55 评论:0

1、项目结构:

2、pom.xml 文件

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> 
	<modelVersion>4.0.0</modelVersion> 
	<parent> 
		<groupId>com.zzg</groupId> 
		<artifactId>mysql-boot</artifactId> 
		<version>0.0.1-SNAPSHOT</version> 
	</parent> 
	<artifactId>mysql-boot-redis</artifactId> 
 
	<dependencies> 
		<!--redis 依赖配置 --> 
		<dependency> 
			<groupId>org.springframework.boot</groupId> 
			<artifactId>spring-boot-starter-data-redis</artifactId> 
		</dependency> 
		<!--redis客户端 依赖  --> 
		<dependency> 
			<groupId>redis.clients</groupId> 
			<artifactId>jedis</artifactId> 
			<version>3.0.1</version> 
		</dependency> 
	</dependencies> 
</project>

3、redis 封装核心代码:

package com.zzg.redis.config.entity; 
 
import org.springframework.boot.context.properties.ConfigurationProperties; 
import org.springframework.context.annotation.Configuration; 
import org.springframework.context.annotation.PropertySource; 
import org.springframework.stereotype.Component; 
 
 
@Component 
@Configuration 
@ConfigurationProperties(prefix = "com.zzg.redis")  
@PropertySource("classpath:redis.properties") 
public class RedisConfigEntity { 
	// Redis数据库索引(默认为0) 
	private String database; 
	// Redis服务器地址 
	private String host; 
	// Redis服务器连接端口 
	private String port; 
	// Redis服务器连接密码(默认为空) 
	private String password; 
	// 连接池最大连接数(使用负值表示没有限制) 
	private String maxActive; 
	// 连接池最大阻塞等待时间(使用负值表示没有限制) 
	private String maxWait;  
	// 连接池中的最大空闲连接 
	private String maxIdle; 
	// 连接池中的最小空闲连接 
	private String minIdle; 
	// 连接超时时间(毫秒) 
	private String timeout; 
	 
	// set 和 get 方法 
	public String getDatabase() { 
		return database; 
	} 
	public void setDatabase(String database) { 
		this.database = database; 
	} 
	public String getHost() { 
		return host; 
	} 
	public void setHost(String host) { 
		this.host = host; 
	} 
	public String getPort() { 
		return port; 
	} 
	public void setPort(String port) { 
		this.port = port; 
	} 
	public String getPassword() { 
		return password; 
	} 
	public void setPassword(String password) { 
		this.password = password; 
	} 
	public String getMaxActive() { 
		return maxActive; 
	} 
	public void setMaxActive(String maxActive) { 
		this.maxActive = maxActive; 
	} 
	public String getMaxWait() { 
		return maxWait; 
	} 
	public void setMaxWait(String maxWait) { 
		this.maxWait = maxWait; 
	} 
	public String getMaxIdle() { 
		return maxIdle; 
	} 
	public void setMaxIdle(String maxIdle) { 
		this.maxIdle = maxIdle; 
	} 
	public String getMinIdle() { 
		return minIdle; 
	} 
	public void setMinIdle(String minIdle) { 
		this.minIdle = minIdle; 
	} 
	public String getTimeout() { 
		return timeout; 
	} 
	public void setTimeout(String timeout) { 
		this.timeout = timeout; 
	} 
} 
package com.zzg.redis.config; 
 
import org.springframework.beans.factory.annotation.Autowired; 
import org.springframework.context.annotation.Bean; 
import org.springframework.context.annotation.Configuration; 
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.zzg.redis.config.entity.RedisConfigEntity; 
import com.zzg.redis.util.RedisUtil; 
 
import redis.clients.jedis.JedisPoolConfig; 
 
@Configuration 
public class RedisConfig { 
	 
	@Autowired 
	private RedisConfigEntity config; 
	 
	// 获取JedisPoolConfig对象 
	@Bean 
	public JedisPoolConfig getJedisPoolConfig(){ 
		JedisPoolConfig jedisPoolConfig = new JedisPoolConfig(); 
		jedisPoolConfig.setMaxIdle(Integer.valueOf(config.getMaxIdle().trim())); 
        jedisPoolConfig.setMinIdle(Integer.valueOf(config.getMinIdle().trim())); 
        jedisPoolConfig.setMaxWaitMillis(Integer.valueOf(config.getMaxWait().trim())); 
		return jedisPoolConfig; 
	} 
	 
	// 获取JedisConnectionFactory 连接工厂对象 
	@SuppressWarnings("deprecation") 
	@Bean 
	public JedisConnectionFactory getConnectionFactory() { 
		JedisConnectionFactory connectionFactory = new JedisConnectionFactory(); 
        connectionFactory.setPoolConfig(getJedisPoolConfig()); 
        connectionFactory.setDatabase(Integer.valueOf(config.getDatabase().trim())); 
        connectionFactory.setHostName(config.getHost().trim()); 
        connectionFactory.setPassword(config.getPassword().trim()); 
        connectionFactory.setPort(Integer.valueOf(config.getPort().trim())); 
        connectionFactory.setTimeout(Integer.valueOf(config.getTimeout().trim())); 
		return connectionFactory; 
	} 
	 
	// 获取RedisTemplate对象 
	@Bean 
	public RedisTemplate<String, Object> redisTemplate() { 
		RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>(); 
 
		JedisConnectionFactory factory = getConnectionFactory(); 
		// 设置Jedis 连接工厂对象 
		redisTemplate.setConnectionFactory(factory); 
		// 设置是否启动事务 
		redisTemplate.setEnableTransactionSupport(true); 
		// 设置Key 序列化方式 
		redisTemplate.setKeySerializer(new StringRedisSerializer()); 
		// 设置Hash Key 序列化方式 
		redisTemplate.setHashKeySerializer(new StringRedisSerializer()); 
		// 设置Hash Value 序列化方式 
		redisTemplate.setHashValueSerializer(new GenericJackson2JsonRedisSerializer()); 
		// 设置Value 序列化方式 
		redisTemplate.setValueSerializer(new GenericJackson2JsonRedisSerializer()); 
 
		// 动态更新redisTemplate 设置 
		redisTemplate.afterPropertiesSet(); 
		return redisTemplate; 
	} 
	 
	// 自定义redis 工具类 
	@Bean(name = "redisUtil") 
	public RedisUtil redisUtil() { 
		RedisUtil redisUtil = new RedisUtil(); 
		redisUtil.setRedisTemplate(redisTemplate()); 
		return redisUtil; 
	} 
	 
	 
	 
	 
 
} 
package com.zzg.redis.util; 
 
import java.util.List; 
import java.util.Map; 
import java.util.Set; 
import java.util.concurrent.TimeUnit; 
 
import org.springframework.data.redis.core.RedisTemplate; 
import org.springframework.util.CollectionUtils; 
 
public class RedisUtil { 
	private RedisTemplate<String, Object> redisTemplate; 
	// set 和  get 方法 
	public RedisTemplate<String, Object> getRedisTemplate() { 
		return redisTemplate; 
	} 
 
	public void setRedisTemplate(RedisTemplate<String, Object> redisTemplate) { 
		this.redisTemplate = redisTemplate; 
	}  
	 
	// -----------redis common method----------------- 
	/**  
     * 指定缓存失效时间  
     * @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 键  
     * @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) {   
            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 值  
     * @param time 时间(秒)  
     * @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 值  
     * @param time 时间(秒)  
     * @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;   
        }   
    }   
} 

4、web 项目依赖redis 封装模块,功能测试:

测试功能代码:

package com.zzg.controller; 
 
import java.util.ArrayList; 
import java.util.HashSet; 
import java.util.List; 
import java.util.Set; 
 
import org.springframework.beans.factory.annotation.Autowired; 
import org.springframework.stereotype.Controller; 
import org.springframework.web.bind.annotation.RequestMapping; 
import org.springframework.web.bind.annotation.RequestMethod; 
 
import com.zzg.entity.Book; 
import com.zzg.redis.util.RedisUtil; 
 
 
@Controller 
@RequestMapping 
public class RedisController { 
	@Autowired 
	private RedisUtil redisUtil; 
	 
	@RequestMapping(value="/one", method=RequestMethod.GET) 
	 
	public void one(){ 
		Book user = new Book(); 
		user.setId(1L); 
		 
		user.setName("redis 单节点"); 
		 
		 
		// hash string 设置 
		boolean one = redisUtil.set("1", user); 
		System.out.println("是否添加成功:" + one); 
		// hash string 获取 
		Book two = (Book) redisUtil.get("1"); 
		System.out.println("redis 对象获取:" + two.toString()); 
		 
		//hash list 设置 
		Book three = new Book(); 
		three.setId(2L); 
		three.setName("redis 单节点"); 
		 
		Book four = new Book(); 
		four.setId(3L); 
		four.setName("redis 单节点"); 
		 
		List<Book> list = new ArrayList<Book>(); 
		list.add(three); 
		list.add(four); 
		boolean five = redisUtil.lSet("2",list); 
		System.out.println("List是否添加成功:" + five); 
		List<Object> six = redisUtil.lGet("2", 0, 1); 
		for(Object obj : six){ 
			ArrayList arrayList = (ArrayList) obj; 
			arrayList.stream().forEach(item ->{ 
				System.out.println("redis 对象获取:" + item.toString()); 
			}); 
		} 
		 
		// hash set 设置 
		Book eight = new Book(); 
		eight.setId(4L); 
		eight.setName("redis 单节点"); 
	 
		Book nine = new Book(); 
		nine.setId(4L); 
		nine.setName("redis 单节点"); 
		 
		Set<Book> set = new HashSet<Book>(); 
		set.add(eight); 
		set.add(nine); 
		 
		long ten = redisUtil.sSet("3",set); 
		System.out.println("HashSet是否添加成功:" + ten); 
		Set<Object> sets = redisUtil.sGet("3"); 
		sets.stream().forEach(item ->{ 
			HashSet hashSet = (HashSet) item; 
			hashSet.stream().forEach(entity ->{ 
				System.out.println("redis 对象获取:" + entity.toString()); 
			});			 
		}); 
	}   
 
} 

 

标签:Spring Boot
声明

1.本站遵循行业规范,任何转载的稿件都会明确标注作者和来源;2.本站的原创文章,请转载时务必注明文章作者和来源,不尊重原创的行为我们将追究责任;3.作者投稿可能会经我们编辑修改或补充。

关注我们

一个IT知识分享的公众号