知道Redis却不知道在Java中怎么操作?保姆式教学来了
前面几篇博文介绍了Redis的发展历程，Redis的五大基本类型，以及Redis的事务。今天的博文总结一下再Java在中Redis的使用，这也是Java开发工程师必须熟练掌握的操作。因此这篇博文的操作是重要的。
文章目录
- 在Java中使用Redis
-
- 总结
- 可能出现的异常
- 在SpringBoot中使用Redis
-
- 概述
- 如何在SringBoot中使用Redis
- 小坑
- 自定义RedisTemplate
- 自定义RedsUtils
在Java中使用Redis
首先要明确在Java中操作Reids要使用Jedis工具包。
Jedis是Redis官方推荐的Java连接开发工具，使用Java操作Redis的中间件！如果你要使用Java操作Redis，那么一定要对Jedis特别熟悉。重要性不言而喻。
首先要在Java中要使用Redis需要导入Jedis的包。如果你创建的是一个maven项目，那么可以导入依赖即可。
<dependency>
<groupId>redis.clientsgroupId>
<artifactId>jedisartifactId>
<version>2.6.0version>
dependency>
创建项目并测试连接
import redis.clients.jedis.Jedis;
/**
* @author 雷雨
* @date 2020/12/28 13:30
*/
public class MyJedis {
public static void main(String[] args) {
//直接new jedis对象即可.
Jedis jedis = new Jedis("127.0.0.1", 6379);
//原来我们在Redis中进行ping的话,输出pong的话就是连接成功，在Java中也是同样的
System.out.println(jedis.ping());
}
}
使用Java操作Redis
import redis.clients.jedis.Jedis;
import java.util.Set;
/**
* @author 雷雨
* @date 2020/12/30 19:29
*/
public class JedisTest {
public static void main(String[] args) {
Jedis jedis = new Jedis("127.0.0.1", 6379);
System.out.println("清空所有数据库的数据"+jedis.flushAll());
System.out.println("清空当前数据库数据"+jedis.flushDB());
System.out.println("判断某一个键是否存在"+jedis.exists("name"));
System.out.println("新增" +jedis.set("name","leiyu"));
System.out.println("新增" +jedis.set("passwrd","123"));
System.out.println("系统中的所有键如下:");
Set<String> keys = jedis.keys("*");
System.out.println(keys);
System.out.println("删除键password"+jedis.del("password"));
System.out.println("判断键password是否还存在" + jedis.exists("password"));
System.out.println("返回name所存储的值的类型"+ jedis.type("name"));
System.out.println("返回key空间的任意一个"+ jedis.randomKey());
System.out.println("重命名key"+ jedis.rename("name","username"));
System.out.println("清空当前数据库" + jedis.flushDB());
}
}
总结
- 导入依赖
- 创建项目测试连接（这一步尽量不要省略，能保证我们在写业务代码之前环境是正常的）
- Java操作Redis
可能出现的异常
这是我在亲手码代码阶段出现的简单的异常，这里做一个记录，希望能对各位有启发。
- java.net.SocketTimeoutException: connect timed out
这是可能出现的异常。导致的原因是连接超时，也就是我们可能是Redis的服务没有开启。我们需要在后台运行Redis的服务，这时再运行。我们使用Java操作Redis，是操作Redis而没有启动Redis的相关操作。如果是在windows操作系统上，我们需要手动的开启Redis的服务，而如果在Linux操作系统上（如果是在项目中部署时使用到Redis），一般我们都是使用Redis的服务默认开机启动，因此一般不会出现这样的问题。
在SpringBoot中使用Redis
概述
说明：在SpringBoot2.x之后，原理使用的Jedis被替换成lettuce。
- jedis：采用的直连，多个线程操作的话是不安全的，如果想要避免不安全，使用jedis pool连接池！
- lettuce：采用nettu，实例可以在多个线程中进行共享，不存在线程不安全的情况！可以减少线程数据，思想更像NIO模式。
如何在SringBoot中使用Redis
- 创建SpringBoot项目
- 导入依赖（如果是使用IDEA创建的话，可以直接在IDEA中直接选择redis的功能就会自动导入依赖）
- 编写配置文件
- 测试连接（不建议省略,可以测试环境成功)
- 测试基本使用
配置文件
spring.redis.host=127.0.0.1
spring.redis.port=6379
说明:SpringBoot的所有配置类，都有一个自动配置类。
自动配置类都会绑定一个properties配置文件 RedisProperties
可配置的都在RedisProperties类中
//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//
package org.springframework.boot.autoconfigure.data.redis;
import java.time.Duration;
import java.util.List;
import org.springframework.boot.context.properties.ConfigurationProperties;
@ConfigurationProperties(
prefix = "spring.redis"
)
public class RedisProperties {
private int database = 0; //默认数据库个数
private String url; //
private String host = "localhost"; //默认IP地址
private String password; //Redis密码(Redis是可以设置密码的)
private int port = 6379; //默认端口号
private boolean ssl; //ssl连接
private Duration timeout; //超时时间
private String clientName; //客户端名称
private RedisProperties.Sentinel sentinel;
private RedisProperties.Cluster cluster;
private final RedisProperties.Jedis jedis = new RedisProperties.Jedis();
private final RedisProperties.Lettuce lettuce = new RedisProperties.Lettuce();
//这里展示部分代码
}
RedisAutoConfiguration
给我们提供了两个Redis的模板类
@Configuration(
proxyBeanMethods = false
)
@ConditionalOnClass({
RedisOperations.class})
@EnableConfigurationProperties({
RedisProperties.class})
@Import({
LettuceConnectionConfiguration.class, JedisConnectionConfiguration.class})
public class RedisAutoConfiguration {
public RedisAutoConfiguration() {
}
@Bean
@ConditionalOnMissingBean(name = {
"redisTemplate"}) //这个注解什么作用呢,就是当没有类叫做redisTemplate时这个类就生效,也就是说默认是这个类生效,如果有需要就自己写一个类来替换这个类
public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) throws UnknownHostException {
//默认的ReisTemplate,没有过多的设置,而Redis保存对象的话都是要进行序列化的
//两个泛型都是Object类型后面使用的话需要强制转换
//因为我们都知道才是我们想要的类型
RedisTemplate<Object, Object> template = new RedisTemplate();
template.setConnectionFactory(redisConnectionFactory);
return template;
}
@Bean
@ConditionalOnMissingBean
public StringRedisTemplate stringRedisTemplate(RedisConnectionFactory redisConnectionFactory) throws UnknownHostException {
StringRedisTemplate template = new StringRedisTemplate();
template.setConnectionFactory(redisConnectionFactory);
return template;
}
}
还有很多可选的配置,如果有需要就配置
这里需要注意一个小坑:
因为我们在SpringBoot2.x之后默认注入的是lettuce，因此在写配置的时候，要写lettuce的相关配置（比如配置连接池等等），而不能写Jedis的配置，否则不生效。
package per.leiyu;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.SetOperations;
import redis.clients.jedis.Jedis;
@SpringBootTest
class Redis02SpringbootApplicationTests {
//直接注入RedisTemlate就好了 因为防止有重类型的使用了@Qualifier注解
@Qualifier("redisTemplate")
@Autowired
private RedisTemplate redisTemplate;
@Test
void contextLoads() {
}
@Test
void test1() {
//RedisConnection connection = redisTemplate.getConnectionFactory().getConnection();
// redisTemplate.opsForSet().add("name","leiyujia");
// System.out.println(redisTemplate.opsForValue().get("name"));
redisTemplate.opsForValue().set("name","leyujia666");
System.out.println(redisTemplate.opsForValue().get("name"));
}
@Test
void test2(){
Jedis jedis = new Jedis("127.0.0.1", 6379);
jedis.set("name","leiyu888");
System.out.println(jedis.get("name"));
}
}
测试使用Test2。控制台会输出leiyu888。
小坑
Redis的使用时需要序列化。如果不序列化，那么就会中文乱码。
比如还是测试Test2那个示例
@Test
void test2(){
Jedis jedis = new Jedis("127.0.0.1", 6379);
jedis.set("name","我是雷雨佳");
System.out.println(jedis.get("name"));
}
我们期望的输出是"我是雷雨佳"
但是在Redis中会输出中文乱码。为什么呢？
我们看源码，我们在RedisTemplate类中中配置了序列化。
而在RedisTemplate类中默认使用的是Jdk序列化。因为采用的是jdk序列化,会让中文字符串转义,而我们更加期望json序列化,因此这时候就更加需要自定义一个配置类来使用json序列化。
public void afterPropertiesSet() {
super.afterPropertiesSet();
boolean defaultUsed = false;
if (this.defaultSerializer == null) {
//默认初始化了一个jdk的序列化,会让我们的中文字符串转义,而我们更加期望的是json来序列化这时候自定义一个配置类就显得关键
this.defaultSerializer = new JdkSerializationRedisSerializer(this.classLoader != null ? this.classLoader : this.getClass().getClassLoader());
}
if (this.enableDefaultSerializer) {
if (this.keySerializer == null) {
this.keySerializer = this.defaultSerializer;
defaultUsed = true;
}
if (this.valueSerializer == null) {
this.valueSerializer = this.defaultSerializer;
defaultUsed = true;
}
if (this.hashKeySerializer == null) {
this.hashKeySerializer = this.defaultSerializer;
defaultUsed = true;
}
if (this.hashValueSerializer == null) {
this.hashValueSerializer = this.defaultSerializer;
defaultUsed = true;
}
}
if (this.enableDefaultSerializer && defaultUsed) {
Assert.notNull(this.defaultSerializer, "default serializer null and not all serializers initialized");
}
if (this.scriptExecutor == null) {
this.scriptExecutor = new DefaultScriptExecutor(this);
}
this.initialized = true;
}
如何自定义一个自定义序列化呢？我们使用的redisTemplate时，如果没有我们自定义的redisTemplate时就会使用默认的redisTemplate，这时就会使用默认的序列化（jdk序列化），因此我们可以自定义一个redisTemplate，在其中自定义序列化方式，从而达到自定义序列化。并且默认的redisTemplate也不能满足我们使用的需求，默认的redisTemplate是< Object,Object>的泛型,在使用时需要强制转换，我们在自定义redisTemplate时也可以将其泛型改变。
自定义RedisTemplate
自定义的好处小总结：
- 改变原本redisTemplate泛型在使用时需要强转的麻烦。
- 改变默认序列化方式是jdk序列化导致中文需要转移的麻烦。
提供一个RedisTemplate的一个模板
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
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.RedisTemplate;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;
@Configuration
public class RedisConfig {
@Bean
@SuppressWarnings("all")
public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
RedisTemplate<String, Object> template = new RedisTemplate<String, Object>();
template.setConnectionFactory(factory);
Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
ObjectMapper om = new ObjectMapper();
om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
jackson2JsonRedisSerializer.setObjectMapper(om);
StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();
// key采用String的序列化方式
template.setKeySerializer(stringRedisSerializer);
// hash的key也采用String的序列化方式
template.setHashKeySerializer(stringRedisSerializer);
// value序列化方式采用jackson
template.setValueSerializer(jackson2JsonRedisSerializer);
// hash的value序列化方式采用jackson
template.setHashValueSerializer(jackson2JsonRedisSerializer);
template.afterPropertiesSet();
return template;
}
}
自定义RedsUtils
刚才解决了RedisTemplate序列化的问题，现在解决Redis在Java中使用操作难的问题，我们在使用Java操作Redis时会发现，操作时都需要先点出来，比如
redisTemplate.opsForValue().set("name","leyujia666");
而这样是比较麻烦的,我们期望每次都能直接去操作业务方面,因此可以写一个工具类。
这里提供一个写好的工具类，可以在企业开发中使用
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;
@Component
public final class RedisUtil {
@Autowired
private RedisTemplate<String, Object> redisTemplate;
// =============================common============================
/**
* 指定缓存失效时间
* @param key 键
* @param time 时间(秒)
*/
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)
*/
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)
*/
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
*/
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 对应多个键值
*/
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)
*/
public double hincr(String key, String item, double by) {
return redisTemplate.opsForHash().increment(key, item, by);
}
/**
* hash递减
*
* @param key 键
* @param item 项
* @param by 要减少记(小于0)
*/
public double hdecr(String key, String item, double by) {
return redisTemplate.opsForHash().increment(key, item, -by);
}
// ============================set=============================
/**
* 根据key获取Set中的所有值
* @param key 键
*/
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 键
*/
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代表所有值
*/
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 键
*/
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倒数第二个元素，依次类推
*/
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 值
*/
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 时间(秒)
*/
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;
}
}
}
题外话:年底了最后一天了，今天很幸运又收获到一个公司的offer，说明我的技术得到了该公司的认可，我内心还是很开心的。念念不忘，必有回响。希望新的一年，诸事顺利。我是雷雨佳，希望和大家一起努力。