跳到主要内容
版本:4.1.1

Redis 事务

Doubao 中英对照 Redis Transactions

Redis 通过 multi、exec 和 discard 命令提供对事务的支持。这些操作在 RedisTemplate 上可用。但是,不保证 RedisTemplate 使用同一个连接运行事务中的所有操作。

Spring Data Redis 提供了 SessionCallback 接口,用于需要使用同一个 connection 执行多个操作的场景,例如使用 Redis 事务时。下例使用了 multi 方法:

//execute a transaction
List<Object> txResults = redisOperations.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 operations 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 方法,可让你为事务结果传入自定义序列化器。

值得一提的是,如果在 multi() 和 exec() 之间发生异常(例如 Redis 在超时时间内未响应而导致的超时异常),那么连接可能会停留在事务状态。为防止这种情况,需要丢弃事务状态以清除连接:

List<Object> txResults = redisOperations.execute(new SessionCallback<List<Object>>() {
public List<Object> execute(RedisOperations operations) throws DataAccessException {
boolean transactionStateIsActive = true;
try {
operations.multi();
operations.opsForSet().add("key", "value1");

// This will contain the results of all operations in the transaction
return operations.exec();
} catch (RuntimeException e) {
operations.discard();
throw e;
}
}
});

@Transactional 支持​

默认情况下,RedisTemplate 不参与受管的 Spring 事务。如果你希望 RedisTemplate 在使用 @Transactional 或 TransactionTemplate 时使用 Redis 事务,则需要通过调用 setEnableTransactionSupport(true) 显式为每个 RedisTemplate 启用事务支持。启用事务支持会将 RedisConnection 绑定到由 ThreadLocal 支撑的当前事务。如果事务顺利完成,Redis 事务会通过 EXEC 提交,否则通过 DISCARD 回滚。Redis 事务是面向批处理的。在进行中的事务期间发出的命令会被排队,仅在提交事务时才应用。

Spring Data Redis 会区分进行中事务里的只读命令和写命令。只读命令(例如 KEYS)会被转发到一个新的(非线程绑定的)RedisConnection 上以允许读取。写命令则由 RedisTemplate 排队,并在提交时应用。

下例展示了如何配置事务管理:

示例 1:启用事务管理的配置

@Configuration
@EnableTransactionManagement 1
public class RedisTxContextConfiguration {

@Bean
public StringRedisTemplate redisTemplate() {
StringRedisTemplate template = new StringRedisTemplate(redisConnectionFactory());
// explicitly enable transaction support
template.setEnableTransactionSupport(true); 2
return template;
}

@Bean
public RedisConnectionFactory redisConnectionFactory() {
// jedis || Lettuce
}

@Bean
public PlatformTransactionManager transactionManager() throws SQLException {
return new DataSourceTransactionManager(dataSource()); 3
}

@Bean
public DataSource dataSource() throws SQLException {
// ...
}
}
  • 配置一个 Spring Context 以启用声明式事务管理。

  • 配置 RedisTemplate 通过将连接绑定到当前线程来参与事务。

  • 事务管理需要一个 PlatformTransactionManager。Spring Data Redis 不自带 PlatformTransactionManager 实现。假设你的应用使用 JDBC,Spring Data Redis 可以通过使用现有的事务管理器来参与事务。

以下示例各自演示了一种使用约束:

示例 2:使用约束

// must be performed on thread-bound connection
template.opsForValue().set("thing1", "thing2");

// read operation must be run on a free (not transaction-aware) connection
template.keys("*");

// returns null as values set within a transaction are not visible
template.opsForValue().get("thing1");