Redis之坑：spring-data-redis中的Redis事务

SessionCallback

Redis经过multi, exec, 或discard命令来提供事务支持，这些操做在RedisTemplate中一样是可用的。可是，RedisTemplate 默认使用RedisCallBack接口，并不能保证使用同一链接来执行同一事务中的全部操做（此时Transaction是无效的）。

又可是，Spring Data Redis提供了SessionCallback接口，以便在须要保证同一链接执行多个操做时使用，好比“须要使用Redis事务时”。 咱们可以看到：

public <T> T execute(SessionCallback<T> session) {
		Assert.isTrue(initialized, "template not initialized; call afterPropertiesSet() before using it");
		Assert.notNull(session, "Callback object must not be null");

		RedisConnectionFactory factory = getConnectionFactory();
		// bind connection
		RedisConnectionUtils.bindConnection(factory, enableTransactionSupport);//第8行
		try {
			return session.execute(this);
		} finally {
			RedisConnectionUtils.unbindConnection(factory);
		}
	}
复制代码

• RedisTemplate.execute(SessionCallback<T> session)方法的第8行已经作了链接绑定；

使用方式以下：

//execute a transaction
List<Object> txResults = redisTemplate.execute(new SessionCallback<List<Object>>() {
  public List<Object> execute(RedisOperations operations) throws DataAccessException {
    operations.multi();
    operations.opsForSet().add("key", "value1");

    // This will contain the results of all ops in the transaction
    return operations.exec();
  }
});
System.out.println("Number of items added to set: " + txResults.get(0));
复制代码

在返回以前，RedisTemplate将使用它的value， hash key和hash value 序列化器来反序列化exec的全部结果。 另一个额外的exec方法，容许您为事务结果传递自定义序列化器。

---

@Transactional支持

 上面咱们可以看到，能够经过SessionCallback绑定链接，而且实现multi, exec,或discard，从而支持Redis事务，可是这样就显得很复杂并且Redis操做(opsXXX.X)执行的位置也变得有局限性（尽管不影响功能）。  然而，Spring下咱们能够更加简单，只需两步：

• 为 method 添加注解**@Transactional或者Xml配置**（< tx:method />），注册事务切点。至关于调用了TransactionSynchronizationManager.setActualTransactionActive(true);
• 经过 setEnableTransactionSupport(true) 显式启用RedisTemplate实例的事务支持（默认被禁用）

/** Sample Configuration **/
@Configuration
public class RedisTxContextConfiguration {
  @Bean
  public StringRedisTemplate redisTemplate() {
    StringRedisTemplate template = new StringRedisTemplate(redisConnectionFactory());
    // explicitly enable transaction support
    template.setEnableTransactionSupport(true);
    return template;
  }
}
复制代码

 redisTemplate实例 默认调用 execute(RedisCallback action)，方法内容以下：

public <T> T execute(RedisCallback<T> action, boolean exposeConnection, boolean pipeline){
		/** * 变量声明等操做…… */
		try {
			if (enableTransactionSupport) {
				// only bind resources in case of potential transaction synchronization
				conn = RedisConnectionUtils.bindConnection(factory, enableTransactionSupport);
			} else {
				conn = RedisConnectionUtils.getConnection(factory);
			}
		/** * 其余操做…… */
}

public static RedisConnection bindConnection(RedisConnectionFactory factory, boolean enableTransactionSupport) {
		/** * 不用管…… */
		RedisConnection conn = factory.getConnection();
		RedisConnection connectionToBind = conn;
		//redisTemplate开启事务支持，同时transactionManager非只读的实际事务被激活
		if (enableTransactionSupport && isActualNonReadonlyTransactionActive()) {
			connectionToBind = createConnectionProxy(conn, factory);
		}
		/** * 不用管…… */
		return conn;
}
复制代码

 能够看到，enableTransactionSupport = true 将会促使当前Thread尝试绑定RedisConnection，仅当也 isActualNonReadonlyTransactionActive = true，链接才会成功绑定。

 链接绑定成功，同时将会触发MULTI。一旦MULTI被调用：

• 当前RedisConnection将会排队write操做；
• 全部readonly操做，例如KEYS将会被分发给一个全新的 (非Thread绑定)的RedisConnection；
• 命令EXEC或DISCARD将交由SpringAOP的动态代理对象去调用：
• 若是事务构建过程当中没有异常抛出（默认RuntimeException及其子类），则EXEC被调用，执行命令队列；
• 不然DISCARD，清除命令队列。

 开启事务支持后：

/** Usage Constrainsts **/
// executed on thread bound connection
template.opsForValue().set("foo", "bar");

// read operation executed on a free (not tx-aware)
connection template.keys("*");

// returns null as values set within transaction are not visible
template.opsForValue().get("foo");
复制代码

上面的样例代码是Spring官网给出的，第三个显然是WATCH命令开启乐观锁后的结果。然而至少在本人正在使用的 spring-data-redis-1.8.10.RELEASE.jar中，

<dependency>
	<groupId>org.springframework.data</groupId>
	<artifactId>spring-data-redis</artifactId>
	<version>1.8.10.RELEASE</version>
</dependency>
复制代码

WATCH命令并无被使用，亲测第三种效果并不存在（你能够根据本身的依赖版本尝试一下），此处亮出代码。

• org.springframework.data.redis.core.RedisConnectionUtils.potentiallyRegisterTransactionSynchronisation

private static void potentiallyRegisterTransactionSynchronisation(RedisConnectionHolder connHolder, final RedisConnectionFactory factory) {

		if (isActualNonReadonlyTransactionActive()) {

			if (!connHolder.isTransactionSyncronisationActive()) {
				connHolder.setTransactionSyncronisationActive(true);

				RedisConnection conn = connHolder.getConnection();
				conn.multi();//在此以前conn.watch()未被调用

				TransactionSynchronizationManager.registerSynchronization(new RedisTransactionSynchronizer(connHolder, conn,
						factory));
			}
		}
	}
复制代码

---

声明两个RedisTemplate实例

两个RedisTemplate实例?

• 支持事务：commands要么统一执行，要么都被清除，维护数据完整性；
• 不支持事务，command当即执行，即时返回执行结果而且更高效；

/** Sample Configuration **/
@Configuration
public class RedisTxContextConfiguration {
  @Bean
  public StringRedisTemplate redisTransactionTemplate() {
    StringRedisTemplate template = new StringRedisTemplate(redisConnectionFactory());
    // explicitly enable transaction support
    template.setEnableTransactionSupport(true);
    return template;
  }
 @Bean
  public StringRedisTemplate redisTemplate() {
    StringRedisTemplate template = new StringRedisTemplate(redisConnectionFactory());
    return template;
  }
}
复制代码