使用spring-data-redis中的Redis事務

更新時間：2024年07月08日 09:40:01 作者：qq_32331073

這篇文章主要介紹了使用spring-data-redis中的Redis事務,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

SessionCallback

Redis通過multi, exec, 或discard命令來提供事務支持，這些操作在RedisTemplate中同樣是可用的。

但是，RedisTemplate 默認使用RedisCallBack接口，并不能保證使用同一連接來執(zhí)行同一事務中的所有操作（此時Transaction是無效的）。

又但是，Spring Data Redis提供了SessionCallback接口，以便在需要保證同一連接執(zhí)行多個操作時使用，比如“需要使用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綁定連接，并且實現(xiàn)multi, exec,或discard，從而支持Redis事務，但是這樣就顯得很復雜而且Redis操作(opsXXX.X)執(zhí)行的位置也變得有局限性（盡管不影響功能）。

然而，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，連接才會成功綁定。

連接綁定成功，同時將會觸發(fā)MULTI。

一旦MULTI被調用：

當前RedisConnection將會排隊write操作；
所有readonly操作，例如KEYS將會被分發(fā)給一個全新的 (非Thread綁定)的RedisConnection；
命令EXEC或DISCARD將交由SpringAOP的動態(tài)代理對象去調用：
如果事務構建過程中沒有異常拋出（默認RuntimeException及其子類），則EXEC被調用，執(zhí)行命令隊列；
否則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命令并沒有被使用，親測第三種效果并不存在（你可以根據(jù)自己的依賴版本嘗試一下），此處亮出代碼。

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要么統(tǒng)一執(zhí)行，要么都被清除，維護數(shù)據(jù)完整性；
不支持事務，command立即執(zhí)行，即時返回執(zhí)行結果并且更高效；

/** 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;
  }
}