程序包 cn.taketoday.web.handler.method

类 ResponseBodyEmitterReturnValueHandler

java.lang.Object

cn.taketoday.web.handler.method.ResponseBodyEmitterReturnValueHandler

所有已实现的接口:

SmartReturnValueHandler, ReturnValueHandler

public class ResponseBodyEmitterReturnValueHandler
extends Object
implements SmartReturnValueHandler

Handler for return values of type ResponseBodyEmitter and sub-classes such as SseEmitter including the same types wrapped with ResponseEntity.

also supports reactive return value types for any reactive library with registered adapters in ReactiveAdapterRegistry.

从以下版本开始:

4.0 2022/4/9 13:36

作者:

Rossen Stoyanchev, Harry Yang

嵌套类概要

嵌套类

修饰符和类型	类	说明
private class	ResponseBodyEmitterReturnValueHandler.HttpMessageConvertingHandler	ResponseBodyEmitter.Handler that writes with HttpMessageConverter's.

字段概要

字段

修饰符和类型	字段	说明
private final ReactiveTypeHandler	reactiveHandler
private final List<HttpMessageConverter<?>>	sseMessageConverters

从接口继承的字段 cn.taketoday.web.ReturnValueHandler

NONE_RETURN_VALUE

构造器概要

构造器

构造器	说明
ResponseBodyEmitterReturnValueHandler(List<HttpMessageConverter<?>> messageConverters)	Simple constructor with reactive type support based on a default instance of ReactiveAdapterRegistry, SyncTaskExecutor, and ContentNegotiationManager with an Accept header strategy.
ResponseBodyEmitterReturnValueHandler(List<HttpMessageConverter<?>> messageConverters, cn.taketoday.core.ReactiveAdapterRegistry registry, cn.taketoday.core.task.TaskExecutor executor, ContentNegotiationManager manager)	Complete constructor with pluggable "reactive" type support.
ResponseBodyEmitterReturnValueHandler(List<HttpMessageConverter<?>> messageConverters, ContentNegotiationManager manager)	Complete constructor with pluggable "reactive" type support.

方法概要

修饰符和类型	方法	说明
void	handleReturnValue(RequestContext request, Object handler, Object returnValue)	Handle result of the handler
private static List<HttpMessageConverter<?>>	initSseConverters(List<HttpMessageConverter<?>> converters)
boolean	supportsHandler(Object handler)	If this ReturnValueHandler supports the target handler
boolean	supportsHandler(Object handler, Object returnValue)	handle handler and its return value
boolean	supportsReturnType(cn.taketoday.core.MethodParameter returnType)
boolean	supportsReturnValue(Object returnValue)	If this ReturnValueHandler supports the target handler's result

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

sseMessageConverters

private final List<HttpMessageConverter<?>> sseMessageConverters

reactiveHandler

private final ReactiveTypeHandler reactiveHandler

构造器详细资料

ResponseBodyEmitterReturnValueHandler

public ResponseBodyEmitterReturnValueHandler(List<HttpMessageConverter<?>> messageConverters)

Simple constructor with reactive type support based on a default instance of ReactiveAdapterRegistry, SyncTaskExecutor, and ContentNegotiationManager with an Accept header strategy.

ResponseBodyEmitterReturnValueHandler

public ResponseBodyEmitterReturnValueHandler(List<HttpMessageConverter<?>> messageConverters,
 ContentNegotiationManager manager)

Complete constructor with pluggable "reactive" type support.

参数:

messageConverters - converters to write emitted objects with

manager - for detecting streaming media types

ResponseBodyEmitterReturnValueHandler

public ResponseBodyEmitterReturnValueHandler(List<HttpMessageConverter<?>> messageConverters,
 cn.taketoday.core.ReactiveAdapterRegistry registry,
 cn.taketoday.core.task.TaskExecutor executor,
 ContentNegotiationManager manager)

Complete constructor with pluggable "reactive" type support.

参数:

messageConverters - converters to write emitted objects with

registry - for reactive return value type support

executor - for blocking I/O writes of items emitted from reactive types

manager - for detecting streaming media types

方法详细资料

initSseConverters

private static List<HttpMessageConverter<?>> initSseConverters(List<HttpMessageConverter<?>> converters)

supportsHandler

public boolean supportsHandler(Object handler)

从接口复制的说明: ReturnValueHandler

If this ReturnValueHandler supports the target handler

This method can test this ReturnValueHandler supports the target handler in application startup time , static match

指定者:

supportsHandler 在接口中 ReturnValueHandler

指定者:

supportsHandler 在接口中 SmartReturnValueHandler

参数:

handler - Target HTTP handler

返回:

If this ReturnValueHandler supports the target handler

supportsHandler

public boolean supportsHandler(Object handler,
 @Nullable
 Object returnValue)

从接口复制的说明: SmartReturnValueHandler

handle handler and its return value

default is supportsHandler or supportsReturnValue returns true

指定者:

supportsHandler 在接口中 SmartReturnValueHandler

参数:

handler - target handler

returnValue - handler's return value

supportsReturnType

public boolean supportsReturnType(cn.taketoday.core.MethodParameter returnType)

supportsReturnValue

public boolean supportsReturnValue(@Nullable
 Object returnValue)

从接口复制的说明: ReturnValueHandler

If this ReturnValueHandler supports the target handler's result

This method can test this ReturnValueHandler supports the target handler in application runtime

指定者:

supportsReturnValue 在接口中 ReturnValueHandler

参数:

returnValue - Target handler's return-value or result

返回:

If this ReturnValueHandler supports the target handler's result

handleReturnValue

public void handleReturnValue(RequestContext request,
 @Nullable
 Object handler,
 @Nullable
 Object returnValue)
                       throws Exception

从接口复制的说明: ReturnValueHandler

Handle result of the handler

指定者:

handleReturnValue 在接口中 ReturnValueHandler

参数:

request - Current HTTP request context

handler - Target HTTP handler

returnValue - Handler execution result Or HandlerExceptionHandler return value

抛出:

Exception - return-value handled failed