Spring/spring-integration
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

GH-9617: @SuppressWarnings("removal") for ListenableFuture

Browse Source 
Fixes: #9617
Issue link: https://github.com/spring-projects/spring-integration/issues/9617

The `ListenableFuture` is marked `forRemoval` in Spring Framework.
So, fix the code base to use `@SuppressWarnings("removal")`.
Also, add a warning into logs that `ListenableFuture` support will be removed in `7.0`.

* Fix JavaDocs where `ListenableFuture` is mentioned in favor of `CompletableFuture`
This commit is contained in:
Artem Bilan
2024-10-30 15:24:10 -04:00
parent f423280f77
commit b50c40279a
7 changed files with 22 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
spring-integration-core/src/main/java/org/springframework/integration/gateway/GatewayProxyFactoryBean.java
View File

@@ -363,9 +363,9 @@ public class GatewayProxyFactoryBean<T> extends AbstractEndpoint
/**
* Set the executor for use when the gateway method returns
* {@link java.util.concurrent.Future} or {@link org.springframework.util.concurrent.ListenableFuture}.
* {@link Future} or {@link CompletableFuture}.
* Set it to null to disable the async processing, and any
* {@link java.util.concurrent.Future} return types must be returned by the downstream flow.
* {@link Future} return types must be returned by the downstream flow.
* @param executor The executor.
*/
public void setAsyncExecutor(@Nullable Executor executor) {
@@ -522,7 +522,7 @@ public class GatewayProxyFactoryBean<T> extends AbstractEndpoint
@Override
@Nullable
@SuppressWarnings("deprecation")
@SuppressWarnings("removal")
public Object invoke(final MethodInvocation invocation) throws Throwable { // NOSONAR
Method method = invocation.getMethod();
Class<?> returnType;
@@ -542,6 +542,9 @@ public class GatewayProxyFactoryBean<T> extends AbstractEndpoint
return CompletableFuture.supplyAsync(invoker, this.asyncExecutor);
}
else if (org.springframework.util.concurrent.ListenableFuture.class.equals(returnType)) {
logger.warn("The 'org.springframework.util.concurrent.ListenableFuture' is deprecated for removal." +
"The 'CompletableFuture' is recommended to be used instead." +
"The 'ListenableFuture' support will be removed in Spring Integration 7.0.");
return ((org.springframework.core.task.AsyncListenableTaskExecutor) this.asyncExecutor)
.submitListenable(invoker::get);
}

19
spring-integration-core/src/main/java/org/springframework/integration/handler/AbstractMessageProducingHandler.java
View File

@@ -71,7 +71,7 @@ import org.springframework.util.StringUtils;
* @author Marius Bogoevici
* @author Ngoc Nhan
*
* since 4.1
* @since 4.1
*/
public abstract class AbstractMessageProducingHandler extends AbstractMessageHandler
implements MessageProducer, HeaderPropagationAware {
@@ -321,7 +321,7 @@ public abstract class AbstractMessageProducingHandler extends AbstractMessageHan
return replyChannel;
}
@SuppressWarnings("deprecation")
@SuppressWarnings("removal")
private void doProduceOutput(Message<?> requestMessage, MessageHeaders requestHeaders, Object reply,
@Nullable Object replyChannelArg) {
@@ -361,7 +361,7 @@ public abstract class AbstractMessageProducingHandler extends AbstractMessageHan
sendOutput(createOutputMessage(reply, requestHeaders), replyChannel, false);
}
private static Publisher<?> toPublisherReply(Object reply, @Nullable ReactiveAdapter reactiveAdapter) {
private Publisher<?> toPublisherReply(Object reply, @Nullable ReactiveAdapter reactiveAdapter) {
if (reactiveAdapter != null) {
return reactiveAdapter.toPublisher(reply);
}
@@ -371,7 +371,7 @@ public abstract class AbstractMessageProducingHandler extends AbstractMessageHan
}
@SuppressWarnings("try")
private static CompletableFuture<?> toFutureReply(Object reply, @Nullable ReactiveAdapter reactiveAdapter) {
private CompletableFuture<?> toFutureReply(Object reply, @Nullable ReactiveAdapter reactiveAdapter) {
if (reactiveAdapter != null) {
Mono<?> reactiveReply;
Publisher<?> publisher = reactiveAdapter.toPublisher(reply);
@@ -419,12 +419,15 @@ public abstract class AbstractMessageProducingHandler extends AbstractMessageHan
}
}
@SuppressWarnings("deprecation")
private static CompletableFuture<?> toCompletableFuture(Object reply) {
if (reply instanceof CompletableFuture<?>) {
return (CompletableFuture<?>) reply;
@SuppressWarnings("removal")
private CompletableFuture<?> toCompletableFuture(Object reply) {
if (reply instanceof CompletableFuture<?> completableFuture) {
return completableFuture;
}
else {
logger.warn("The 'org.springframework.util.concurrent.ListenableFuture' is deprecated for removal." +
"The 'CompletableFuture' is recommended to be used instead." +
"The 'ListenableFuture' support will be removed in Spring Integration 7.0.");
return ((org.springframework.util.concurrent.ListenableFuture<?>) reply).completable();
}
}

12
spring-integration-core/src/test/java/org/springframework/integration/gateway/GatewayInterfaceTests.java
View File

@@ -444,14 +444,6 @@ public class GatewayInterfaceTests {
assertThat(latch.await(10, TimeUnit.SECONDS)).isTrue();
assertThat(result2.get().getName()).startsWith("exec-");
org.springframework.util.concurrent.ListenableFuture<Thread> result3 =
this.execGateway.test3(Thread.currentThread());
final CountDownLatch latch1 = new CountDownLatch(1);
result3.addCallback(data -> latch1.countDown(), ex -> {
});
assertThat(latch1.await(10, TimeUnit.SECONDS)).isTrue();
assertThat(result3.get().getName()).startsWith("exec-");
/*
@IntegrationComponentScan(useDefaultFilters = false,
includeFilters = @ComponentScan.Filter(TestMessagingGateway.class))
@@ -770,10 +762,6 @@ public class GatewayInterfaceTests {
@Gateway(requestChannel = "gatewayThreadChannel")
CompletableFuture<Thread> test2(Thread caller);
@Gateway(requestChannel = "gatewayThreadChannel")
@SuppressWarnings("deprecation")
org.springframework.util.concurrent.ListenableFuture<Thread> test3(Thread caller);
}
@MessagingGateway(name = "noExecutorGateway", asyncExecutor = AnnotationConstants.NULL)