Spring-data-redis:特性与实例

     Spring-data-redis为spring-data模块中对redis的支持部分，简称为“SDR”，提供了基于jedis客户端API的高度封装以及与spring容器的整合，事实上jedis客户端已经足够简单和轻量级，而spring-data-redis反而具有“过度设计”的嫌疑。

    jedis客户端在编程实施方面存在如下不足：

    1) connection管理缺乏自动化，connection-pool的设计缺少必要的容器支持。

    2) 数据操作需要关注“序列化”/“反序列化”，因为jedis的客户端API接受的数据类型为string和byte，对结构化数据(json,xml,pojo等)操作需要额外的支持。

    3) 事务操作纯粹为硬编码

    4) pub/sub功能，缺乏必要的设计模式支持，对于开发者而言需要关注的太多。

    不过jedis与spring整合，也是非常的简单，参见“jedis连接池实例”.

 

一.  spring-data-redis针对jedis提供了如下功能：

    1. 连接池自动管理，提供了一个高度封装的“RedisTemplate”类

    2. 针对jedis客户端中大量api进行了归类封装,将同一类型操作封装为operation接口

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

• ListOperations：针对list类型的数据操作

    3. 提供了对key的“bound”(绑定)便捷化操作API，可以通过bound封装指定的key，然后进行一系列的操作而无须“显式”的再次指定Key，即BoundKeyOperations：

• BoundValueOperations
• BoundSetOperations
• BoundListOperations
• BoundSetOperations
• BoundHashOperations

  

    4. 将事务操作封装，有容器控制。

    5. 针对数据的“序列化/反序列化”，提供了多种可选择策略(RedisSerializer)

• JdkSerializationRedisSerializer：POJO对象的存取场景，使用JDK本身序列化机制，将pojo类通过ObjectInputStream/ObjectOutputStream进行序列化操作，最终redis-server中将存储字节序列。是目前最常用的序列化策略。
• StringRedisSerializer：Key或者value为字符串的场景，根据指定的charset对数据的字节序列编码成string，是“new String(bytes, charset)”和“string.getBytes(charset)”的直接封装。是最轻量级和高效的策略。
• JacksonJsonRedisSerializer：jackson-json工具提供了javabean与json之间的转换能力，可以将pojo实例序列化成json格式存储在redis中，也可以将json格式的数据转换成pojo实例。因为jackson工具在序列化和反序列化时，需要明确指定Class类型，因此此策略封装起来稍微复杂。【需要jackson-mapper-asl工具支持】
• OxmSerializer：提供了将javabean与xml之间的转换能力，目前可用的三方支持包括jaxb，apache-xmlbeans；redis存储的数据将是xml工具。不过使用此策略，编程将会有些难度，而且效率最低；不建议使用。【需要spring-oxm模块的支持】

    针对“序列化和发序列化”中JdkSerializationRedisSerializer和StringRedisSerializer是最基础的策略，原则上，我们可以将数据存储为任何格式以便应用程序存取和解析(其中应用包括app，hadoop等其他工具)，不过在设计时仍然不推荐直接使用“JacksonJsonRedisSerializer”和“OxmSerializer”，因为无论是json还是xml，他们本身仍然是String。

    如果你的数据需要被第三方工具解析，那么数据应该使用StringRedisSerializer而不是JdkSerializationRedisSerializer。

    如果你的数据格式必须为json或者xml，那么在编程级别，在redisTemplate配置中仍然使用StringRedisSerializer，在存储之前或者读取之后，使用“SerializationUtils”工具转换转换成json或者xml，请参见下文实例。

 

    6. 基于设计模式，和JMS开发思路，将pub/sub的API设计进行了封装，使开发更加便捷。

    7.spring-data-redis中，并没有对sharding提供良好的封装，如果你的架构是基于sharding，那么你需要自己去实现，这也是sdr和jedis相比，唯一缺少的特性。

 

二.简单实例：

    1) spring配置：

<beans xmlns="http://www.springframework.org/schema/beans" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd" default-autowire="byName">
	<bean id="jedisPoolConfig" class="redis.clients.jedis.JedisPoolConfig">
		<property name="maxActive" value="32"></property>
		<property name="maxIdle" value="6"></property>
		<property name="maxWait" value="15000"></property>
		<property name="minEvictableIdleTimeMillis" value="300000"></property>
		<property name="numTestsPerEvictionRun" value="3"></property>
		<property name="timeBetweenEvictionRunsMillis" value="60000"></property>
		<property name="whenExhaustedAction" value="1"></property>
	</bean>
	<bean id="jedisConnectionFactory" class="org.springframework.data.redis.connection.jedis.JedisConnectionFactory" destroy-method="destroy">
		<property name="poolConfig" ref="jedisPoolConfig"></property>
		<property name="hostName" value="127.0.0.1"></property>
		<property name="port" value="6379"></property>
		<property name="password" value="0123456"></property>
		<property name="timeout" value="15000"></property>
		<property name="usePool" value="true"></property>
	</bean>
	<bean id="jedisTemplate" class="org.springframework.data.redis.core.RedisTemplate">
		<property name="connectionFactory" ref="jedisConnectionFactory"></property>
		<property name="keySerializer">
			<bean class="org.springframework.data.redis.serializer.StringRedisSerializer"/>
		</property>
		<property name="valueSerializer">
			<bean class="org.springframework.data.redis.serializer.JdkSerializationRedisSerializer"/>
		</property>
	</bean>
</beans>

    2) 程序实例：

public class SpringDataRedisTestMain {

	/**
	 * @param args
	 */
	public static void main(String[] args) {
		ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("classpath:spring-redis-beans.xml");
		RedisTemplate redisTemplate = (RedisTemplate)context.getBean("jedisTemplate");
		//其中key采取了StringRedisSerializer
		//其中value采取JdkSerializationRedisSerializer
		ValueOperations<String, User> valueOper = redisTemplate.opsForValue();
		User u1 = new User("zhangsan",12);
		User u2 = new User("lisi",25);
		valueOper.set("u:u1", u1);
		valueOper.set("u:u2", u2);
		System.out.println(valueOper.get("u:u1").getName());
		System.out.println(valueOper.get("u:u2").getName());
	}
	
	/**
	 * 如果使用jdk序列化方式，bean必须实现Serializable，且提供getter/setter方法
	 * @author qing
	 *
	 */
	static class User implements Serializable{
		
		/**
		 * 
		 */
		private static final long serialVersionUID = -3766780183428993793L;
		private String name;
		private Date created;
		private int age;
		public User(){}
		public User(String name,int age){
			this.name = name;
			this.age = age;
			this.created = new Date();
		}
		public String getName() {
			return name;
		}
		public void setName(String name) {
			this.name = name;
		}
		public Date getCreated() {
			return created;
		}
		public void setCreated(Date created) {
			this.created = created;
		}
		public int getAge() {
			return age;
		}
		public void setAge(int age) {
			this.age = age;
		}
		
	}

}

    3) RedisTemplate：

    如果你使用过jedisPool连接池，在数据操作之前，你需要pool.getResource()即从连接池中获取“链接资源”(Jedis),在操作之后，你需要(必须)调用pool.returnResource()将资源归还个连接池。但是，spring-data-redis中，我们似乎并没有直接操作pool，那么spring是如何做到pool管理的呢？？一句话：spring的“看门绝技”--callback。

•  public <T> T execute(RedisCallback<T> action)：这个方法是redisTemplate中执行操作的底层方法，任何基于redisTemplate之上的调用(比如，valueOperations)最终都会被封装成RedisCallback，redisTemplate在execute方法中将会直接使用jedis客户端API进行与server通信，而且在如果使用了连接池，则会在操作之后执行returnSource。

其他实例请参考如下链接：

1) serializer实例

2) operation实例

3) pub/sub实例

 

   

评论

6 楼 nemeses 2016-07-07  

lz,请教下,如何在Spring-data-Redis 下实现jedis连接断开（网络环境不太稳定导致）自动重连

5 楼 javatozhang 2015-03-14  

先知其然、后知其所以然。谢谢lz

4 楼 Saxone 2014-06-30  

QING____ 写道

Saxone 写道

Saxone 写道

lz，想请教下，RedisTemplate的opsForValue方法和通过execute调用rediscallback操作redis到底有什么区别？   是因为通过execute方法，可以自定义不同的serializer吗？  谢谢哈：）

不好意思，刚又思考了一下，任何基于redisTemplate之上的调用(比如，valueOperations)最终都会被封装成RedisCallback，也就是说任何*Opreations的调用都会被封装成RedisCallback，那么也就是说*Opreations能实现的功能RedisCallback都能做到，那么RedisCallback到底强大在哪里呢？ 换句话说，应该以什么维度来区分该调用哪个呢？

你的问题，看起来有点晕。。
开发者使用的各种operations,最终都是封装成了RedisCallback实现，并由redisTemplate.execute方法执行。
请参见spring实现的ValueDeserializingRedisCallback。


RedisCallback接口 + RedisTemplate中execute方法最终给了开发者所有的“自定义序列化”的机会。通常开发者可以通过“模仿”ValueDeserializingRedisCallback实现来开发自己的RedisCallback，开发者可以在callback方法调用之前“序列化K-V”，以及在callback返回之后反序列化result即可。

如果你觉得在spring配置文件中指定的keySerliazer和valueSerliazer不能满足你的需要时，你可以按照上述方式尝试。

祝你好运。


明白了，楼主Thx ：）

3 楼 QING____ 2014-06-28  

Saxone 写道

Saxone 写道

lz，想请教下，RedisTemplate的opsForValue方法和通过execute调用rediscallback操作redis到底有什么区别？   是因为通过execute方法，可以自定义不同的serializer吗？  谢谢哈：）

不好意思，刚又思考了一下，任何基于redisTemplate之上的调用(比如，valueOperations)最终都会被封装成RedisCallback，也就是说任何*Opreations的调用都会被封装成RedisCallback，那么也就是说*Opreations能实现的功能RedisCallback都能做到，那么RedisCallback到底强大在哪里呢？ 换句话说，应该以什么维度来区分该调用哪个呢？

你的问题，看起来有点晕。。
开发者使用的各种operations,最终都是封装成了RedisCallback实现，并由redisTemplate.execute方法执行。
请参见spring实现的ValueDeserializingRedisCallback。


RedisCallback接口 + RedisTemplate中execute方法最终给了开发者所有的“自定义序列化”的机会。通常开发者可以通过“模仿”ValueDeserializingRedisCallback实现来开发自己的RedisCallback，开发者可以在callback方法调用之前“序列化K-V”，以及在callback返回之后反序列化result即可。

如果你觉得在spring配置文件中指定的keySerliazer和valueSerliazer不能满足你的需要时，你可以按照上述方式尝试。

祝你好运。

2 楼 Saxone 2014-06-27  

Saxone 写道

lz，想请教下，RedisTemplate的opsForValue方法和通过execute调用rediscallback操作redis到底有什么区别？   是因为通过execute方法，可以自定义不同的serializer吗？  谢谢哈：）

不好意思，刚又思考了一下，任何基于redisTemplate之上的调用(比如，valueOperations)最终都会被封装成RedisCallback，也就是说任何*Opreations的调用都会被封装成RedisCallback，那么也就是说*Opreations能实现的功能RedisCallback都能做到，那么RedisCallback到底强大在哪里呢？ 换句话说，应该以什么维度来区分该调用哪个呢？

1 楼 Saxone 2014-06-27  

lz，想请教下，RedisTemplate的opsForValue方法和通过execute调用rediscallback操作redis到底有什么区别？   是因为通过execute方法，可以自定义不同的serializer吗？  谢谢哈：）