インターフェース AsyncHandlerMethodReturnValueHandler
- すべてのスーパーインターフェース:
HandlerMethodReturnValueHandler
- すべての既知の実装クラス:
AbstractAsyncReturnValueHandler
、CompletableFutureReturnValueHandler
、HandlerMethodReturnValueHandlerComposite
、ListenableFutureReturnValueHandler
、ReactiveReturnValueHandler
成功とエラーのコールバックをサポートする非同期の Future のような戻り値型を処理するための
HandlerMethodReturnValueHandler
の拡張。基本的に、ListenableFuture
に適合できるものなら何でも。 実装では、便利な基本クラス AbstractAsyncReturnValueHandler
の拡張を検討する必要があります。
- 導入:
- 4.2
- 作成者:
- Rossen Stoyanchev
- 関連事項:
メソッドのサマリー
修飾子と型メソッド説明boolean
isAsyncReturnValue
(ObjectSE returnValue, MethodParameter returnType) 戻り値が成功とエラーのコールバックを持つ非同期の Future のような型を表すかどうか。toCompletableFuture
(ObjectSE returnValue, MethodParameter returnType) 非同期の戻り値をCompletableFuture
SE に適合させます。default ListenableFuture<?>
toListenableFuture
(ObjectSE returnValue, MethodParameter returnType) 使用すべきではありません。インターフェース org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandler から継承されたメソッド
handleReturnValue, supportsReturnType
メソッドの詳細
isAsyncReturnValue
戻り値が成功とエラーのコールバックを持つ非同期の Future のような型を表すかどうか。このメソッドがtrue
を返す場合、次にtoCompletableFuture(java.lang.Object, org.springframework.core.MethodParameter)
が呼び出されます。false
を返す場合、HandlerMethodReturnValueHandler.handleReturnValue(java.lang.Object, org.springframework.core.MethodParameter, org.springframework.messaging.Message<?>)
が呼び出されます。注意 : このメソッドは、
HandlerMethodReturnValueHandler.supportsReturnType(org.springframework.core.MethodParameter)
が呼び出され、true
が返された後にのみ呼び出されます。- パラメーター:
returnValue
- ハンドラーメソッドから返された値returnType
- 戻り値の型- 戻り値:
- 戻り値の型が非同期値を表す場合は
true
toListenableFuture
@DeprecatedSE(since="6.0") @Nullable default ListenableFuture<?> toListenableFuture(ObjectSE returnValue, MethodParameter returnType) 使用すべきではありません。6.0 現在、toCompletableFuture(Object, MethodParameter)
を推奨非同期の戻り値をListenableFuture
に適合させます。実装では、
SettableListenableFuture
のインスタンスを返すことを検討する必要があります。ListenableFuture が成功またはエラーで完了すると、戻り値の処理が続行されます。注意 : このメソッドは、
HandlerMethodReturnValueHandler.supportsReturnType(org.springframework.core.MethodParameter)
が呼び出され、true
が返された後にのみ呼び出されます。- パラメーター:
returnValue
- ハンドラーメソッドから返された値returnType
- 戻り値の型- 戻り値:
- 結果の ListenableFuture、または
null
。この場合、それ以上の処理は実行されません。
toCompletableFuture
@Nullable CompletableFutureSE<?> toCompletableFuture(ObjectSE returnValue, MethodParameter returnType) 非同期の戻り値をCompletableFuture
SE に適合させます。CompletableFuture が成功またはエラーで完了すると、戻り値の処理が続行されます。
注意 : このメソッドは、
HandlerMethodReturnValueHandler.supportsReturnType(org.springframework.core.MethodParameter)
が呼び出され、true
が返された後にのみ呼び出されます。- パラメーター:
returnValue
- ハンドラーメソッドから返された値returnType
- 戻り値の型- 戻り値:
- 結果の CompletableFuture、または
null
。この場合、それ以上の処理は実行されません。 - 導入:
- 6.0
toCompletableFuture(Object, MethodParameter)
を推奨