Add execution listeners to auto-configured transaction managers

Closes gh-36770
This commit is contained in:
Andy Wilkinson 2023-09-29 09:29:02 +01:00
parent 1a22415c01
commit 6d3594db49
4 changed files with 101 additions and 2 deletions

View File

@ -0,0 +1,45 @@
/*
* Copyright 2012-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.boot.autoconfigure.transaction;
import java.util.List;
import org.springframework.transaction.ConfigurableTransactionManager;
import org.springframework.transaction.TransactionExecutionListener;
/**
* {@link TransactionManagerCustomizer} that adds {@link TransactionExecutionListener
* execution listeners} to any transaction manager that is
* {@link ConfigurableTransactionManager configurable}.
*
* @author Andy Wilkinson
*/
class ExecutionListenersTransactionManagerCustomizer
implements TransactionManagerCustomizer<ConfigurableTransactionManager> {
private final List<TransactionExecutionListener> listeners;
ExecutionListenersTransactionManagerCustomizer(List<TransactionExecutionListener> listeners) {
this.listeners = listeners;
}
@Override
public void customize(ConfigurableTransactionManager transactionManager) {
this.listeners.forEach(transactionManager::addListener);
}
}

View File

@ -23,6 +23,7 @@ import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.transaction.PlatformTransactionManager;
import org.springframework.transaction.TransactionExecutionListener;
import org.springframework.transaction.TransactionManager;
/**
@ -43,4 +44,10 @@ public class TransactionManagerCustomizationAutoConfiguration {
return TransactionManagerCustomizers.of(customizers.orderedStream().toList());
}
@Bean
ExecutionListenersTransactionManagerCustomizer transactionExecutionListeners(
ObjectProvider<TransactionExecutionListener> listeners) {
return new ExecutionListenersTransactionManagerCustomizer(listeners.orderedStream().toList());
}
}

View File

@ -0,0 +1,46 @@
/*
* Copyright 2012-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.boot.autoconfigure.transaction;
import java.util.List;
import org.junit.jupiter.api.Test;
import org.springframework.transaction.ConfigurableTransactionManager;
import org.springframework.transaction.TransactionExecutionListener;
import static org.mockito.BDDMockito.then;
import static org.mockito.Mockito.mock;
/**
* Tests for {@link ExecutionListenersTransactionManagerCustomizer}.
*
* @author Andy Wilkinson
*/
class ExecutionListenersTransactionManagerCustomizerTests {
@Test
void whenTransactionManagerIsCustomizedThenExecutionListenersAreAddedToIt() {
TransactionExecutionListener listener1 = mock(TransactionExecutionListener.class);
TransactionExecutionListener listener2 = mock(TransactionExecutionListener.class);
ConfigurableTransactionManager transactionManager = mock(ConfigurableTransactionManager.class);
new ExecutionListenersTransactionManagerCustomizer(List.of(listener1, listener2)).customize(transactionManager);
then(transactionManager).should().addListener(listener1);
then(transactionManager).should().addListener(listener2);
}
}

View File

@ -43,8 +43,9 @@ class TransactionManagerCustomizationAutoConfigurationTests {
TransactionManagerCustomizers customizers = context.getBean(TransactionManagerCustomizers.class);
assertThat(customizers).extracting("customizers")
.asList()
.singleElement()
.isInstanceOf(TransactionProperties.class);
.hasSize(2)
.hasAtLeastOneElementOfType(TransactionProperties.class)
.hasAtLeastOneElementOfType(ExecutionListenersTransactionManagerCustomizer.class);
});
}