SpringBoot集成Redis详解

向右看齐 2024-03-26 16:07 44阅读 0赞

> **1.pom.xml**

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

> **2.application.yml**

spring:
      redis:
        host: 127.0.0.1
        port: 6379
        password:
        timeout: 6000ms
        database: 2

> **3.RedisConfig**

package com.zkdj.api.config;
    
    
    import org.springframework.boot.autoconfigure.AutoConfigureAfter;
    import org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration;
    import org.springframework.cache.annotation.CachingConfigurerSupport;
    import org.springframework.cache.annotation.EnableCaching;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.context.annotation.Primary;
    import org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory;
    import org.springframework.data.redis.core.RedisTemplate;
    import org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer;
    import org.springframework.data.redis.serializer.RedisSerializer;
    import org.springframework.data.redis.serializer.StringRedisSerializer;
    
    @Configuration
    @EnableCaching
    @AutoConfigureAfter(RedisAutoConfiguration.class)
    public class RedisConfig extends CachingConfigurerSupport {
        
        @Bean(name = "redisTemplate")
        @Primary
        public RedisTemplate<String, Object> redisTemplate(LettuceConnectionFactory connectionFactory) {
        
            RedisTemplate<String, Object> template = new RedisTemplate<>();
            template.setConnectionFactory(connectionFactory);
            template.setValueSerializer(genericJackson2JsonRedisSerializer());
            template.setKeySerializer(new StringRedisSerializer());
            template.setStringSerializer(new StringRedisSerializer());
            template.setHashKeySerializer(new StringRedisSerializer());
            template.setHashValueSerializer(genericJackson2JsonRedisSerializer());
            template.afterPropertiesSet();
    
            return template;
        }
        @Bean
        public RedisSerializer<Object> genericJackson2JsonRedisSerializer() {
        
            GenericJackson2JsonRedisSerializer serializer = new GenericJackson2JsonRedisSerializer();
            return serializer;
        }
    }

package com.zkdj.api.utils;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.data.redis.core.BoundListOperations;
    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;
    
    /**
     * redisTemplate封装
     *
     */
    @Component
    public class RedisUtil {
        
    
        @Autowired
        private RedisTemplate<String, Object> redisTemplate;
    
        public RedisUtil(RedisTemplate<String, Object> redisTemplate) {
        
            this.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));
                    redisTemplate.delete((Collection<String>) 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 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().increment(key, -delta);
        }
    
        //================================Map=================================
        /**
         * HashGet
         * @param key 键 不能为null
         * @param item 项 不能为null
         * @return 值
         */
        public Object hget(String key,String item){
        
            try {
        
                return redisTemplate.opsForHash().get(key, item);
            } catch (Exception e) {
        
                e.printStackTrace();
                return null;
            }
        }
    
        /**
         * 获取hashKey对应的所有键值
         * @param key 键
         * @return 对应的多个键值
         */
        public Map<Object,Object> hmget(String key){
        
            try {
        
                return redisTemplate.opsForHash().entries(key);
            } catch (Exception e) {
        
                e.printStackTrace();
                return null;
            }
        }
    
        /**
         * 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;
            }
        }
    
        /**
         * 模糊查询获取key值
         * @param pattern
         * @return
         */
        public Set keys(String pattern){
        
            return redisTemplate.keys(pattern);
        }
    
        /**
         * 使用Redis的消息队列
         * @param channel
         * @param message 消息内容
         */
        public void convertAndSend(String channel, Object message){
        
            redisTemplate.convertAndSend(channel,message);
        }
    
    
        //=========BoundListOperations 用法 start============
        /**
         * 根据起始结束序号遍历Redis中的list
         * @param listKey
         * @param start  起始序号
         * @param end  结束序号
         * @return
         */
        public List<Object> rangeList(String listKey, long start, long end) {
        
            //绑定操作
            BoundListOperations<String, Object> boundValueOperations = redisTemplate.boundListOps(listKey);
            //查询数据
            return boundValueOperations.range(start, end);
        }
        /**
         * 弹出右边的值 --- 并且移除这个值
         * @param listKey
         */
        public Object rifhtPop(String listKey){
        
            //绑定操作
            BoundListOperations<String, Object> boundValueOperations = redisTemplate.boundListOps(listKey);
            return boundValueOperations.rightPop();
        }
    
        //=========BoundListOperations 用法 End============
    
    }

> **4.Controller调用**

package com.zkdj.api.controller;
    
    import cn.hutool.http.HttpResponse;
    import cn.hutool.http.HttpUtil;
    import com.alibaba.fastjson.JSONArray;
    import com.alibaba.fastjson.JSONObject;
    import com.zkdj.api.bean.secondary.Pager;
    import com.zkdj.api.bean.secondary.RespResult;
    import com.zkdj.api.service.AssociationService;
    import com.zkdj.api.utils.RedisUtil;
    import com.zkdj.common.util.EhcacheUtil;
    import com.zkdj.common.util.Md5Utils;
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiOperation;
    import io.swagger.annotations.ApiParam;
    import org.apache.commons.lang3.StringEscapeUtils;
    import org.apache.commons.lang3.StringUtils;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.jdbc.core.JdbcTemplate;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestParam;
    import org.springframework.web.bind.annotation.ResponseBody;
    import org.springframework.web.bind.annotation.RestController;
    
    import javax.annotation.Resource;
    import javax.servlet.http.HttpServletRequest;
    import java.util.*;
    
    
    /**
     * 协会/渠道 模块接口
     */
    @Api("AssociationController")
    @RestController
    @RequestMapping("/api/association")
    public class AssociationController {
        
    	Logger logger = LoggerFactory.getLogger(AssociationController.class);
    	
    	@Autowired
    	private RedisUtil redisUtil;
    	
    	/**private static String YQ_Search;
    	@Value("${yq_search}")
    	public void setYQ_Search(String YQ_Search){
    		this.YQ_Search=YQ_Search;
    	}*/
    
    
    
    
    	/**
    	 * 协会列表v2
    	 *
    	 * @return
    	 */
    	@ApiOperation(value = "协会列表V2",httpMethod = "GET")
    	@RequestMapping("list/V2")
    	@ResponseBody
    	public String listV2(
    					   @ApiParam(value = "用户ID", required = true) @RequestParam(value = "userId") String userId,
    					   @ApiParam(value = "页码", required = true) @RequestParam(value = "pageNum") String pageNum,
    					   @ApiParam(value = "条数", required = true) @RequestParam(value = "pageSize") String pageSize,
    					   @ApiParam(value = "渠道类型") @RequestParam(value = "qdlx", required = false) String qdlx,
    					   @ApiParam(value = "区域:（多个值：河北省,河南省，湖北省  单值：北京市  ）") @RequestParam(value = "qy", required = false) String qy,
    					   @ApiParam(value = "市:（单值：海淀区）") @RequestParam(value = "shi", required = false) String shi,
    					   @ApiParam(value = "区县") @RequestParam(value = "qu", required = false) String qu,
    					   @ApiParam(value = "产业名称") @RequestParam(value = "cymc", required = false) String cymc,
    					   @ApiParam(value = "协会名称") @RequestParam(value = "xhmc", required = false) String xhmc,
    					   @ApiParam(value = "排序字段:registered_capital") @RequestParam(value = "registered_capital") String registeredCapitalSort,
    					   @ApiParam(value = "排序类型:asc/desc") @RequestParam(value = "registeredCapitalType") String registeredCapitalSortType,
    					   @ApiParam(value = "排序字段:establishTime") @RequestParam(value = "establishTimeSort") String establishTimeSort,
    					   @ApiParam(value = "排序类型:asc/desc") @RequestParam(value = "establishTimeSortType") String establishTimeSortType) {
        
    		Pager<Map<String, Object>> association=new Pager<>();
    		try {
        
    			logger.info("用户ID="+ userId+"协会类型="+ qdlx+"区域="+qy+ "产业名称="+cymc+"协会名称="+ xhmc);
    			String name = StringUtils.isNotBlank(xhmc)? xhmc.replaceAll("'",""):"";
    			String key = userId+pageNum+pageSize+qy+shi+qu+cymc+name+qdlx+registeredCapitalSort+registeredCapitalSortType+establishTimeSort+establishTimeSortType;
    			String redisKey = "zkdj-exhibition-api-association";
    			String ckey = Md5Utils.GetStringMD5(key);
    			Long ctime = 60*60*8L;
    //			Object object = EhcacheUtil.getInstance().get("shehuizuzhi",key);
    			Object object = redisUtil.hget(redisKey,ckey);
    			if(null!=object){
        
    				logger.info("协会列表——>从缓存数据中获取");
    				association = (Pager<Map<String, Object>>) object;
    			}else{
        
    				association = associationService.associationV2(userId, Integer.valueOf(pageNum), Integer.valueOf(pageSize),qy,shi,qu,cymc,name,qdlx,registeredCapitalSort,registeredCapitalSortType,establishTimeSort,establishTimeSortType);
    //				EhcacheUtil.getInstance().put("shehuizuzhi",key,association,60*60*8);
    				redisUtil.hset(redisKey,ckey,association,ctime);
    			}
    		} catch (Exception e) {
        
    			e.printStackTrace();
    			return RespResult.getInstance()
    					.setInfo("success", false)
    					.setInfo("msg", "系统错误!")
    					.toJson();
    		}
    		return RespResult.getInstance()
    				.setInfo("success", true)
    				.setInfo("data", association)
    				.setInfo("msg", "成功")
    				.setInfo("code", 200)
    				.toJson();
    	}
    	
    
    
      
    
    }

> **5.工具类**

package com.zkdj.common.util;
    
    import org.springframework.util.DigestUtils;
    
    public class Md5Utils {
        
        public static String GetStringMD5(String input) {
        
            String md5Password = DigestUtils.md5DigestAsHex(input.getBytes());
            return md5Password;
        }
    }