Couchbase 事务
Couchbase 支持分布式事务。本节介绍如何在 Spring Data Couchbase 中使用它。
要求
-
Couchbase Server 6.6.1 或更高版本。
-
Spring Data Couchbase 5.0.0-M5 或更高版本。
-
应配置 NTP,使 Couchbase 集群各节点时间保持同步。时间不同步不会导致错误行为,但可能影响元数据清理。
-
实体类必须有一个
@Version Long属性,用于保存文档的 CAS 值。
概述
Spring Data Couchbase 的模板操作 insert、find、replace 和 delete,以及使用这些调用的仓库方法,都可以参与 Couchbase 事务。它们可以通过使用 @Transactional 注解、CouchbaseTransactionalOperator,或在 Couchbase 事务的 lambda 中在事务内执行。
入门与配置
Couchbase 事务通常与标注了 @Transactional 的方法配合使用。@Transactional 操作符由 CouchbaseTransactionManager 实现,后者作为 Bean 提供在 AbstractCouchbaseConfiguration 中。无需定义服务类即可使用 Couchbase 事务:通过 CouchbaseTransactionOperator 使用,它同样作为 Bean 提供在 AbtractCouchbaseConfiguration 中。Couchbase 事务也可以在 lambda 中直接使用 Spring Data Couchbase 操作来使用使用事务
使用 @Transactional 的事务
@Transactional 将一个方法或类上的所有方法定义为事务性方法。
当该注解声明在类级别时,它会默认作用于声明类及其子类的所有方法。
[[-attribute-semantics]] === 属性语义
在本版本中,Couchbase 事务会忽略回滚属性。事务隔离级别为读已提交(read-committed);
示例 1. 通过 @Transactional 配置和使用事务
@Configuration
@EnableCouchbaseRepositories("<parent-dir-of-repository-interfaces>")
@EnableReactiveCouchbaseRepositories("<parent-dir-of-repository-interfaces>")
@EnableTransactionManagement 1
static class Config extends AbstractCouchbaseConfiguration {
// Usual Setup
@Override public String getConnectionString() { /* ... */ }
@Override public String getUserName() { /* ... */ }
@Override public String getPassword() { /* ... */ }
@Override public String getBucketName() { /* ... */ }
// Customization of transaction behavior is via the configureEnvironment() method
@Override protected void configureEnvironment(final Builder builder) {
builder.transactionsConfig(
TransactionsConfig.builder().timeout(Duration.ofSeconds(30)));
}
}
事务性服务类
请注意,如果事务失败,@Transactional 方法的方法体可能会被重新执行。因此方法体中的所有内容都必须是幂等的。
import reactor.core.publisher.Mono;
import reactor.core.publisher.Flux;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
final CouchbaseOperations personOperations;
final ReactiveCouchbaseOperations reactivePersonOperations;
@Service 2
public class PersonService {
final CouchbaseOperations operations;
final ReactiveCouchbaseOperations reactiveOperations;
public PersonService(CouchbaseOperations ops, ReactiveCouchbaseOperations reactiveOps) {
operations = ops;
reactiveOperations = reactiveOps;
}
// no annotation results in this method being executed not in a transaction
public Person save(Person p) {
return operations.save(p);
}
@Transactional
public Person changeFirstName(String id, String newFirstName) {
Person p = operations.findById(Person.class).one(id); 3
return operations.replaceById(Person.class).one(p.withFirstName(newFirstName);
}
@Transactional
public Mono<Person> reactiveChangeFirstName(String id, String newFirstName) {
return personOperationsRx.findById(Person.class).one(person.id())
.flatMap(p -> personOperationsRx.replaceById(Person.class).one(p.withFirstName(newFirstName)));
}
}
@Autowired PersonService personService; 4
Person walterWhite = new Person( "Walter", "White");
Person p = personService.save(walterWhite); // this is not a transactional method
...
Person renamedPerson = personService.changeFirstName(walterWhite.getId(), "Ricky"); 5
@Transactional 方法注解的正常运作需要
-
配置类必须标注 @EnableTransactionManagement;
-
带有注解方法的服务对象必须标注 @Service;
-
方法体在事务中执行。
-
带有注解方法的服务对象必须通过 @Autowired 获取。
-
对该方法的调用必须来自与 service 不同的类,因为从同一类内部调用注解方法不会触发执行事务处理的方法拦截器。
使用 CouchbaseTransactionalOperator 的事务
CouchbaseTransactionalOperator 可用于内联构造事务,而无需创建使用 @Transactional 的服务类。CouchbaseTransactionalOperator 以 Bean 形式提供,可以通过 @Autowired 注入。如果显式创建它,则必须使用 CouchbaseTransactionalOperator.create(manager) 创建(而不是 TransactionalOperator.create(manager))。
示例 2. 使用 TransactionalOperator.execute() 访问事务
@Autowired TransactionalOperator txOperator;
@Autowired ReactiveCouchbaseTemplate reactiveCouchbaseTemplate;
Flux<Person> result = txOperator.execute((ctx) ->
reactiveCouchbaseTemplate.findById(Person.class).one(person.id())
.flatMap(p -> reactiveCouchbaseTemplate.replaceById(Person.class).one(p.withFirstName("Walt")))
);
直接使用 SDK 的事务
Spring Data Couchbase 与 Couchbase Java SDK 在事务处理上无缝协作。可以在事务中执行的 Spring Data Couchbase 操作,无需借助任何 Spring 事务机制,即可直接在 transactions().run() 的 lambda 内工作。这是在 Spring Data Couchbase 中利用 Couchbase 事务最直接的方式。
请参阅参考文档
示例 3. 事务访问——阻塞
@Autowired CouchbaseTemplate couchbaseTemplate;
TransactionResult result = couchbaseTemplate.getCouchbaseClientFactory().getCluster().transactions().run(ctx -> {
Person p = couchbaseTemplate.findById(Person.class).one(personId);
couchbaseTemplate.replaceById(Person.class).one(p.withFirstName("Walt"));
});
示例 4. 事务访问——响应式
@Autowired ReactiveCouchbaseTemplate reactiveCouchbaseTemplate;
Mono<TransactionResult> result = reactiveCouchbaseTemplate.getCouchbaseClientFactory().getCluster().reactive().transactions()
.run(ctx ->
reactiveCouchbaseTemplate.findById(Person.class).one(personId)
.flatMap(p -> reactiveCouchbaseTemplate.replaceById(Person.class).one(p.withFirstName("Walt")))
);