Redis 客户端
概述
Redis 是一种C/S 架构的分布式缓存数据库,它有自带的命令行客户端,也有对应的Java或其它语言客户端,可以在这些客户端中通过一些API对redis进行读写操作。
准备工作
第一步:创建工程。
创建maven父工程,例如03-redis,并在此工程下创建两个子工程,一个为redis-jedis,一个为redis-template,例如:
第二步:添加父工程依赖
修改父工程pom.xml文件,添加编译配置
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<configuration>
<source>8</source>
<target>8</target>
</configuration>
</plugin>
</plugins>
</build>
Jedis的基本应用
简介
Jedis是Java中操作redis的一个客户端,类似通过jdbc访问mysql数据库。
准备工作
在redis-jedis 工程添加如下依赖
<dependencies>
<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>3.5.2</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.8.6</version>
</dependency>
</dependencies>
Jeids基本应用实践
在Jedis工程中的src/test/java目录创建单元测类,例如:
package com.jt;
import org.junit.Test;
import redis.clients.jedis.Jedis;
import java.util.concurrent.TimeUnit;
public class JedisTests {
/**
* 测试是否可以连通redis。
*/
@Test
public void testGetConnection(){
Jedis jedis=new Jedis("192.168.126.129",6379);
String result = jedis.ping();
System.out.println(result);
}
/**
* 测试字符串操作
*/
@Test
public void testStringOper01(){
//1.建立连接
Jedis jedis=new Jedis("192.168.126.129",6379);
//2.执行redis数据操作(增删改查)
//2.1新增数据
jedis.set("id", "100");
jedis.set("name", "tony");
//2.2修改数据
jedis.incr("id");
jedis.incrBy("id", 100);//201
jedis.set("name", "Mike");//Mike
//2.3查询数据
String id = jedis.get("id");
String name = jedis.get("name");
System.out.println("id="+id+";name="+name);
//2.4删除数据
jedis.del("name");
//3.释放资源
jedis.close();
}
/**
* 测试字符串操作
*/
@Test
public void testStringOper02(){
//1.建立连接
Jedis jedis=new Jedis("192.168.126.129",6379);
//2.数据操作(将一个map对象转换为json字符串,然后写入到redis)
//2.1构建map对象
Map<String,String> map=new HashMap<>();
map.put("id", "100");
map.put("name", "Mike");
//2.2将map转换为字符串
Gson gson=new Gson();
String jsonStr = gson.toJson(map);
//2.3将字符串写入到redis
String key= UUID.randomUUID().toString();
jedis.set(key, jsonStr);
//3.释放资源
jedis.close();
}
/**
* 课堂练习:
* 基于hash类型将testStringOper02中对象写入到redis,
* 并且尝试进行查询,修改,删除等操作。
*/
@Test
public void testHash01(){
//1.建立连接
Jedis jedis=new Jedis("192.168.126.129",6379);
//2.执行hash数据操作
//2.1新增数据
String key= UUID.randomUUID().toString();
jedis.hset(key, "id", "500");
jedis.hset(key, "name", "Jack");
//2.2修改数据数据
jedis.hset(key, "name", "Jim");
//2.3查询数据
Map<String, String> map = jedis.hgetAll(key);
System.out.println(map);
//2.4删除数据
//jedis.del(key);
jedis.expire(key, 10);
//3.释放资源
jedis.close();
}
/**
* 测试:redis中list结构的应用
* 基于FIFO(First In First Out)算法,借助redis实现一个队列
*/
@Test
public void testListOper01(){
//1.建立连接
Jedis jedis=new Jedis("192.168.126.130",6379);
//2.存储数据
jedis.lpush("lst1","A","B","C","C");
//3.更新数据
Long pos=jedis.lpos("lst1","A");//获取A元素的位置
jedis.lset("lst1",pos,"D");//将A元素位置的内容修改为D
//4.获取数据
int len=jedis.llen("lst1").intValue();//获取lst1列表中元素个数
List<String> rpop = jedis.rpop("lst1",len);//获取lst1列表中所有元素
System.out.println(rpop);
//5.释放资源
jedis.close();
}
//list类型练习:实现一个阻塞式队列
@Test
public void testListOper02(){
//1.连接redis
Jedis jedis=new Jedis("192.168.126.128",6379);
//2.向队列存数据
//jedis.lpush("list1","A","B","C");
//3.按先进先出的顺序从队列取数据
List<String> list= jedis.brpop(40,"list1");
System.out.println(list);
jedis.brpop(40,"list1");
jedis.brpop(40,"list1");
jedis.brpop(40,"list1");
//4.释放资源
jedis.close();
}
//set类型练习
@Test
public void testSetOper01() {
//1.连接redis
Jedis jedis = new Jedis("192.168.126.128", 6379);
//2.朋友圈点赞
jedis.sadd("count", "1", "1", "2");
//3.取出点赞数
Set<String> set = jedis.smembers("count");
System.out.println(set);
//4.释放资源
jedis.close();
}
}
连接池JedisPool连接池应用
我们直接基于Jedis访问redis时,每次获取连接,释放连接会带来很大的性能开销,可以借助Jedis连接池,重用创建好的连接,来提高其性能,简易应用方式如下:
package com.jt;
import org.junit.Test;
import redis.clients.jedis.Jedis;
import redis.clients.jedis.JedisPool;
import redis.clients.jedis.JedisPoolConfig;
public class JedisPoolTests {
@Test
public void testJedisPool(){
//定义连接池的配置
JedisPoolConfig config=new JedisPoolConfig();
config.setMaxTotal(1000);//最大连接数
config.setMaxIdle(60);//最大空闲数
//创建连接池
JedisPool jedisPool=
new JedisPool(config,"192.168.126.130",6379);
//从池中获取一个连接
Jedis resource = jedisPool.getResource();
resource.auth("123456");
//通过jedis连接存取数据
resource.set("class","cgb2004");
String clazz=resource.get("class");
System.out.println(clazz);
//将链接返回池中
resource.close();
//关闭连接池
jedisPool.close();
}
}
我们可以基于池对象,设计一个数据源,将来在业务中通过一个数据源对象,从池中获取连接,不用每次获取连接都要创建池对象,例如:
package com.jt.redis;
import redis.clients.jedis.Jedis;
import redis.clients.jedis.JedisPool;
import redis.clients.jedis.JedisPoolConfig;
public class JedisDataSource {
private static final String IP="192.168.126.128";
private static final int PORT=6379;//redis.conf 默认端口
/**
* volatile 关键通常用于修饰属性:
* 1)保证线程其可见性(一个线程改了,其它CPU线程立刻可见)
* 2)禁止指令重排序
* 3)不能保证其原子性(不保证线程安全)
*/
private static volatile JedisPool jedisPool;
//方案1:饿汉式池对象的创建
/*static{
JedisPoolConfig config=new JedisPoolConfig();
config.setMaxTotal(16);
config.setMaxIdle(8);
jedisPool=new JedisPool(config,IP,PORT);
}
public static Jedis getConnection(){
return jedisPool.getResource();
}*/
//方案2:懒汉式池对象的创建
public static Jedis getConnection(){
if(jedisPool==null) {
synchronized (JedisDataSource.class) {
if (jedisPool == null) {
JedisPoolConfig config = new JedisPoolConfig();
config.setMaxTotal(16);
config.setMaxIdle(8);
jedisPool = new JedisPool(config, IP, PORT);
//创建对象分析
//1.开辟内存空间
//2.执行属性的默认初始化
//3.执行构造方法
//4.将创建的对象的内存地址赋值给jedisPool变量
//假如使用了volatile修饰jedisPool变量,可以保证如上几个步骤是顺序执行的
}
}
}
return jedisPool.getResource();
}
public static void close(){
jedisPool.close();
}
}
RedisTemplate基本应用
简介
RedisTemplate为SpringBoot工程中操作redis数据库的一个Java对象,此对象封装了对redis的一些基本操作。
准备工作
第一步:添加在redis-template工程添加依赖
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-dependencies</artifactId>
<version>2.3.2.RELEASE</version>
<scope>import</scope>
<type>pom</type>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
第二步:创建工程配置文件application.yml,其内容如下:
spring:
redis:
host: 192.168.126.129 #写自己的ip
port: 6379
1234
第三步:创建工程启动类,例如:
package com.jt;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class RedisApplication {
public static void main(String[] args) {
SpringApplication.run(RedisApplication.class,args);
}
}
RedisTemplate对象应用实践
RedisTemplate是一个专门用于实现对远端redis数据进行操作的对象,默认会采用JDK序列化方式存取数据,应用案例如下:
package com.jt.redis;
@SpringBootTest
public class RedisTemplateTests {
/**
* 此对象为操作redis的一个模板对象,基于此对象进行数据存储时,
* 数据会进行序列化,序列化方式默认为JDK自带的序列化机制。
*/
@Autowired
private RedisTemplate redisTemplate;
/**测试是否能够连通redis*/
@Test
void testGetConnection(){
RedisConnection connection =
redisTemplate.getConnectionFactory()
.getConnection();
String result = connection.ping();
System.out.println(result);
}
@Test
void testStringOper01(){
//1.获取字符串操作对象(ValueOperations)
ValueOperations vo = redisTemplate.opsForValue();
//2.操作redis数据
vo.set("x", 100);
Object x = vo.get("x");
System.out.println(x);
//vo.increment("x");//不可以
Long y = vo.increment("y");
y=vo.increment("y");
//Object y = vo.get("y");//不可以
System.out.println(y);
//存储key/value,设置key的有效期
vo.set("z", "100", Duration.ofSeconds(10));
}
@Test
void testStringOper02(){
//1.获取字符串操作对象(ValueOperations)
ValueOperations vo = redisTemplate.opsForValue();
//2.按默认序列化方式存储数据
String token= UUID.randomUUID().toString();
vo.set(token,"admin");
//3.指定序列方式进行数据存储
redisTemplate.setKeySerializer(RedisSerializer.string());
redisTemplate.setValueSerializer(RedisSerializer.string());
vo.set(token,"Mike");
//4.更新数据(假如有对应的key则直接进行覆盖)
vo.set(token, "Jack");
Object value = vo.get(token);
System.out.println(value);
//5.删除数据(存数据时给定有效期-生产环境必须设置)
vo.set("permissions", "sys:res:update",Duration.ofSeconds(5));
}
@Test
void testHashOper01(){
//1.获取Hash操作对象(ValueOperations)
HashOperations ho = redisTemplate.opsForHash();
//2.以hash类型存储数据
ho.put("blog","id",100);
ho.put("blog", "title", "redis....");
//3.获取数据
Object id = ho.get("blog", "id");
Object title = ho.get("blog", "title");
System.out.println("id="+id+";title="+title);
Map blog = ho.entries("blog");//取key对应的所有值。
System.out.println(blog);
}
/**
* 设计一个Blog类,然后通过redisTemplate将此类的对象写入到redis数据库
* 两种方案:
* 1)方案1:基于ValueOperations对象实现数据存取
* 2)方案2:基于HashOperations对象实现数据存储
*/
@Test
void testHashOper02() throws JsonProcessingException {
//1.获取数据操作对象(ValueOperations,HashOperations)
ValueOperations vo = redisTemplate.opsForValue();
HashOperations ho = redisTemplate.opsForHash();
//2.基于ValueOperations存取Blog对象
Blog blog=new Blog();
blog.setId(100L);
blog.setTitle("redis ...");
vo.set("blog-jack", blog);//序列化
Object o = vo.get("blog-jack");//反序列化
System.out.println(o);
//3.基于HashOperations存取Blog对象
ObjectMapper objectMapper=new ObjectMapper();//jackson
String jsonStr=objectMapper.writeValueAsString(blog);
Map map = objectMapper.readValue(jsonStr, Map.class);
ho.putAll("blog-mike", map);
ho.put("blog-mike","id","200");
map=ho.entries("blog-mike");
System.out.println(map);
}
@Test
void testListOper(){
//向list集合放数据
ListOperations listOperations = redisTemplate.opsForList();
listOperations.leftPush("lstKey1", "100"); //lpush
listOperations.leftPushAll("lstKey1", "200","300");
listOperations.leftPush("lstKey1", "100", "105");
listOperations.rightPush("lstKey1", "700");
Object value= listOperations.range("lstKey1", 0, -1);
System.out.println(value);
//从list集合取数据
Object v1=listOperations.leftPop("lstKey1");//lpop
System.out.println("left.pop.0="+v1);
value= listOperations.range("lstKey1", 0, -1);
System.out.println(value);
}
@Test
void testSetOper(){
SetOperations setOperations=redisTemplate.opsForSet();
setOperations.add("setKey1", "A","B","C","C");
Object members=setOperations.members("setKey1");
System.out.println("setKeys="+members);
//........
}
@Test
void testFlushdb(){
redisTemplate.execute(new RedisCallback() {
@Override
public Object doInRedis(RedisConnection redisConnection) throws DataAccessException {
//redisConnection.flushDb();
redisConnection.flushAll();
return "flush ok";
}
});
}
@Test
void testGetConnection(){
RedisConnection connection =
stringRedisTemplate.getConnectionFactory()
.getConnection();
String ping = connection.ping();
System.out.println(ping);
}
}
创建Blog对象,然后基于RedisTemplate进行序列化实践,Blog代码如下
package com.jt.redis.pojo;
import java.io.Serializable;
public class Blog implements Serializable {//{"id":10,"title":"redis"}
private static final long serialVersionUID = -6721670401642138021L;
private Integer id;
private String title;
public Blog(){
System.out.println("Blog()");
}
public Blog(Integer id,String title){
this.id=id;
this.title=title;
}
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getTitle() {
return title;
}
public void setTitle(String title) {
this.title = title;
}
@Override
public String toString() {
return "Blog{" +
"id=" + id +
", title='" + title + '\'' +
'}';
}
}
在RedisTemplateTests类中添加如下单元测试方法,进行测试,例如:
@Test
void testJsonOper() throws JsonProcessingException {
ValueOperations valueOperations = redisTemplate.opsForValue();
Blog blog=new Blog(10,"study redis");
valueOperations.set("blog",blog);//序列化
blog=(Blog)valueOperations.get("blog");//反序列化
System.out.println("blog="+blog);
}
StringRedisTemplate 对象应用实践
StringRedisTemplate 是一个特殊的RedisTemplate对象,默认基于字符串序列化方式存取数据,其应用方式如下:
package com.jt.redis;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.data.redis.connection.RedisConnection;
import org.springframework.data.redis.core.HashOperations;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.data.redis.core.ValueOperations;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.TimeUnit;
@SpringBootTest
public class StringRedisTemplateTests {
/**
* 此对象为操作redis的一个客户端对象,这个对象
* 对key/value采用了字符串的序列化(StringRedisSerializer)
* 方式进行,redis数据的读写操作.
*/
@Autowired
private StringRedisTemplate stringRedisTemplate;
@Test
void testHashOper01(){
//1.获取hash操作的对象
HashOperations<String, Object, Object> vo =stringRedisTemplate.opsForHash();
//2.读写redis数据
//2.1存储一个对象
vo.put("user", "id", "100");
vo.put("user", "username", "tony");
vo.put("user", "status", "1");
//2.2获取一个对象
//2.2.1获取对象某个属性值
Object status =vo.get("user","status");
System.out.println(status);
//2.2.2获取对象某个key对应的所有值
List<Object> user = vo.values("user");
System.out.println(user);
}
@Test
void testStringOper02() throws JsonProcessingException {
//1.获取字符串操作对象(ValueOperations)
ValueOperations<String, String> vo =
stringRedisTemplate.opsForValue();
//2.读写redis中的数据
Map<String,String> map=new HashMap<>();
map.put("id","100");
map.put("title","StringRedisTemplate");
//将map对象转换为json字符串写到redis数据库
String jsonStr=//jackson (spring-boot-starter-web依赖中自带)
new ObjectMapper().writeValueAsString(map);
vo.set("blog", jsonStr);
jsonStr=vo.get("blog");
System.out.println(jsonStr);
//将json字符串转换为map对象
map=
new ObjectMapper().readValue(jsonStr, Map.class);
System.out.println(map);
}
@Test
void testStringOper01(){
//1.获取字符串操作对象(ValueOperations)
ValueOperations<String, String> vo =
stringRedisTemplate.opsForValue();
//2.读写redis中的数据
vo.set("x", "100");
vo.increment("x");
vo.set("y", "200", 1, TimeUnit.SECONDS);
String x = vo.get("x");
String y = vo.get("y");
System.out.println("x="+x+",y="+y);
}
}
基于业务定制RedisTemplate对象(拓展)
我们知道系统中的RedisTemplate默认采用的是JDK的序列化机制,假如我们不希望使用默认的JDK方式序列化,可以对RedisTemplate对象进行定制,指定自己的序列化方式,例如:
package com.jt;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
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.GenericJackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.RedisSerializer;
import java.net.UnknownHostException;
@Configuration
public class RedisConfig {//RedisAutoConfiguration
//自定义json序列化
public RedisSerializer jsonSerializer(){
//1.定义Redis序列化,反序列化规范对象(此对象底层通过ObjectMapper完成对象序列化和反序列化)
Jackson2JsonRedisSerializer serializer=
new Jackson2JsonRedisSerializer(Object.class);
//2.创建ObjectMapper(有jackson api库提供)对象,基于此对象进行序列化和反序列化
//2.1创建ObjectMapper对象
ObjectMapper objectMapper=new ObjectMapper();
//2.2设置按哪些方法规则进行序列化
objectMapper.setVisibility(PropertyAccessor.GETTER,//get方法
JsonAutoDetect.Visibility.ANY);//Any 表示任意方法访问修饰符
//对象属性值为null时,不进行序列化存储
objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
//2.2激活序列化类型存储,对象序列化时还会将对象的类型存储到redis数据库
//假如没有这个配置,redis存储数据时不存储类型,反序列化时会默认将其数据存储到map
objectMapper.activateDefaultTyping(
objectMapper.getPolymorphicTypeValidator(),//多态校验分析
ObjectMapper.DefaultTyping.NON_FINAL,//激活序列化类型存储,类不能使用final修饰
JsonTypeInfo.As.PROPERTY);//PROPERTY 表示类型会以json对象属性形式存储
serializer.setObjectMapper(objectMapper);
return serializer;
}
//高级定制
@Bean
public RedisTemplate<Object, Object> redisTemplate(
RedisConnectionFactory redisConnectionFactory) throws UnknownHostException {
RedisTemplate<Object, Object> template = new RedisTemplate();
template.setConnectionFactory(redisConnectionFactory);
//设置key的序列化方式
template.setKeySerializer(RedisSerializer.string());
template.setHashKeySerializer(RedisSerializer.string());
//设置值的序列化方式
template.setValueSerializer(jsonSerializer());
template.setHashValueSerializer(jsonSerializer());
//更新一下RedisTemplate对象的默认配置
template.afterPropertiesSet();
return template;
}
//简单定制
// @Bean
// public RedisTemplate<Object, Object> redisTemplate(
// RedisConnectionFactory redisConnectionFactory) throws UnknownHostException {
// RedisTemplate<Object, Object> template = new RedisTemplate();
// template.setConnectionFactory(redisConnectionFactory);
// //设置key的序列化方式
// template.setKeySerializer(RedisSerializer.string());
// template.setHashKeySerializer(RedisSerializer.string());
// //设置值的序列化方式
// template.setValueSerializer(RedisSerializer.json());
// template.setHashValueSerializer(RedisSerializer.json());
// return template;
// }
}
总结(Summary)
常见问题分析
- Jedis常用API有哪些?(Jedis,JedisPool,JedisPoolConfig)
- Jedis如何存储POJO对象到redis?(将对象转换为json串,将对象以Hash形式进行存储)
- RedisTemplate 对象默认的序列化方式是什么?(JDK方式)
- RedisTemplate 对象按默认规则序列化时,我们的对象需要实现序列化接口吗?(需要)
- StringRedisTemplate对象与RedisTemplate对象最本质的区别是什么?(默认序列化方式)
- RedisTemplate对象基于默认的json方式序列化时会存储对象类型吗?(会)
- 如何修改RedisTemplate对象的序列化方式?(通过setXxx等方法设置序列化)
- 为什么要定制RedisTemplate对象?
常见Bug分析
- 连不上远程redis服务?(redis服务是否启动,是否开启了防火墙,ip和账号是否正确,redis.conf配置问题)
- 基于RedisTemplate对象的incrment方法实现key值的递增时,注意值的结构类型?(Long)
- 对象序列化和反序列化异常?(一定要注意序列化规则)
本文由 liyunfei 创作,采用 知识共享署名4.0
国际许可协议进行许可
本站文章除注明转载/出处外,均为本站原创或翻译,转载前请务必署名
最后编辑时间为: Jun 29,2022