springboot+redis項目實戰完整篇

springboot+redis項目實戰完整篇

 

 https://www.jianshu.com/p/5596c3a4978d

Springboot+redis

【原創做品】

有關Springboot+redis的配置和使用，完整篇。

此配置，幾乎能夠無腦的粘貼進項目中使用。

springboot項目的建立能夠參考以前：https://www.jianshu.com/p/b9f066a221b0

本篇測試項目github地址：https://github.com/zhengjiaao/springboot-test-redis

1.在springboot項目的pom.xml

文件里加入redis的jar依賴

<parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.0.5.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <dependencies> <!--======== SpringBoot的配置start ===========--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-tomcat</artifactId> <scope>provided</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <!-- hibernate jpa--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> </dependency> <!--簡單快速的訪問靜態資源(圖片、html等)--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-thymeleaf</artifactId> </dependency> <!--開發階段使用：springboot熱啓動(熱部署)：項目有更改，自動編譯：需配置idea true生效--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <optional>true</optional> </dependency> <!--======= SpringBoot的配置end =========--> <!--springboot中的redis依賴--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> </dependency> </dependencies> 

2.目錄結構：redis用到的類

 

redis構建的相關目錄.png

3.在application.yml中配置redis參數

 

yml配置redis.png

4.redis的配置類

RedisConfig.java類

package com.dist.config; 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.cache.annotation.EnableCaching; 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.*; import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer; import org.springframework.data.redis.serializer.StringRedisSerializer; /** * redis配置類 * @program: springbootdemo * @Date: 2019/1/25 15:20 * @Author: Mr.Zheng * @Description: */ @Configuration @EnableCaching //開啓註解 public class RedisConfig extends CachingConfigurerSupport { /** * retemplate相關配置 * @param factory * @return */ @Bean public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) { RedisTemplate<String, Object> template = new RedisTemplate<>(); // 配置鏈接工廠 template.setConnectionFactory(factory); //使用Jackson2JsonRedisSerializer來序列化和反序列化redis的value值（默認使用JDK的序列化方式） Jackson2JsonRedisSerializer jacksonSeial = new Jackson2JsonRedisSerializer(Object.class); ObjectMapper om = new ObjectMapper(); // 指定要序列化的域，field,get和set,以及修飾符範圍，ANY是都有包括private和public om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY); // 指定序列化輸入的類型，類必須是非final修飾的，final修飾的類，好比String,Integer等會跑出異常 om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL); jacksonSeial.setObjectMapper(om); // 值採用json序列化 template.setValueSerializer(jacksonSeial); //使用StringRedisSerializer來序列化和反序列化redis的key值 template.setKeySerializer(new StringRedisSerializer()); // 設置hash key 和value序列化模式 template.setHashKeySerializer(new StringRedisSerializer()); template.setHashValueSerializer(jacksonSeial); template.afterPropertiesSet(); return template; } /** * 對hash類型的數據操做 * * @param redisTemplate * @return */ @Bean public HashOperations<String, String, Object> hashOperations(RedisTemplate<String, Object> redisTemplate) { return redisTemplate.opsForHash(); } /** * 對redis字符串類型數據操做 * * @param redisTemplate * @return */ @Bean public ValueOperations<String, Object> valueOperations(RedisTemplate<String, Object> redisTemplate) { return redisTemplate.opsForValue(); } /** * 對鏈表類型的數據操做 * * @param redisTemplate * @return */ @Bean public ListOperations<String, Object> listOperations(RedisTemplate<String, Object> redisTemplate) { return redisTemplate.opsForList(); } /** * 對無序集合類型的數據操做 * * @param redisTemplate * @return */ @Bean public SetOperations<String, Object> setOperations(RedisTemplate<String, Object> redisTemplate) { return redisTemplate.opsForSet(); } /** * 對有序集合類型的數據操做 * * @param redisTemplate * @return */ @Bean public ZSetOperations<String, Object> zSetOperations(RedisTemplate<String, Object> redisTemplate) { return redisTemplate.opsForZSet(); } } 

5.redis的工具類

RedisUtil.java

package com.dist.util; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.redis.core.RedisTemplate; import org.springframework.stereotype.Component; import org.springframework.util.CollectionUtils; import java.util.List; import java.util.Map; import java.util.Set; import java.util.concurrent.TimeUnit; /** * redisTemplate封裝 * * @author yinxp@dist.com.cn */ @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)); } } } //============================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){ 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 值 * @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 expireEnum 有效期的枚舉類 * @param values 待添加的數據 */ public void addToListRight(String listKey, Status.ExpireEnum expireEnum, Object... values) { //綁定操做 BoundListOperations<String, Object> boundValueOperations = redisTemplate.boundListOps(listKey); //插入數據 boundValueOperations.rightPushAll(values); //設置過時時間 boundValueOperations.expire(expireEnum.getTime(),expireEnum.getTimeUnit()); } /** * 根據起始結束序號遍歷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============ } 

6.實體類:省略了get/set方法

UserEntity.java

public class UserEntity implements Serializable { private Long id; private String guid; private String name; private String age; private Date createTime; } 

7.RedisController.java

package com.dist.controller; import com.dist.entity.UserEntity; import com.dist.util.RedisUtil; import lombok.extern.slf4j.Slf4j; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import javax.annotation.Resource; import java.util.Date; /** * @program: springbootdemo * @Date: 2019/1/25 15:03 * @Author: Mr.Zheng * @Description: */ @Slf4j @RequestMapping("/redis") @RestController public class RedisController { private static int ExpireTime = 60; // redis中存儲的過時時間60s @Resource private RedisUtil redisUtil; @RequestMapping("set") public boolean redisset(String key, String value){ UserEntity userEntity =new UserEntity(); userEntity.setId(Long.valueOf(1)); userEntity.setGuid(String.valueOf(1)); userEntity.setName("zhangsan"); userEntity.setAge(String.valueOf(20)); userEntity.setCreateTime(new Date()); //return redisUtil.set(key,userEntity,ExpireTime); return redisUtil.set(key,value); } @RequestMapping("get") public Object redisget(String key){ return redisUtil.get(key); } @RequestMapping("expire") public boolean expire(String key){ return redisUtil.expire(key,ExpireTime); } } 

8.測試

用的Postman工具測試，也能夠用瀏覽器或其餘工具測試。

postman具體使用參考網上資源，很簡單的。

 

使用工具測試.png

返回：true 表明向redis中存成功

9.用RedisDesktopManager工具查看

沒有下載安裝的，能夠用命令行的方式，根據key值查找。

 

打開Redis Desktop Manager工具.png

kay：id

value：123456

過時時間，默認-1，-1表明永遠，不會過時

設置過時，能夠找RedisUtil.java類中的相關方法

追加更新說明：
問題：RedisUtil.java工具類報找不到 Status 類的錯誤：Status .java
解決方式：將Status .java類，放到項目任意位置，從新引入此類
Status .java

package com.dist.constants; import java.util.concurrent.TimeUnit; /** * 狀態枚舉 * @program: dgpoms-server-root * @Date: 2018/12/27 11:40 * @Author: Mr.Zheng * @Description: */ public abstract class Status { /** * 過時時間相關枚舉 */ public static enum ExpireEnum{ //未讀消息的有效期爲30天 UNREAD_MSG(30L, TimeUnit.DAYS) ; /** * 過時時間 */ private Long time; /** * 時間單位 */ private TimeUnit timeUnit; ExpireEnum(Long time, TimeUnit timeUnit) { this.time = time; this.timeUnit = timeUnit; } public Long getTime() { return time; } public TimeUnit getTimeUnit() { return timeUnit; } } } 

做者：宇宙小神特別萌 連接：https://www.jianshu.com/p/5596c3a4978d 來源：簡書 著做權歸做者全部。商業轉載請聯繫做者得到受權，非商業轉載請註明出處。