springboot與redis的簡單整合實(shí)例

更新時間：2019年01月10日 14:49:02 作者：huanzi-qch

Redis是一個緩存、消息代理和功能豐富的鍵值存儲。StringBoot提供了基本的自動配置。這篇文章主要介紹了springboot與redis的簡單整合實(shí)例，非常具有實(shí)用價(jià)值，需要的朋友可以參考下

前言

Redis是一個緩存、消息代理和功能豐富的鍵值存儲。StringBoot提供了基本的自動配置。本文記錄一下springboot與redis的簡單整合實(shí)例

官方文檔：https://docs.spring.io/spring-boot/docs/2.1.0.RELEASE/reference/htmlsingle/

前期準(zhǔn)備

首先我們要有一個Redis服務(wù)，由于我沒有Linux環(huán)境，為了方便搭建項(xiàng)目，直接在Windows下安裝，參考這篇博客：Windows下安裝Redis服務(wù)

安裝步驟：一直點(diǎn)下一步（偷懶，步驟9、10設(shè)置密碼我沒有設(shè)置）

下載、安裝、啟動好Redis服務(wù)后我們設(shè)置一個key并獲取一下

代碼編寫

maven引包

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

配置文件

我們先看一下都有哪些Redis相關(guān)配置，發(fā)現(xiàn)好多都有默認(rèn)值，而且剛好符合我們現(xiàn)在的測試環(huán)境，于是乎我的配置文件是這樣滴....

server.port=1113
spring.application.name=redis-server

接口測試代碼

@RestController
public class Controller{

  @Autowired
  private StringRedisTemplate template;

  @RequestMapping("/redis/get/{key}")
  private String get(@PathVariable("key") String key){
    return template.opsForValue().get(key);
  }

  @RequestMapping("/redis/set/{key}/{value}")
  private Boolean set(@PathVariable("key") String key,@PathVariable("value") String value){
    boolean flag = true;
    try {
      template.opsForValue().set(key,value);
    } catch (Exception e) {
      e.printStackTrace();
      flag = false;
    }
    return flag;
  }

}

測試效果

我們直接啟動springboot的main函數(shù)，瀏覽器訪問測試接口

擴(kuò)展工具類

關(guān)于StringRedisTemplate類的操作自行查閱資料，我在網(wǎng)上找了一個工具類，我沒有測試過，但可以參考自行測試！

@SuppressWarnings("ALL")
@Component
public class RedisUtil {

  private static StringRedisTemplate template;

  /**
   * 靜態(tài)注入
   */
  public RedisUtil(StringRedisTemplate template) {
    RedisUtil.template = template;
  }

  /**
   * 指定緩存失效時間
   *
   * @param key 鍵
   * @param time 時間(秒)
   */
  private void expire(String key, long time) {
    try {
      if (time > 0) {
        template.expire(key, time, TimeUnit.SECONDS);
      }
    } catch (Exception e) {
      e.printStackTrace();
    }
  }

  /**
   * 根據(jù)key 獲取過期時間
   *
   * @param key 鍵 不能為null
   * @return 時間(秒) 返回0代表為永久有效
   */
  public long getExpire(String key) {
    return template.getExpire(key, TimeUnit.SECONDS);
  }

  /**
   * 判斷key是否存在
   *
   * @param key 鍵
   * @return true 存在 false不存在
   */
  public boolean hasKey(String key) {
    try {
      return template.hasKey(key);
    } catch (Exception e) {
      e.printStackTrace();
      return false;
    }
  }

  /**
   * 刪除緩存
   *
   * @param key 可以傳一個值 或多個
   */
  public void del(String... key) {
    if (key != null && key.length > 0) {
      if (key.length == 1) {
        template.delete(key[0]);
      } else {
        template.delete(CollectionUtils.arrayToList(key));
      }
    }
  }

  //============================String============================= 

  /**
   * 普通緩存獲取
   *
   * @param key 鍵
   * @return 值
   */
  public Object get(String key) {
    return key == null ? null : template.opsForValue().get(key);
  }

  /**
   * 普通緩存放入
   *
   * @param key  鍵
   * @param value 值
   * @return true成功 false失敗
   */
  public boolean set(String key, Object value) {
    try {
      template.opsForValue().set(key, String.valueOf(value));
      return true;
    } catch (Exception e) {
      e.printStackTrace();
      return false;
    }

  }

  /**
   * 普通緩存放入并設(shè)置時間
   *
   * @param key  鍵
   * @param value 值
   * @param time 時間(秒) time要大于0 如果time小于等于0 將設(shè)置無限期
   * @return true成功 false 失敗
   */
  public boolean set(String key, Object value, long time) {
    try {
      if (time > 0) {
        template.opsForValue().set(key, String.valueOf(value), time, TimeUnit.SECONDS);
      } else {
        set(key, value);
      }
      return true;
    } catch (Exception e) {
      e.printStackTrace();
      return false;
    }
  }

  /**
   * 遞增
   *
   * @param key 鍵
   * @return
   */
  public long incr(String key, long delta) {
    if (delta < 0) {
      throw new RuntimeException("遞增因子必須大于0");
    }
    return template.opsForValue().increment(key, delta);
  }

  /**
   * 遞減
   *
   * @param key 鍵
   * @return
   */
  public long decr(String key, long delta) {
    if (delta < 0) {
      throw new RuntimeException("遞減因子必須大于0");
    }
    return template.opsForValue().increment(key, -delta);
  }

  //================================Map================================= 

  /**
   * HashGet
   *
   * @param key 鍵 不能為null
   * @param item 項(xiàng) 不能為null
   * @return 值
   */
  public Object hget(String key, String item) {
    return template.opsForHash().get(key, item);
  }

  /**
   * 獲取hashKey對應(yīng)的所有鍵值
   *
   * @param key 鍵
   * @return 對應(yīng)的多個鍵值
   */
  public Map<Object, Object> hmget(String key) {
    return template.opsForHash().entries(key);
  }

  /**
   * HashSet
   *
   * @param key 鍵
   * @param map 對應(yīng)多個鍵值
   * @return true 成功 false 失敗
   */
  public boolean hmset(String key, Map<String, Object> map) {
    try {
      template.opsForHash().putAll(key, map);
      return true;
    } catch (Exception e) {
      e.printStackTrace();
      return false;
    }
  }

  /**
   * HashSet 并設(shè)置時間
   *
   * @param key 鍵
   * @param map 對應(yīng)多個鍵值
   * @param time 時間(秒)
   * @return true成功 false失敗
   */
  public boolean hmset(String key, Map<String, Object> map, long time) {
    try {
      template.opsForHash().putAll(key, map);
      if (time > 0) {
        expire(key, time);
      }
      return true;
    } catch (Exception e) {
      e.printStackTrace();
      return false;
    }
  }

  /**
   * 向一張hash表中放入數(shù)據(jù),如果不存在將創(chuàng)建
   *
   * @param key  鍵
   * @param item 項(xiàng)
   * @param value 值
   * @return true 成功 false失敗
   */
  public boolean hset(String key, String item, Object value) {
    try {
      template.opsForHash().put(key, item, value);
      return true;
    } catch (Exception e) {
      e.printStackTrace();
      return false;
    }
  }

  /**
   * 向一張hash表中放入數(shù)據(jù),如果不存在將創(chuàng)建
   *
   * @param key  鍵
   * @param item 項(xiàng)
   * @param value 值
   * @param time 時間(秒) 注意:如果已存在的hash表有時間,這里將會替換原有的時間
   * @return true 成功 false失敗
   */
  public boolean hset(String key, String item, Object value, long time) {
    try {
      template.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 項(xiàng) 可以使多個 不能為null
   */
  public void hdel(String key, Object... item) {
    template.opsForHash().delete(key, item);
  }

  /**
   * 判斷hash表中是否有該項(xiàng)的值
   *
   * @param key 鍵 不能為null
   * @param item 項(xiàng) 不能為null
   * @return true 存在 false不存在
   */
  public boolean hHasKey(String key, String item) {
    return template.opsForHash().hasKey(key, item);
  }

  /**
   * hash遞增 如果不存在,就會創(chuàng)建一個 并把新增后的值返回
   *
   * @param key 鍵
   * @param item 項(xiàng)
   * @param by  要增加幾(大于0)
   * @return
   */
  public double hincr(String key, String item, double by) {
    return template.opsForHash().increment(key, item, by);
  }

  /**
   * hash遞減
   *
   * @param key 鍵
   * @param item 項(xiàng)
   * @param by  要減少記(小于0)
   * @return
   */
  public double hdecr(String key, String item, double by) {
    return template.opsForHash().increment(key, item, -by);
  }

  //============================Set=============================

  /**
   * 根據(jù)key獲取Set中的所有值
   *
   * @param key 鍵
   * @return
   */
  public Set<Object> sGet(String key) {
    try {
      return Collections.singleton(template.opsForSet().members(key));
    } catch (Exception e) {
      e.printStackTrace();
      return null;
    }
  }

  /**
   * 根據(jù)value從一個set中查詢,是否存在
   *
   * @param key  鍵
   * @param value 值
   * @return true 存在 false不存在
   */
  public boolean sHasKey(String key, Object value) {
    try {
      return template.opsForSet().isMember(key, value);
    } catch (Exception e) {
      e.printStackTrace();
      return false;
    }
  }

  /**
   * 將數(shù)據(jù)放入set緩存
   *
   * @param key  鍵
   * @param values 值 可以是多個
   * @return 成功個數(shù)
   */
  public long sSet(String key, Object... values) {
    try {
      return template.opsForSet().add(key, String.valueOf(values));
    } catch (Exception e) {
      e.printStackTrace();
      return 0;
    }
  }

  /**
   * 將set數(shù)據(jù)放入緩存
   *
   * @param key  鍵
   * @param time  時間(秒)
   * @param values 值 可以是多個
   * @return 成功個數(shù)
   */
  public long sSetAndTime(String key, long time, String... values) {
    try {
      Long count = template.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 template.opsForSet().size(key);
    } catch (Exception e) {
      e.printStackTrace();
      return 0;
    }
  }

  /**
   * 移除值為value的
   *
   * @param key  鍵
   * @param values 值 可以是多個
   * @return 移除的個數(shù)
   */
  public long setRemove(String key, Object... values) {
    try {
      Long count = template.opsForSet().remove(key, values);
      return count;
    } catch (Exception e) {
      e.printStackTrace();
      return 0;
    }
  }

  //===============================list================================= 

  /**
   * 獲取list緩存的內(nèi)容
   *
   * @param key  鍵
   * @param start 開始
   * @param end  結(jié)束 0 到 -1代表所有值
   * @return
   */
  public List<String> lGet(String key, long start, long end) {
    try {
      return template.opsForList().range(key, start, end);
    } catch (Exception e) {
      e.printStackTrace();
      return null;
    }
  }

  /**
   * 獲取list緩存的長度
   *
   * @param key 鍵
   * @return
   */
  public long lGetListSize(String key) {
    try {
      return template.opsForList().size(key);
    } catch (Exception e) {
      e.printStackTrace();
      return 0;
    }
  }

  /**
   * 通過索引 獲取list中的值
   *
   * @param key  鍵
   * @param index 索引 index>=0時， 0 表頭，1 第二個元素，依次類推；index<0時，-1，表尾，-2倒數(shù)第二個元素，依次類推
   * @return
   */
  public Object lGetIndex(String key, long index) {
    try {
      return template.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 {
      template.opsForList().rightPush(key, (String) 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 {
      template.opsForList().rightPush(key, (String) 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 {
      template.opsForList().rightPushAll(key, String.valueOf(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 {
      template.opsForList().rightPushAll(key, String.valueOf(value));
      if (time > 0) {
        expire(key, time);
      }
      return true;
    } catch (Exception e) {
      e.printStackTrace();
      return false;
    }
  }

  /**
   * 根據(jù)索引修改list中的某條數(shù)據(jù)
   *
   * @param key  鍵
   * @param index 索引
   * @param value 值
   * @return
   */
  public boolean lUpdateIndex(String key, long index, Object value) {
    try {
      template.opsForList().set(key, index, (String) value);
      return true;
    } catch (Exception e) {
      e.printStackTrace();
      return false;
    }
  }

  /**
   * 移除N個值為value
   *
   * @param key  鍵
   * @param count 移除多少個
   * @param value 值
   * @return 移除的個數(shù)
   */
  public long lRemove(String key, long count, Object value) {
    try {
      Long remove = template.opsForList().remove(key, count, value);
      return remove;
    } catch (Exception e) {
      e.printStackTrace();
      return 0;
    }
  }
}

后記

這只是一個單機(jī)版的Redis服務(wù)，而且還是Windows上面的，后續(xù)有空再搭建Redis集群

以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: