Browse Source
Before this change HandlerMethodReturnValueHandler's were invoked in a specific order (type-based, annotation-based, custom). However handlers that deal with asynchronous return value handling need to always be considered first. This affects custom handlers in particular since they are normally ordered last. This change introduces an AsyncHandlerMethodReturnValueHandler sub-interface with a single method to determine if the return value is asynchronous and if it is to look for a matching handler only among those that are of type AsyncHandlerMethodReturnValueHandler. Issue: SPR-13083pull/816/merge
10 changed files with 203 additions and 109 deletions
@ -0,0 +1,50 @@ |
|||||||
|
/* |
||||||
|
* 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.web.method.support; |
||||||
|
|
||||||
|
import org.springframework.core.MethodParameter; |
||||||
|
|
||||||
|
/** |
||||||
|
* A {@link HandlerMethodReturnValueHandler} that handles return values that |
||||||
|
* represent asynchronous computation. Such handlers need to be invoked with |
||||||
|
* precedence over other handlers that might otherwise match the return value |
||||||
|
* type -- e.g. a method that returns a Promise type that is also annotated with |
||||||
|
* {@code @ResponseBody}. |
||||||
|
* |
||||||
|
* <p>In {@link #handleReturnValue}, implementations of this class should create |
||||||
|
* a {@link org.springframework.web.context.request.async.DeferredResult} or |
||||||
|
* adapt to it and then invoke {@code WebAsyncManager} to start async processing. |
||||||
|
* For example: |
||||||
|
* <pre> |
||||||
|
* DeferredResult<?> deferredResult = (DeferredResult<?>) returnValue; |
||||||
|
* WebAsyncUtils.getAsyncManager(webRequest).startDeferredResultProcessing(deferredResult, mavContainer); |
||||||
|
* </pre> |
||||||
|
* the return value to a DeferredResult |
||||||
|
* |
||||||
|
* @author Rossen Stoyanchev |
||||||
|
* @since 4.2 |
||||||
|
*/ |
||||||
|
public interface AsyncHandlerMethodReturnValueHandler extends HandlerMethodReturnValueHandler { |
||||||
|
|
||||||
|
/** |
||||||
|
* Whether the given return value represents asynchronous computation. |
||||||
|
* @param returnValue the return value |
||||||
|
* @param returnType the return type |
||||||
|
* @return {@code true} if the return value is asynchronous. |
||||||
|
*/ |
||||||
|
boolean isAsyncReturnValue(Object returnValue, MethodParameter returnType); |
||||||
|
|
||||||
|
} |
||||||
@ -1,52 +0,0 @@ |
|||||||
/* |
|
||||||
* Copyright 2002-2012 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.web.method.support; |
|
||||||
|
|
||||||
import org.springframework.core.MethodParameter; |
|
||||||
import org.springframework.web.context.request.NativeWebRequest; |
|
||||||
|
|
||||||
/** |
|
||||||
* Supports a fixed return value type. Records the last handled return value. |
|
||||||
* |
|
||||||
* @author Rossen Stoyanchev |
|
||||||
*/ |
|
||||||
public class StubReturnValueHandler implements HandlerMethodReturnValueHandler { |
|
||||||
|
|
||||||
private final Class<?> returnType; |
|
||||||
|
|
||||||
private Object returnValue; |
|
||||||
|
|
||||||
public StubReturnValueHandler(Class<?> returnType) { |
|
||||||
this.returnType = returnType; |
|
||||||
} |
|
||||||
|
|
||||||
public Object getReturnValue() { |
|
||||||
return this.returnValue; |
|
||||||
} |
|
||||||
|
|
||||||
@Override |
|
||||||
public boolean supportsReturnType(MethodParameter returnType) { |
|
||||||
return returnType.getParameterType().equals(this.returnType); |
|
||||||
} |
|
||||||
|
|
||||||
@Override |
|
||||||
public void handleReturnValue(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, |
|
||||||
NativeWebRequest webRequest) throws Exception { |
|
||||||
this.returnValue = returnValue; |
|
||||||
} |
|
||||||
|
|
||||||
} |
|
||||||
Loading…
Reference in new issue