From 5255e7ae21e6cd6fa25b5f2f7f8379d72f803885 Mon Sep 17 00:00:00 2001 From: Sebastien Deleuze Date: Fri, 22 May 2015 11:24:54 +0200 Subject: [PATCH] Support CompletableFuture in @MessageMapping handler methods Issue: SPR-12207 --- .../CompletableToListenableFutureAdapter.java | 93 +++++++++++++++++++ .../CompletableFutureReturnValueHandler.java | 46 +++++++++ .../SimpAnnotationMethodMessageHandler.java | 9 ++ ...mpAnnotationMethodMessageHandlerTests.java | 64 +++++++++++++ 4 files changed, 212 insertions(+) create mode 100644 spring-core/src/main/java/org/springframework/util/concurrent/CompletableToListenableFutureAdapter.java create mode 100644 spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/CompletableFutureReturnValueHandler.java diff --git a/spring-core/src/main/java/org/springframework/util/concurrent/CompletableToListenableFutureAdapter.java b/spring-core/src/main/java/org/springframework/util/concurrent/CompletableToListenableFutureAdapter.java new file mode 100644 index 00000000000..bec609d9899 --- /dev/null +++ b/spring-core/src/main/java/org/springframework/util/concurrent/CompletableToListenableFutureAdapter.java @@ -0,0 +1,93 @@ +/* + * Copyright 2002-2015 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 + * + * http://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.util.concurrent; + +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; +import java.util.function.BiFunction; + +import org.springframework.lang.UsesJava8; + + +/** + * Adapts a {@link CompletableFuture} into a {@link ListenableFuture}. + * + * @author Sebastien Deleuze + * @since 4.2 + */ +@UsesJava8 +public class CompletableToListenableFutureAdapter implements ListenableFuture { + + private final CompletableFuture completableFuture; + + private final ListenableFutureCallbackRegistry callbacks = new ListenableFutureCallbackRegistry(); + + public CompletableToListenableFutureAdapter(CompletableFuture completableFuture) { + this.completableFuture = completableFuture; + this.completableFuture.handle(new BiFunction() { + @Override + public Object apply(T result, Throwable ex) { + if (ex != null) { + callbacks.failure(ex); + } + else { + callbacks.success(result); + } + return null; + } + }); + } + + @Override + public void addCallback(ListenableFutureCallback callback) { + this.callbacks.addCallback(callback); + } + + @Override + public void addCallback(SuccessCallback successCallback, FailureCallback failureCallback) { + this.callbacks.addSuccessCallback(successCallback); + this.callbacks.addFailureCallback(failureCallback); + } + + @Override + public boolean cancel(boolean mayInterruptIfRunning) { + return this.completableFuture.cancel(mayInterruptIfRunning); + } + + @Override + public boolean isCancelled() { + return this.completableFuture.isCancelled(); + } + + @Override + public boolean isDone() { + return this.completableFuture.isDone(); + } + + @Override + public T get() throws InterruptedException, ExecutionException { + return this.completableFuture.get(); + } + + @Override + public T get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException { + return this.completableFuture.get(timeout, unit); + } + +} diff --git a/spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/CompletableFutureReturnValueHandler.java b/spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/CompletableFutureReturnValueHandler.java new file mode 100644 index 00000000000..12c1171a250 --- /dev/null +++ b/spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/CompletableFutureReturnValueHandler.java @@ -0,0 +1,46 @@ +/* + * Copyright 2002-2015 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 + * + * http://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.messaging.handler.invocation; + +import java.util.concurrent.CompletableFuture; + +import org.springframework.core.MethodParameter; +import org.springframework.lang.UsesJava8; +import org.springframework.util.concurrent.CompletableToListenableFutureAdapter; +import org.springframework.util.concurrent.ListenableFuture; + +/** + * An {@link AsyncHandlerMethodReturnValueHandler} for {@link CompletableFuture} return type handling. + * + * @author Sebastien Deleuze + * @since 4.2 + */ +@UsesJava8 +public class CompletableFutureReturnValueHandler extends AbstractAsyncReturnValueHandler { + + @Override + public boolean supportsReturnType(MethodParameter returnType) { + return CompletableFuture.class.isAssignableFrom(returnType.getParameterType()); + } + + @Override + @SuppressWarnings("unchecked") + public ListenableFuture toListenableFuture(Object returnValue, MethodParameter returnType) { + return new CompletableToListenableFutureAdapter((CompletableFuture)returnValue); + } + +} \ No newline at end of file diff --git a/spring-messaging/src/main/java/org/springframework/messaging/simp/annotation/support/SimpAnnotationMethodMessageHandler.java b/spring-messaging/src/main/java/org/springframework/messaging/simp/annotation/support/SimpAnnotationMethodMessageHandler.java index 199562672e5..2cfcb25a054 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/simp/annotation/support/SimpAnnotationMethodMessageHandler.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/simp/annotation/support/SimpAnnotationMethodMessageHandler.java @@ -50,6 +50,7 @@ import org.springframework.messaging.handler.annotation.support.MessageMethodArg import org.springframework.messaging.handler.annotation.support.PayloadArgumentResolver; import org.springframework.messaging.handler.invocation.AbstractExceptionHandlerMethodResolver; import org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler; +import org.springframework.messaging.handler.invocation.CompletableFutureReturnValueHandler; import org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver; import org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandler; import org.springframework.messaging.handler.invocation.ListenableFutureReturnValueHandler; @@ -83,6 +84,10 @@ import org.springframework.validation.Validator; public class SimpAnnotationMethodMessageHandler extends AbstractMethodMessageHandler implements SmartLifecycle { + private static final boolean completableFuturePresent = ClassUtils.isPresent("java.util.concurrent.CompletableFuture", + SimpAnnotationMethodMessageHandler.class.getClassLoader()); + + private final SubscribableChannel clientInboundChannel; private final SimpMessageSendingOperations clientMessagingTemplate; @@ -318,6 +323,10 @@ public class SimpAnnotationMethodMessageHandler extends AbstractMethodMessageHan // Single-purpose return value types ListenableFutureReturnValueHandler lfh = new ListenableFutureReturnValueHandler(); handlers.add(lfh); + if (completableFuturePresent) { + CompletableFutureReturnValueHandler cfh = new CompletableFutureReturnValueHandler(); + handlers.add(cfh); + } // Annotation-based return value types SendToMethodReturnValueHandler sth = new SendToMethodReturnValueHandler(this.brokerTemplate, true); diff --git a/spring-messaging/src/test/java/org/springframework/messaging/simp/annotation/support/SimpAnnotationMethodMessageHandlerTests.java b/spring-messaging/src/test/java/org/springframework/messaging/simp/annotation/support/SimpAnnotationMethodMessageHandlerTests.java index 2f26147b774..900b8926593 100644 --- a/spring-messaging/src/test/java/org/springframework/messaging/simp/annotation/support/SimpAnnotationMethodMessageHandlerTests.java +++ b/spring-messaging/src/test/java/org/springframework/messaging/simp/annotation/support/SimpAnnotationMethodMessageHandlerTests.java @@ -21,6 +21,7 @@ import java.util.HashMap; import java.util.LinkedHashMap; import java.util.Map; import java.util.Optional; +import java.util.concurrent.CompletableFuture; import java.util.concurrent.ConcurrentHashMap; import org.junit.Before; @@ -294,6 +295,51 @@ public class SimpAnnotationMethodMessageHandlerTests { assertTrue(controller.exceptionCatched); } + @Test + @SuppressWarnings("unchecked") + public void completableFutureSuccess() { + + given(this.channel.send(any(Message.class))).willReturn(true); + given(this.converter.toMessage(anyObject(), any(MessageHeaders.class))) + .willReturn((Message) MessageBuilder.withPayload(new byte[0]).build()); + + CompletableFutureController controller = new CompletableFutureController(); + this.messageHandler.registerHandler(controller); + this.messageHandler.setDestinationPrefixes(Arrays.asList("/app1", "/app2/")); + SimpMessageHeaderAccessor headers = SimpMessageHeaderAccessor.create(); + headers.setSessionId("session1"); + headers.setSessionAttributes(new HashMap<>()); + headers.setDestination("/app1/completable-future"); + Message message = MessageBuilder.withPayload(new byte[0]).setHeaders(headers).build(); + this.messageHandler.handleMessage(message); + + assertNotNull(controller.future); + controller.future.complete("foo"); + verify(this.converter).toMessage(this.payloadCaptor.capture(), any(MessageHeaders.class)); + assertEquals("foo", this.payloadCaptor.getValue()); + } + + @Test + @SuppressWarnings("unchecked") + public void completableFutureFailure() { + + given(this.channel.send(any(Message.class))).willReturn(true); + given(this.converter.toMessage(anyObject(), any(MessageHeaders.class))) + .willReturn((Message) MessageBuilder.withPayload(new byte[0]).build()); + + CompletableFutureController controller = new CompletableFutureController(); + this.messageHandler.registerHandler(controller); + this.messageHandler.setDestinationPrefixes(Arrays.asList("/app1", "/app2/")); + SimpMessageHeaderAccessor headers = SimpMessageHeaderAccessor.create(); + headers.setSessionId("session1"); + headers.setSessionAttributes(new HashMap<>()); + headers.setDestination("/app1/completable-future"); + Message message = MessageBuilder.withPayload(new byte[0]).setHeaders(headers).build(); + this.messageHandler.handleMessage(message); + + controller.future.completeExceptionally(new IllegalStateException()); + assertTrue(controller.exceptionCatched); + } private static class TestSimpAnnotationMethodMessageHandler extends SimpAnnotationMethodMessageHandler { @@ -413,6 +459,24 @@ public class SimpAnnotationMethodMessageHandlerTests { } + @Controller + private static class CompletableFutureController { + + private CompletableFuture future; + private boolean exceptionCatched = false; + + @MessageMapping("completable-future") + public CompletableFuture handleCompletableFuture() { + this.future = new CompletableFuture<>(); + return this.future; + } + + @MessageExceptionHandler(IllegalStateException.class) + public void handleValidationException() { + this.exceptionCatched = true; + } + + } private static class StringTestValidator implements Validator {