Redis专题(十四)-Redis的Java客户端SpringDataRedis

1. SpringDataRedis简介

1.1.Jedis（过时）

Jedis是Redis官方推出的一款面向Java的客户端，提供了很多接口供Java语言调用。可以在Redis官网下载，当然还有一些开源爱好者提供的客户端，如Jredis、SRP等等，推荐使用Jedis。

1.2.Spring Data Redis（推荐）

Spring-data-redis是spring大家族的一部分，提供了在srping应用中通过简单的配置访问redis服务，对reids底层开发包(Jedis, JRedis, and RJC)进行了高度封装，RedisTemplate提供了redis各种操作、异常处理及序列化，支持发布订阅，并对spring 3.1 cache进行了实现。
spring-data-redis针对jedis提供了如下功能：
1.连接池自动管理，提供了一个高度封装的“RedisTemplate”类
2.针对jedis客户端中大量api进行了归类封装,将同一类型操作封装为operation接口

ValueOperations：简单K-V操作
SetOperations：set类型数据操作
ZSetOperations：zset类型数据操作
HashOperations：针对map类型的数据操作
ListOperations：针对list类型的数据操作

2.Spring Data Redis入门小Demo

2.1.准备工作

（1）构建Maven工程SpringDataRedisDemo
（2）引入Spring相关依赖、引入JUnit依赖(内容参加其它工程)
（3）引入Jedis和SpringDataRedis依赖

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.bruce.redis.demo</groupId>
<artifactId>SpringDataRedisDemo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>war</packaging>

<!-- 集中定义依赖版本号 -->
<properties>
<spring.version>4.2.4.RELEASE</spring.version>
</properties>

<dependencies>

<!-- Spring -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-beans</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aspects</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jms</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context-support</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.9</version>
</dependency>

<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>2.8.1</version>
</dependency>
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-redis</artifactId>
<version>1.7.2.RELEASE</version>
</dependency>

</dependencies>
</project>

（4）在src/main/resources下创建properties文件夹，建立redis-config.properties

# Redis settings
# server IP
redis.host=127.0.0.1
# server port
redis.port=6379
# server pass
redis.pass=
# use dbIndex
redis.database=0
# 控制一个pool最多有多少个状态为idle(空闲的)的jedis实例
redis.maxIdle=300
# 表示当borrow(引入)一个jedis实例时，最大的等待时间，如果超过等待时间(毫秒)，则直接抛出JedisConnectionException；
redis.maxWait=3000
# 在borrow一个jedis实例时，是否提前进行validate操作；如果为true，则得到的jedis实例均是可用的
redis.testOnBorrow=true

（5）在src/main/resources下创建spring文件夹 ，创建applicationContext-redis.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:cache="http://www.springframework.org/schema/cache"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc.xsd
http://www.springframework.org/schema/cache
http://www.springframework.org/schema/cache/spring-cache.xsd">

<context:property-placeholder location="classpath*:properties/*.properties" />

<!-- redis 相关配置 -->
<bean id="poolConfig" class="redis.clients.jedis.JedisPoolConfig">
<property name="maxIdle" value="${redis.maxIdle}" />
<property name="maxWaitMillis" value="${redis.maxWait}" />
<property name="testOnBorrow" value="${redis.testOnBorrow}" />
</bean>

<bean id="JedisConnectionFactory"
class="org.springframework.data.redis.connection.jedis.JedisConnectionFactory"
p:host-name="${redis.host}" p:port="${redis.port}" p:password="${redis.pass}"
p:pool-config-ref="poolConfig" />

<bean id="redisTemplate" class="org.springframework.data.redis.core.RedisTemplate">
<property name="connectionFactory" ref="JedisConnectionFactory" />
</bean>

</beans>

2.2. 值类型操作

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = "classpath:spring/applicationContext-redis.xml")
public class TestValue {

@Autowired
private RedisTemplate redisTemplate;

/**
* 01-存值
* set void set(K key, V value);
*/
@Test
public void setValue() {
redisTemplate.boundValueOps("name").set("bruceliu");
}

/**
* 02-存值
* void set(V value, long timeout, TimeUnit unit);
*/
@Test
public void setValue1() {
redisTemplate.boundValueOps("name").set("tom",10, TimeUnit.SECONDS);
// 由于设置的是10秒失效，十秒之内查询有结果，十秒之后返回为null
String value=(String)redisTemplate.opsForValue().get("name");
System.out.println(value);
}

/**
* 02-取值
*/
@Test
public void getValue() {
String str = (String) redisTemplate.boundValueOps("name").get();
System.out.println(str);
}

/**
* 03-删除
*/
@Test
public void deleteValue() {
redisTemplate.delete("name");
}
}

2.3. Set类型操作

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = "classpath:spring/applicationContext-redis.xml")
public class TestSet {

@Autowired
private RedisTemplate redisTemplate;

@Test
public void setValue() {
redisTemplate.boundSetOps("nameset").add("曹操");
redisTemplate.boundSetOps("nameset").add("刘备");
redisTemplate.boundSetOps("nameset").add("孙权");
}

@Test
public void getValue() {
Set set = redisTemplate.boundSetOps("nameset").members();
System.out.println(set);
}

@Test
public void removeValue() {
redisTemplate.boundSetOps("nameset").remove("孙权");
}

@Test
public void delete() {
redisTemplate.delete("nameset");
}
}

2.4. List类型操作

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = "classpath:spring/applicationContext-redis.xml")
public class TestList {

@Autowired
private RedisTemplate redisTemplate;

/*
* 右压栈 : 后添加的元素排在后边
*/
@Test
public void testSetValue1() {
redisTemplate.boundListOps("namelist1").rightPush("刘备");
redisTemplate.boundListOps("namelist1").rightPush("关羽");
redisTemplate.boundListOps("namelist1").rightPush("张飞");
}

/**
* 显示右压栈的值
*/
@Test
public void testGetValue1() {
List list = redisTemplate.boundListOps("namelist1").range(0, 10);
System.out.println(list);
}

@Test
public void delete() {
redisTemplate.delete("namelist1");
}

/**
* 左压栈
*/
@Test
public void testSetValue2() {
redisTemplate.boundListOps("namelist2").leftPush("刘备");
redisTemplate.boundListOps("namelist2").leftPush("关羽");
redisTemplate.boundListOps("namelist2").leftPush("张飞");
}

/**
* 显示左压栈的值
*/
@Test
public void testGetValue2() {
List list = redisTemplate.boundListOps("namelist2").range(0, 10);
System.out.println(list);
}

/**
* 删除值
*/
@Test
public void removeValue() {
redisTemplate.boundListOps("namelist1").remove(0, "刘备");
}
}

2.5. Hash类型操作

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = "classpath:spring/applicationContext-redis.xml")
public class TestHash {

@Autowired
private RedisTemplate redisTemplate;

/**
* 存值
*/
@Test
public void testSetValue() {
redisTemplate.boundHashOps("namehash").put("a", "唐僧");
redisTemplate.boundHashOps("namehash").put("b", "悟空");
redisTemplate.boundHashOps("namehash").put("c", "八戒");
redisTemplate.boundHashOps("namehash").put("d", "沙僧");
}

/**
* 获取所有的key
*/
@Test
public void testGetKes() {
Set keys = redisTemplate.boundHashOps("namehash").keys();
System.out.println(keys);
}

/**
* 获取所有的值
*/
@Test
public void testGetValues() {
List list = redisTemplate.boundHashOps("namehash").values();
System.out.println(list);
}

/**
* 根据KEY取值
*/
@Test
public void searchValueByKey() {
String str = (String) redisTemplate.boundHashOps("namehash").get("b");
System.out.println(str);
}

/**
* 移除某个小key的值
*/
@Test
public void removeValue() {
redisTemplate.boundHashOps("namehash").delete("c");
}
}

2.6. Zset类型操作

/**
* @author bruceliu
* @create 2019-06-23 16:51
* @description SpringData对Zset数据类型的操作
*/
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = "classpath:spring/applicationContext-redis.xml")
public class TestZset {

@Autowired
RedisTemplate redisTemplate;

/**
* Boolean add(V value, double score);
* 添加元素到变量中同时指定元素的分值。
*/
@Test
public void testAdd() {
redisTemplate.boundZSetOps("zSetValue").add("A", 1);
redisTemplate.boundZSetOps("zSetValue").add("B", 3);
redisTemplate.boundZSetOps("zSetValue").add("C", 2);
redisTemplate.boundZSetOps("zSetValue").add("D", 5);
redisTemplate.boundZSetOps("zSetValue").add("E", 4);
}

/**
* Set<V> range(long start, long end);
* 获取变量指定区间的元素。
* 通过索引区间返回有序集合成指定区间内的成员，其中有序集成员按分数值递增(从小到大)顺序排列
*/
@Test
public void testRange(){
Set zSetValue = redisTemplate.boundZSetOps("zSetValue").range(0,-1);
System.out.println("获取指定区间的元素:" + zSetValue);
}

/**
* 新增一个有序集合
*/
@Test
public void testAdd1(){
ZSetOperations.TypedTuple<Object> objectTypedTuple1 = new DefaultTypedTuple<Object>("zset-5",9.6);
ZSetOperations.TypedTuple<Object> objectTypedTuple2 = new DefaultTypedTuple<Object>("zset-6",9.9);
Set<ZSetOperations.TypedTuple<Object>> tuples = new HashSet<ZSetOperations.TypedTuple<Object>>();
tuples.add(objectTypedTuple1);
tuples.add(objectTypedTuple2);

System.out.println(redisTemplate.boundZSetOps("zset1").add(tuples));

System.out.println(redisTemplate.boundZSetOps("zset1").range(0,-1));
}


/**
* 从有序集合中移除一个或者多个元素
*/
@Test
public void testRemove(){
System.out.println(redisTemplate.boundZSetOps("zset1").range(0,-1));
System.out.println(redisTemplate.boundZSetOps("zset1").remove("zset1","zset-6"));
System.out.println(redisTemplate.boundZSetOps("zset1").range(0,-1));
}

/**
* 增加元素的score值，并返回增加后的值
*/
@Test
public void testIncrementScore(){
System.out.println(redisTemplate.boundZSetOps("zset1").incrementScore("zset-1",1.1)); //原为1.1
}

/**
* 返回有序集中指定成员的排名，其中有序集成员按分数值递增(从小到大)顺序排列
*/
@Test
public void testRank(){
System.out.println(redisTemplate.boundZSetOps("zset1").range(0,-1));
System.out.println(redisTemplate.boundZSetOps("zset1").rank("zset-5"));
}

/**
* 返回有序集中指定成员的排名，其中有序集成员按分数值递减(从大到小)顺序排列
*/
@Test
public void testReverseRank(){
System.out.println(redisTemplate.boundZSetOps("zset1").range(0,-1));
System.out.println(redisTemplate.boundZSetOps("zset1").reverseRank("zset-5"));
}

/**
* 通过索引区间返回有序集合成指定区间内的成员对象，其中有序集成员按分数值递增(从小到大)顺序排列
*/
@Test
public void testRangeWithScore(){
Set<ZSetOperations.TypedTuple<Object>> tuples = redisTemplate.boundZSetOps("zset1").rangeWithScores(0,-1);
Iterator<ZSetOperations.TypedTuple<Object>> iterator = tuples.iterator();
while (iterator.hasNext()) {
ZSetOperations.TypedTuple<Object> typedTuple = iterator.next();
System.out.println("value:" + typedTuple.getValue() + "score:" + typedTuple.getScore());
}
}

/**
* 获取有序集合的成员数
*/
@Test
public void testzCard(){
System.out.println(redisTemplate.boundZSetOps("zset1").zCard());
}

/**
* 移除指定索引位置的成员，其中有序集成员按分数值递增(从小到大)顺序排列
*/
@Test
public void testRemoveRange(){
System.out.println(redisTemplate.boundZSetOps("zset1").range(0,-1));
redisTemplate.boundZSetOps("zset1").removeRange(1,2);
System.out.println(redisTemplate.boundZSetOps("zset1").range(0,-1));
}
}