需求背景
1. Springboot集成Redis,以及一些常用api用法
2. 统一封装工具类,解决中文乱码问题
准备内容
确保本机上已安装好Redis了(Redis系列教程)
代码演示
项目目录结构:
1. spring-boot-starter-data-redis插件
本项目中使用的redis的maven插件
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
2. application.yml文件配置,连接redis
server:
port: 9090
spring:
redis:
host: localhost
port: 7379
password: a123456
timeout: 10000
max-wait: -1
注:这里我把默认redis的端口6379,改成了7379,同时增加了redis密码验证(教程),建议你也都这么做
3. redis工具封装类
RedisUtil.java代码
package com.md.demo.redis.util;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.util.CollectionUtils;
/**
* @author Minbo
*
*/
public class RedisUtil {
/**
* 指定缓存失效时间
*
* @param key 键
* @param time 时间(秒)
* @return
*/
public static boolean expire(RedisTemplate<String, Object> redisTemplate, 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 static long getExpire(RedisTemplate<String, Object> redisTemplate, String key) {
return redisTemplate.getExpire(key, TimeUnit.SECONDS);
}
/**
* 判断key是否存在
*
* @param key 键
* @return true 存在 false不存在
*/
public static boolean hasKey(RedisTemplate<String, Object> redisTemplate, String key) {
try {
return redisTemplate.hasKey(key);
} catch (Exception e) {
e.printStackTrace();
return false;
}
}
/**
* 删除缓存
*
* @param key 可以传一个值 或多个
*/
@SuppressWarnings("unchecked")
public static void del(RedisTemplate<String, Object> redisTemplate, 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 static Object get(RedisTemplate<String, Object> redisTemplate, String key) {
return key == null ? null : redisTemplate.opsForValue().get(key);
}
/**
* 普通缓存放入
*
* @param key 键
* @param value 值
* @return true成功 false失败
*/
public static boolean set(RedisTemplate<String, Object> redisTemplate, 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 static boolean set(RedisTemplate<String, Object> redisTemplate, String key, Object value, long time) {
try {
if (time > 0) {
redisTemplate.opsForValue().set(key, value, time, TimeUnit.SECONDS);
} else {
set(redisTemplate, key, value);
}
return true;
} catch (Exception e) {
e.printStackTrace();
return false;
}
}
/**
* 递增
*
* @param key 键
* @param by 要增加几(大于0)
* @return
*/
public static long incr(RedisTemplate<String, Object> redisTemplate, String key, long delta) {
if (delta < 0) {
throw new RuntimeException("递增因子必须大于0");
}
return redisTemplate.opsForValue().increment(key, delta);
}
/**
* 递减
*
* @param key 键
* @param by 要减少几(小于0)
* @return
*/
public static long decr(RedisTemplate<String, Object> redisTemplate, 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 static Object hget(RedisTemplate<String, Object> redisTemplate, String key, String item) {
return redisTemplate.opsForHash().get(key, item);
}
/**
* 获取hashKey对应的所有键值
*
* @param key 键
* @return 对应的多个键值
*/
public static Map<Object, Object> hmget(RedisTemplate<String, Object> redisTemplate, String key) {
return redisTemplate.opsForHash().entries(key);
}
/**
* HashSet
*
* @param key 键
* @param map 对应多个键值
* @return true 成功 false 失败
*/
public static boolean hmset(RedisTemplate<String, Object> redisTemplate, 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 static boolean hmset(RedisTemplate<String, Object> redisTemplate, String key, Map<String, Object> map,
long time) {
try {
redisTemplate.opsForHash().putAll(key, map);
if (time > 0) {
expire(redisTemplate, key, time);
}
return true;
} catch (Exception e) {
e.printStackTrace();
return false;
}
}
/**
* 向一张hash表中放入数据,如果不存在将创建
*
* @param key 键
* @param item 项
* @param value 值
* @return true 成功 false失败
*/
public static boolean hset(RedisTemplate<String, Object> redisTemplate, 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 static boolean hset(RedisTemplate<String, Object> redisTemplate, String key, String item, Object value,
long time) {
try {
redisTemplate.opsForHash().put(key, item, value);
if (time > 0) {
expire(redisTemplate, key, time);
}
return true;
} catch (Exception e) {
e.printStackTrace();
return false;
}
}
/**
* 删除hash表中的值
*
* @param key 键 不能为null
* @param item 项 可以使多个 不能为null
*/
public static void hdel(RedisTemplate<String, Object> redisTemplate, String key, Object... item) {
redisTemplate.opsForHash().delete(key, item);
}
/**
* 判断hash表中是否有该项的值
*
* @param key 键 不能为null
* @param item 项 不能为null
* @return true 存在 false不存在
*/
public static boolean hHasKey(RedisTemplate<String, Object> redisTemplate, String key, String item) {
return redisTemplate.opsForHash().hasKey(key, item);
}
/**
* hash递增 如果不存在,就会创建一个 并把新增后的值返回
*
* @param key 键
* @param item 项
* @param by 要增加几(大于0)
* @return
*/
public static double hincr(RedisTemplate<String, Object> redisTemplate, String key, String item, double by) {
return redisTemplate.opsForHash().increment(key, item, by);
}
/**
* hash递减
*
* @param key 键
* @param item 项
* @param by 要减少记(小于0)
* @return
*/
public static double hdecr(RedisTemplate<String, Object> redisTemplate, String key, String item, double by) {
return redisTemplate.opsForHash().increment(key, item, -by);
}
// ============================set=============================
/**
* 根据key获取Set中的所有值
*
* @param key 键
* @return
*/
public static Set<Object> sGet(RedisTemplate<String, Object> redisTemplate, 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 static boolean sHasKey(RedisTemplate<String, Object> redisTemplate, 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 static long sSet(RedisTemplate<String, Object> redisTemplate, 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 static long sSetAndTime(RedisTemplate<String, Object> redisTemplate, String key, long time,
Object... values) {
try {
Long count = redisTemplate.opsForSet().add(key, values);
if (time > 0)
expire(redisTemplate, key, time);
return count;
} catch (Exception e) {
e.printStackTrace();
return 0;
}
}
/**
* 获取set缓存的长度
*
* @param key 键
* @return
*/
public static long sGetSetSize(RedisTemplate<String, Object> redisTemplate, String key) {
try {
return redisTemplate.opsForSet().size(key);
} catch (Exception e) {
e.printStackTrace();
return 0;
}
}
/**
* 移除值为value的
*
* @param key 键
* @param values 值 可以是多个
* @return 移除的个数
*/
public static long setRemove(RedisTemplate<String, Object> redisTemplate, 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 static List<Object> lGet(RedisTemplate<String, Object> redisTemplate, 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 static long lGetListSize(RedisTemplate<String, Object> redisTemplate, 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 static Object lGetIndex(RedisTemplate<String, Object> redisTemplate, String key, long index) {
try {
return redisTemplate.opsForList().index(key, index);
} catch (Exception e) {
e.printStackTrace();
return null;
}
}
/**
* 将list放入缓存
*
* @param key 键
* @param value 值
* @param time 时间(秒)
* @return
*/
public static boolean lSet(RedisTemplate<String, Object> redisTemplate, 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 static boolean lSet(RedisTemplate<String, Object> redisTemplate, String key, Object value, long time) {
try {
redisTemplate.opsForList().rightPush(key, value);
if (time > 0)
expire(redisTemplate, key, time);
return true;
} catch (Exception e) {
e.printStackTrace();
return false;
}
}
/**
* 将list放入缓存
*
* @param key 键
* @param value 值
* @param time 时间(秒)
* @return
*/
public static boolean lSet(RedisTemplate<String, Object> redisTemplate, 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 static boolean lSet(RedisTemplate<String, Object> redisTemplate, String key, List<Object> value, long time) {
try {
redisTemplate.opsForList().rightPushAll(key, value);
if (time > 0)
expire(redisTemplate, key, time);
return true;
} catch (Exception e) {
e.printStackTrace();
return false;
}
}
/**
* 根据索引修改list中的某条数据
*
* @param key 键
* @param index 索引
* @param value 值
* @return
*/
public static boolean lUpdateIndex(RedisTemplate<String, Object> redisTemplate, 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 static long lRemove(RedisTemplate<String, Object> redisTemplate, String key, long count, Object value) {
try {
Long remove = redisTemplate.opsForList().remove(key, count, value);
return remove;
} catch (Exception e) {
e.printStackTrace();
return 0;
}
}
}
4. 写字符案例:代码演示
StringRedisTestRest.java代码
package com.md.demo.rest;
import javax.annotation.Resource;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import com.md.demo.redis.util.RedisUtil;
import com.md.demo.util.JsonResult;
import com.md.demo.util.ResultCode;
/**
* @author Minbo
*/
@RestController
public class StringRedisTestRest {
protected static Logger logger = LoggerFactory.getLogger(StringRedisTestRest.class);
@Resource
private RedisTemplate<String, Object> redisTemplate;
// 例如:http://localhost:9090/set?key=name&value=minbo英文名
@RequestMapping("/set")
public JsonResult setKeyAndValue(String key, String value) {
logger.debug("访问set:key={},value={}", key, value);
RedisUtil.set(this.redisTemplate, key, value);
return new JsonResult(ResultCode.SUCCESS);
}
// 例如:http://localhost:9090/get?key=name
@RequestMapping("/get")
public JsonResult getKey(String key) {
logger.debug("访问get:key={}", key);
String result = (String) RedisUtil.get(this.redisTemplate, key);
logger.debug("get result=" + result);
return new JsonResult(ResultCode.SUCCESS, result);
}
}
操作结果:
http://localhost:9090/get?key=name
5. 写对象数据案例:代码演示
ObjectRedisTestRest.java代码
package com.md.demo.rest;
import javax.annotation.Resource;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import com.md.demo.redis.util.RedisUtil;
import com.md.demo.util.JsonResult;
import com.md.demo.util.ResultCode;
import com.md.demo.vo.Person;
/**
* @author Minbo
*/
@RestController
public class ObjectRedisTestRest {
protected static Logger logger = LoggerFactory.getLogger(ObjectRedisTestRest.class);
@Resource
private RedisTemplate<String, Object> redisTemplate;
// 例如:http://localhost:9090/setObj?id=A001&name=minbo英文名&age=100
@RequestMapping("/setObj")
public JsonResult setObj(String id, String name, Integer age) {
Person person = new Person();
person.setId(id);
person.setName(name);
person.setAge(age);
logger.debug("访问set:" + person.toString());
RedisUtil.set(this.redisTemplate, "person:" + person.getId(), person);
return new JsonResult(ResultCode.SUCCESS);
}
// 例如:http://localhost:9090/getObj?id=A001
@RequestMapping("/getObj")
public JsonResult getObj(String id) {
logger.debug("访问get:key id={}", id);
Person person = (Person) RedisUtil.get(this.redisTemplate, "person:" + id);
String result = person.toString();
logger.debug("get obj result=" + result);
return new JsonResult(ResultCode.SUCCESS, person);
}
}
操作结果:
http://localhost:9090/setObj?id=A001&name=minbo英文名&age=100
http://localhost:9090/getObj?id=A001
完整源码下载
附加资料
下一章教程
SpringBoot从入门到精通教程(十二)- Dubbo服务提供者、服务消费者整合/Zookeeper集成(最终篇)
该系列教程
至此,全部介绍就结束了
------------------------------------------------------
------------------------------------------------------
关于我(个人域名)
期望和大家一起学习,一起成长,共勉,O(∩_∩)O谢谢
欢迎交流问题,可加个人QQ 469580884,
或者,加我的群号 751925591,一起探讨交流问题
不讲虚的,只做实干家
Talk is cheap,show me the code