Redis整合SpringBoot的RedisTemplate實現類(例項詳解)

阿新 • • 發佈：2021-01-12

Redis整合SpringBoot》》RedisService 介面

package com.tuan.common.base.redis;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;
public interface RedisService {

 //Redis 字串(String)

 /**
  * 模糊值再刪除
  * @param key
  * @return
  */
 boolean delslike(String key);

 /**
  * 通過鍵來獲取值
  * @param key
  * @return String
  */
 String get(String key);

 /**
  * 獲取值裝成Int型別
  * @param key
  * @return
  */
 Integer getInt(String key);

 /**
  * 刪除一個鍵
  * @param key
  * @return
  */
 boolean del(String key);

 /**
  * key設定value 沒有失效時間
  * @param key
  * @param value
  */
 void set(String key,String value);
 /**
  * key設定value 有失效時間
  * @param key
  * @param value
  * @param expire
  */
 void set(String key,String value,Integer expire);

 /**
  * 向key遞增1
  * @param key
  * @return
  */
 Long incr(String key);

 /**
  * 向key遞增1,設定expire失效時間
  * @param key
  * @param expire
  * @return
  */
 Long incr(String key,Integer expire);

 /**
  * 向key遞增delta數值 並設定expire失效時間
  * @param key
  * @param delta
  * @param expire
  * @return
  */
 Long incr(String key,int delta,Integer expire);
 /**
  * 向key遞減1
  * @param key
  * @return
  */
 Long decr(String key);
 /**
  * 向key遞減1,設定expire失效時間
  * @param key
  * @param expire
  * @return
  */
 Long decr(String key,Integer expire);

 /**
  * 向key設定expire失效時間
  * @param key
  * @param expire
  */
 void expire(String key,Integer expire);

 /**
  * 判斷key是不存在，設值為1和設定失效時間 成功返回 true
  * 判斷key是存在，直接返回false
  * @param key
  * @param expire
  * @return
  */
 boolean setnx(String key,Integer expire);
 /**
  * 判斷key是不存在，設值為value和設定失效時間 成功返回 true
  * 判斷key是存在，直接返回false
  * @param key
  * @param expire
  * @return
  */
 boolean setnxv(String key,Integer expire);

 /**
  * 判斷鍵是否存在
  * @param key
  * @return
  */
 Boolean hasKey(String key);
 //Redis 集合(Set)
 /**
 Redis 的 Set 是 String 型別的無序集合。集合成員是唯一的，這就意味著集合中不能出現重複的資料。
 Redis 中集合是通過雜湊表實現的，所以新增，刪除，查詢的複雜度都是 O(1)。
 集合中最大的成員數為 232 - 1 (4294967295,每個集合可儲存40多億個成員)。
  */

 /**
  * Redis Sadd 命令將一個或多個成員元素加入到集合中，已經存在於集合的成員元素將被忽略。
  * 假如集合 key 不存在，則建立一個只包含新增的元素作成員的集合。
  * 當集合 key 不是集合型別時，返回一個錯誤。
  * 注意：在 Redis2.4 版本以前， SADD 只接受單個成員值。
  */
 /**
  * 設定set 不重複的值，
  * 向key插入value值 ，
  * expire為鍵的失效時間
  * @param key
  * @param value
  * @param expire null 無時間
  */
 void sadd(String key,Integer expire);

 /**
  * 向key鍵 的set 刪除一個元素memeber
  * @param key
  * @param memeber
  */
 void srem(String key,String memeber);

 /**
  * set中命令判斷成員元素是否是集合的成員。
  * @param key
  * @param value
  * @return
  */
 boolean sismember(String key,String value);

 /**
  * set取出key所有的資料
  * @param key
  * @return
  */
 Set<String> smembers(String key);

 /**
  * set中這個key值的數量
  * @param key
  * @return
  */
 Long ssize(String key);

 //Redis 列表(List)
 /**
 Redis列表是簡單的字串列表，按照插入順序排序。你可以新增一個元素到列表的頭部（左邊）或者尾部（右邊）
 一個列表最多可以包含 232 - 1 個元素 (4294967295,每個列表超過40億個元素)。
  */

 /**
  * 取得key分頁的資料
  * @param key list 的鍵
  * @param start 開始下標
  * @param end 結束下標
  * @return
  */
 List<String> lrange(String key,int start,int end);

 /**
  * list取key的下值的數量
  * @param key
  * @return
  */
 int llen(String key);

 /**
  *   開始---結尾
  * 向右新增資料 左---→右 新增資料
  * @param key list 鍵
  * @param value 新增到list的值
  * @param expire list 失效時間
  */
 void rpush(String key,Integer expire);
 /**
  *   結尾---開始
  * 向左新增資料 右---→左 新增資料
  * @param key list 鍵
  * @param value 新增到list的值
  * @param expire list 失效時間
  */
 void lpush(String key,Integer expire);

 /**
  * list中這個key鍵下刪除count個value值
  * @param key list 鍵
  * @param count 刪除多少個值
  * @param value list 中的值
  */
 void rmpush(String key,Integer count,String value);

 /**
  * 移出並獲取列表的第一個元素(下標為0的元素)
  * @param key list 鍵
  * @return
  */
 String lpop(String key);

 // Redis 有序集合(sorted set)
	/**
	Redis 有序集合和集合一樣也是string型別元素的集合,且不允許重複的成員。
	不同的是每個元素都會關聯一個double型別的分數。redis正是通過分數來為集合中的成員進行從小到大的排序。
	有序集合的成員是唯一的,但分數(score)卻可以重複。
	集合是通過雜湊表實現的，所以新增，刪除，查詢的複雜度都是O(1)。 集合中最大的成員數為 232 - 1 (4294967295,每個集合可儲存40多億個成員)。
	 */

 /**
  * Redis Zadd 命令用於將一個或多個成員元素及其分數值加入到有序集當中。
  * 如果某個成員已經是有序集的成員，那麼更新這個成員的分數值，並通過重新插入這個成員元素，來保證該成員在正確的位置上。
  * 分數值可以是整數值或雙精度浮點數。
  * 如果有序集合 key 不存在，則建立一個空的有序集並執行 ZADD 操作。
  * 當 key 存在但不是有序集型別時，返回一個錯誤。
  * 注意： 在 Redis 2.4 版本以前， ZADD 每次只能新增一個元素。
  */

  /**
  * @param key 有序集合 key
  * @param member 成員元素
  * @param score 成員的分數值
  * @return 成功與否
  */
 boolean zadd(String key,String member,double score,Integer expire);

 /**
  * Redis Zinterstore 命令計算給定的一個或多個有序集的交集，其中給定 key 的數量必須以 numkeys 引數指定，並將該交集(結果集)儲存到 destination 。
  * 預設情況下，結果集中某個成員的分數值是所有給定集下該成員分數值之和
  */
 long zinterstore(String key,List<String> otherKeys,String destKey,Integer expire);

 /**
  * 獲取有序集合的第一個元素，通過索引區間來實現，而不是通過分數
  * @param key
  * @return
  */
 String zfirst(String key);

 /**
  * 刪除zset中指定的member值
  * @param key
  * @param member
  * @return
  */
 boolean zrem(String key,String member);

 /**
  * zset取出key中所有的資料
  * @param key
  * @return
  */
 Map<String,Double> zscan(String key);

 /**
  * 對key的zset中member進行遞增或者遞減incrScore值
  * @param key zset 鍵
  * @param member 目標
  * @param incrScore 要改變的數值
  * @param expire 失效時間
  * @return
  */
 Double zincrby(String key,double incrScore,Integer expire);

 /**
  * 找到對key的zset中member值（也就是這個member分數）
  * @param key
  * @param member
  * @return
  */
 Double zscore(String key,String member);

 //Redis 雜湊(Hash)

 /**
 Redis hash 是一個 string 型別的 field 和 value 的對映表，hash 特別適合用於儲存物件。
 Redis 中每個 hash 可以儲存 232 - 1 鍵值對（40多億）。
  */

 /**
  * 新增 hash物件
  * hash一般儲存物件 key 標記那個使用者
  * hashKey使用者下的什麼資訊
  * value 具體資料
  * @param key hash 的鍵
  * @param hashKey 目標鍵
  * @param value 儲存的值
  * @param expire 失效時間
  */
 void hput(String key,String hashKey,Object value,Integer expire);

 /**
  * 刪除 hash物件 key鍵 中的 hashKey
  * @param key
  * @param hashKey
  */
 void hdel(String key,String hashKey);

 /**
  * 獲取 hash物件 key鍵 中的 hashKey具體的資料
  * @param key
  * @param hashKey
  */
 Object hget(String key,String hashKey);

 /**
  * 獲取 hash物件 key鍵 下有多少個物件數量
  * @param key
  * @return
  */
 Long hsize(String key);

 /**
  *獲 取 hash物件 key鍵 下有所有的物件
  * @param key
  * @return
  */
 List<Object> hgetAll(String key);

 //Redis 管道(Pipeline)

 /**
  * 這個過程稱為Round trip time(簡稱RTT,往返時間)，mget mset有效節約了RTT，
  * 但大部分命令（如hgetall，並沒有mhgetall）不支援批量操作，需要消耗N次RTT ，
  * 這個時候需要pipeline來解決這個問題
  */

 /**
  * 管道批量插入
  * @author DuanLinpeng
  * @date 2021/01/08 15:15
  * @param saveList
  * @param unit
  * @param timeout
  * @return void
  */
  void batchInsert(List<Map<String,String>> saveList,TimeUnit unit,int timeout);

 /**
  * batchGet管道形式（推薦，效能高，型別多）
  * @param keyList
  * @return
  */
  List<String> batchGet(List<String> keyList);

 /**
  * multiGet批量查詢（只能是str）
  * @param keys
  * @return List<String>
  */
 List<String> getmultiet(List<String> keys);

}

Redis整合SpringBoot》》 RedisServiceImpl 實現

package com.tuan.common.base.redis.impl;

import com.tuan.common.base.redis.RedisService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.dao.DataAccessException;
import org.springframework.data.redis.connection.RedisConnection;
import org.springframework.data.redis.connection.StringRedisConnection;
import org.springframework.data.redis.core.*;
import org.springframework.stereotype.Service;
import org.springframework.util.CollectionUtils;
import org.springframework.util.StringUtils;

import java.util.*;
import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;

@Service
public class RedisServiceImpl implements RedisService {
 private final String KVS_KEY_SPLIT = "-";

 @Value("${spring.application.name}")
 private String applicationName;
 @Value("${spring.profiles.active}")
 private String profileActive;
 @Value("${customize.copyright.name.en}")
 private String copyrightEn;
 @Autowired
 private StringRedisTemplate stringRedisTemplate;

 /**
  * stringRedisTemplate.opsForValue();　　//操作字串
  * stringRedisTemplate.opsForHash();　　 //操作hash
  * stringRedisTemplate.opsForList();　　 //操作list
  * stringRedisTemplate.opsForSet();　　 //操作set
  * stringRedisTemplate.opsForZSet();　 　//操作有序set
  */

 /**
  * assembleCacheKey所有鍵的拼接
  * @param key
  * @return
  */
 private String assembleCacheKey(String key) {
  if (StringUtils.isEmpty(key)) {
   return null;
  }
  return copyrightEn + KVS_KEY_SPLIT + applicationName + KVS_KEY_SPLIT + profileActive + KVS_KEY_SPLIT + key;
 }

 @Override
 public List<String> getmultiet(List<String> keys) {
  if (CollectionUtils.isEmpty(keys)) {
   return null;
  }
  keys= keys.stream().map( key -> assembleCacheKey(key)).collect(Collectors.toList());
  return stringRedisTemplate.opsForValue().multiGet(keys);
 }

 @Override
 public String get(String key) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return null;
  }
  return stringRedisTemplate.opsForValue().get(key);
 }

 @Override
 public List<String> lrange(String key,int end) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return null;
  }
  return stringRedisTemplate.opsForList().range(key,start,end);
 }

 @Override
 public int llen(String key) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return 0;
  }
  Long size = stringRedisTemplate.opsForList().size(key);
  return null == size ? 0 : size.intValue();
 }

 @Override
 public Integer getInt(String key) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return null;
  }
  String value = stringRedisTemplate.opsForValue().get(key);
  if (StringUtils.isEmpty(value)) {
   return null;
  }
  try {
   return Integer.valueOf(value);
  } catch (NumberFormatException e) {
   e.printStackTrace();
   return null;
  }
 }

 @Override
 public boolean del(String key) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return false;
  }
  try {
   Boolean delete = stringRedisTemplate.delete(key);
   return null != delete && delete;
  } catch (Exception e) {
   e.printStackTrace();
   return false;
  }
 }

 @Override
 public boolean delslike(String key) {
  key = assembleCacheKey(key);
  Set<String> keys = stringRedisTemplate.keys(key);
  if (StringUtils.isEmpty(key)) {
   return false;
  }
  try {
   Long delete = stringRedisTemplate.delete(keys);
   return delete > 0 ?true:false;
  } catch (Exception e) {
   e.printStackTrace();
   return false;
  }
 }

 @Override
 public void set(String key,String value) {
  set(key,value,null);
 }

 @Override
 public void set(String key,Integer expire) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key) || StringUtils.isEmpty(value)) {
   return;
  }
  if (null != expire) {
   stringRedisTemplate.opsForValue().set(key,expire,TimeUnit.SECONDS);
  } else {
   stringRedisTemplate.opsForValue().set(key,value);
  }
 }

 @Override
 public Long incr(String key) {
  return incr(key,1,null);
 }

 @Override
 public Long incr(String key,Integer expire) {
  return incr(key,expire);
 }

 @Override
 public Long incr(String key,Integer expire) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return null;
  }
  Long ret = stringRedisTemplate.opsForValue().increment(key,delta);
  if (null != expire) {
   stringRedisTemplate.expire(key,TimeUnit.SECONDS);
  }
  return ret;
 }

 @Override
 public Long decr(String key) {
  return incr(key,-1,null);
 }

 @Override
 public Long decr(String key,expire);
 }

 @Override
 public void rpush(String key,Integer expire) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key) || StringUtils.isEmpty(value)) {
   return;
  }
  stringRedisTemplate.opsForList().rightPush(key,value);
  if (null != expire) {
   stringRedisTemplate.expire(key,TimeUnit.SECONDS);
  }
 }

 @Override
 public void lpush(String key,Integer expire) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key) || StringUtils.isEmpty(value)) {
   return;
  }
  stringRedisTemplate.opsForList().leftPush(key,TimeUnit.SECONDS);
  }
 }

 @Override
 public void rmpush(String key,String value) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key) || StringUtils.isEmpty(value)) {
   return;
  }
  stringRedisTemplate.opsForList().remove(key,count,value);
 }

 @Override
 public String lpop(String key) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return null;
  }
  return stringRedisTemplate.opsForList().leftPop(key);
 }

 @Override
 public void expire(String key,Integer expire) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return;
  }
  if (null != expire) {
   stringRedisTemplate.expire(key,TimeUnit.SECONDS);
  }
 }

 @Override
 public boolean setnx(String key,Integer expire) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return false;
  }
  Boolean ret = stringRedisTemplate.opsForValue().setIfAbsent(key,"1");
  if (null == ret || !ret) {
   return false;
  }
  if (null != expire) {
   stringRedisTemplate.expire(key,TimeUnit.SECONDS);
  }
  return true;
 }

 @Override
 public boolean setnxv(String key,value);
  if (null == ret || !ret) {
   return false;
  }
  if (null != expire) {
   stringRedisTemplate.expire(key,TimeUnit.SECONDS);
  }
  return true;
 }

 @Override
 public Boolean hasKey(String key) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return false;
  }
  Boolean result = stringRedisTemplate.hasKey(key);
  return null == result ? false : result;
 }

 @Override
 public void sadd(String key,Integer expire) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key) || StringUtils.isEmpty(value)) {
   return;
  }
  Long result = stringRedisTemplate.opsForSet().add(key,value);
  if (null != expire && null != result && result > 0) {
   stringRedisTemplate.expire(key,TimeUnit.SECONDS);
  }
 }

 @Override
 public void srem(String key,String memeber) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key) || StringUtils.isEmpty(memeber)) {
   return;
  }
  stringRedisTemplate.opsForSet().remove(key,memeber);
 }

 @Override
 public boolean sismember(String key,String value) {
  if (StringUtils.isEmpty(value)) {
   return false;
  }
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return false;
  }
  Boolean result = stringRedisTemplate.opsForSet().isMember(key,value);
  return null == result ? false : result;
 }

 @Override
 public Set<String> smembers(String key) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return null;
  }
  return stringRedisTemplate.opsForSet().members(key);
 }

 @Override
 public Long ssize(String key) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return null;
  }
  return stringRedisTemplate.opsForSet().size(key);
 }

 @Override
 public boolean zadd(String key,Integer expire) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return false;
  }
  Boolean result = stringRedisTemplate.opsForZSet().add(key,member,score);
  if (null == result || !result) {
   return false;
  }
  if (null != expire) {
   stringRedisTemplate.expire(key,TimeUnit.SECONDS);
  }
  return true;
 }

 @Override
 public long zinterstore(String key,Integer expire) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return 0;
  }
  destKey = assembleCacheKey(destKey);
  if (StringUtils.isEmpty(destKey)) {
   return 0;
  }
  if (CollectionUtils.isEmpty(otherKeys)) {
   return 0;
  }
  List<String> finalOtherKeys = new ArrayList<>();
  for (String eachOtherKey : otherKeys) {
   finalOtherKeys.add(assembleCacheKey(eachOtherKey));
  }
  Long result = stringRedisTemplate.opsForZSet().intersectAndStore(key,finalOtherKeys,destKey);
  if (null == result || result <= 0) {
   return 0;
  }
  if (null != expire) {
   stringRedisTemplate.expire(destKey,TimeUnit.SECONDS);
  }
  return result;
 }

 @Override
 public String zfirst(String key) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return null;
  }
  Set<String> stringSet = stringRedisTemplate.opsForZSet().range(key,0);
  return CollectionUtils.isEmpty(stringSet) ? null : stringSet.toArray()[0].toString();
 }

 @Override
 public boolean zrem(String key,String member) {
  if (StringUtils.isEmpty(member)) {
   return false;
  }
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return false;
  }
  Long result = stringRedisTemplate.opsForZSet().remove(key,member);
  return null != result && result > 0;
 }

 @Override
 public Map<String,Double> zscan(String key) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return null;
  }
  try {
   Cursor<ZSetOperations.TypedTuple<String>> tupleCursor = stringRedisTemplate.opsForZSet().scan(key,ScanOptions.scanOptions().build());
   Map<String,Double> result = new HashMap<>();
   while (tupleCursor.hasNext()) {
    ZSetOperations.TypedTuple<String> tuple = tupleCursor.next();
    result.put(tuple.getValue(),tuple.getScore());
   }
   return result;
  } catch (Exception e) {
   e.printStackTrace();
   return null;
  }
 }

 @Override
 public Double zincrby(String key,Integer expire) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return null;
  }
  Double score = stringRedisTemplate.opsForZSet().incrementScore(key,incrScore);
  if (null != expire && expire > 0) {
   stringRedisTemplate.expire(key,TimeUnit.SECONDS);
  }
  return score;
 }

 @Override
 public Double zscore(String key,String member) {
  if (StringUtils.isEmpty(member)) {
   return null;
  }
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return null;
  }
  return stringRedisTemplate.opsForZSet().score(key,member);
 }

 @Override
 public void hput(String key,Integer expire) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return;
  }
  stringRedisTemplate.opsForHash().put(key,hashKey,value);
  if (null != expire && expire > 0) {
   stringRedisTemplate.expire(key,TimeUnit.SECONDS);
  }
 }

 @Override
 public void hdel(String key,String hashKey) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return;
  }
  stringRedisTemplate.opsForHash().delete(key,hashKey);
 }

 @Override
 public Object hget(String key,String hashKey) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return null;
  }
  return stringRedisTemplate.opsForHash().get(key,hashKey);
 }

 @Override
 public Long hsize(String key) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return null;
  }
  return stringRedisTemplate.opsForHash().size(key);
 }

 @Override
 public List<Object> hgetAll(String key) {
  key = assembleCacheKey(key);
  if (StringUtils.isEmpty(key)) {
   return null;
  }
  return stringRedisTemplate.opsForHash().values(key);
 }

 @Override
 public void batchInsert(List<Map<String,int timeout) {
  /* 插入多條資料 */
  stringRedisTemplate.executePipelined(new SessionCallback<Object>() {
   @Override
   public <K,V> Object execute(RedisOperations<K,V> redisOperations) throws DataAccessException {
    for (Map<String,String> needSave : saveList) {
     stringRedisTemplate.opsForValue().set(needSave.get("key"),needSave.get("value"),timeout,unit);
    }
    return null;
   }
  });
 }

 @Override
 public List<String> batchGet(List<String> keyList) {
  /* 批量獲取多條資料 */
  List<Object> objects = stringRedisTemplate.executePipelined(new RedisCallback<String>() {
   @Override
   public String doInRedis(RedisConnection redisConnection) throws DataAccessException {
    StringRedisConnection stringRedisConnection = (StringRedisConnection) redisConnection;
    for (String key : keyList) {
     stringRedisConnection.get(key);
    }
    return null;
   }
  });

  List<String> collect = objects.stream().map(val -> String.valueOf(val)).collect(Collectors.toList());

  return collect;
 }

}

到此這篇關於Redis整合SpringBoot的RedisTemplate實現類的文章就介紹到這了,更多相關Redis整合SpringBoot實現類內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！