springboot与redis的简单整合实例

前言

redis是一个缓存、消息代理和功能丰富的键值存储。stringboot提供了基本的自动配置。本文记录一下springboot与redis的简单整合实例

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

前期准备

首先我们要有一个redis服务，由于我没有linux环境，为了方便搭建项目，直接在windows下安装，参考这篇博客：windows下安装redis服务

安装步骤：一直点下一步（偷懒，步骤9、10设置密码我没有设置）

下载、安装、启动好redis服务后我们设置一个key并获取一下

代码编写

maven引包

 <!-- redis -->
<dependency>
      <groupid>org.springframework.boot</groupid>
<artifactid>spring-boot-starter-data-redis</artifactid>
</dependency>

配置文件

我们先看一下都有哪些redis相关配置，发现好多都有默认值，而且刚好符合我们现在的测试环境，于是乎我的配置文件是这样滴....

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函数，浏览器访问测试接口

扩展工具类

关于stringredistemplate类的操作自行查阅资料，我在网上找了一个工具类，我没有测试过，但可以参考自行测试！

@suppresswarnings("all")
@component
public class redisutil {

  private static stringredistemplate template;

  /**
   * 静态注入
   */
  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();
    }
  }

  /**
   * 根据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;
    }

  }

  /**
   * 普通缓存放入并设置时间
   *
   * @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) {
        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 项 不能为null
   * @return 值
   */
  public object hget(string key, string item) {
    return template.opsforhash().get(key, item);
  }

  /**
   * 获取hashkey对应的所有键值
   *
   * @param key 键
   * @return 对应的多个键值
   */
  public map<object, object> hmget(string key) {
    return template.opsforhash().entries(key);
  }

  /**
   * hashset
   *
   * @param key 键
   * @param map 对应多个键值
   * @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 并设置时间
   *
   * @param key 键
   * @param map 对应多个键值
   * @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表中放入数据,如果不存在将创建
   *
   * @param key  键
   * @param item 项
   * @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表中放入数据,如果不存在将创建
   *
   * @param key  键
   * @param item 项
   * @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 项 可以使多个 不能为null
   */
  public void hdel(string key, object... item) {
    template.opsforhash().delete(key, item);
  }

  /**
   * 判断hash表中是否有该项的值
   *
   * @param key 键 不能为null
   * @param item 项 不能为null
   * @return true 存在 false不存在
   */
  public boolean hhaskey(string key, string item) {
    return template.opsforhash().haskey(key, item);
  }

  /**
   * hash递增 如果不存在,就会创建一个 并把新增后的值返回
   *
   * @param key 键
   * @param item 项
   * @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 项
   * @param by  要减少记(小于0)
   * @return
   */
  public double hdecr(string key, string item, double by) {
    return template.opsforhash().increment(key, item, -by);
  }

  //============================set=============================

  /**
   * 根据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;
    }
  }

  /**
   * 根据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;
    }
  }

  /**
   * 将数据放入set缓存
   *
   * @param key  键
   * @param values 值 可以是多个
   * @return 成功个数
   */
  public long sset(string key, object... values) {
    try {
      return template.opsforset().add(key, string.valueof(values));
    } catch (exception e) {
      e.printstacktrace();
      return 0;
    }
  }

  /**
   * 将set数据放入缓存
   *
   * @param key  键
   * @param time  时间(秒)
   * @param values 值 可以是多个
   * @return 成功个数
   */
  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 移除的个数
   */
  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缓存的内容
   *
   * @param key  键
   * @param start 开始
   * @param end  结束 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倒数第二个元素，依次类推
   * @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;
    }
  }

  /**
   * 根据索引修改list中的某条数据
   *
   * @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 移除的个数
   */
  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;
    }
  }
}

后记

这只是一个单机版的redis服务，而且还是windows上面的，后续有空再搭建redis集群

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。