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

类 ReactiveTypeHandler

java.lang.Object

cn.taketoday.web.handler.method.ReactiveTypeHandler

final class ReactiveTypeHandler
extends Object

Private helper class to assist with handling "reactive" return values types that can be adapted to a Reactive Streams Publisher through the ReactiveAdapterRegistry.

Such return values may be bridged to a ResponseBodyEmitter for streaming purposes at the presence of a streaming media type or based on the generic type.

For all other cases Publisher output is collected and bridged to DeferredResult for standard async request processing.

从以下版本开始:

4.0 2022/4/8 23:54

作者:

Rossen Stoyanchev, Harry Yang

嵌套类概要

嵌套类

修饰符和类型	类	说明
private static class	ReactiveTypeHandler.AbstractEmitterSubscriber
(专用程序包) static class	ReactiveTypeHandler.CollectedValuesList	List of collect values where all elements are a specified type.
private static class	ReactiveTypeHandler.DeferredResultSubscriber
private static class	ReactiveTypeHandler.JsonEmitterSubscriber
private static class	ReactiveTypeHandler.SseEmitterSubscriber
private static class	ReactiveTypeHandler.TextEmitterSubscriber

字段概要

字段

修饰符和类型	字段	说明
private final cn.taketoday.core.ReactiveAdapterRegistry	adapterRegistry
private final ContentNegotiationManager	contentNegotiationManager
private static final cn.taketoday.logging.Logger	log
private static final long	STREAMING_TIMEOUT_VALUE
private final cn.taketoday.core.task.TaskExecutor	taskExecutor
private static final MediaType	WILDCARD_SUBTYPE_SUFFIXED_BY_NDJSON

构造器概要

构造器

构造器	说明
ReactiveTypeHandler()
ReactiveTypeHandler(cn.taketoday.core.ReactiveAdapterRegistry registry, cn.taketoday.core.task.TaskExecutor executor, ContentNegotiationManager manager)
ReactiveTypeHandler(ContentNegotiationManager manager)

方法概要

修饰符和类型	方法	说明
(专用程序包) static MediaType	findConcreteStreamingMediaType(Collection<MediaType> acceptedMediaTypes)	Attempts to find a concrete MediaType that can be streamed (as json separated by newlines in the response body).
private ResponseBodyEmitter	getEmitter(MediaType mediaType)
private Collection<MediaType>	getMediaTypes(RequestContext request)
ResponseBodyEmitter	handleValue(Object returnValue, cn.taketoday.core.MethodParameter returnType, RequestContext request)	Process the given reactive return value and decide whether to adapt it to a ResponseBodyEmitter or a DeferredResult.
boolean	isReactiveType(Class<?> type)	Whether the type can be adapted to a Reactive Streams Publisher.

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

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

字段详细资料

log

private static final cn.taketoday.logging.Logger log

STREAMING_TIMEOUT_VALUE

private static final long STREAMING_TIMEOUT_VALUE

另请参阅:

• 常量字段值

WILDCARD_SUBTYPE_SUFFIXED_BY_NDJSON

private static final MediaType WILDCARD_SUBTYPE_SUFFIXED_BY_NDJSON

taskExecutor

private final cn.taketoday.core.task.TaskExecutor taskExecutor

adapterRegistry

private final cn.taketoday.core.ReactiveAdapterRegistry adapterRegistry

contentNegotiationManager

private final ContentNegotiationManager contentNegotiationManager

构造器详细资料

ReactiveTypeHandler

public ReactiveTypeHandler()

ReactiveTypeHandler

public ReactiveTypeHandler(ContentNegotiationManager manager)

ReactiveTypeHandler

public ReactiveTypeHandler(cn.taketoday.core.ReactiveAdapterRegistry registry,
 cn.taketoday.core.task.TaskExecutor executor,
 ContentNegotiationManager manager)

方法详细资料

isReactiveType

public boolean isReactiveType(Class<?> type)

Whether the type can be adapted to a Reactive Streams Publisher.

handleValue

@Nullable
public ResponseBodyEmitter handleValue(Object returnValue,
 cn.taketoday.core.MethodParameter returnType,
 RequestContext request)
                                throws Exception

Process the given reactive return value and decide whether to adapt it to a ResponseBodyEmitter or a DeferredResult.

返回:

an emitter for streaming, or null if handled internally with a DeferredResult

抛出:

Exception

findConcreteStreamingMediaType

@Nullable
static MediaType findConcreteStreamingMediaType(Collection<MediaType> acceptedMediaTypes)

Attempts to find a concrete MediaType that can be streamed (as json separated by newlines in the response body). This method considers two concrete types APPLICATION_NDJSON and APPLICATION_STREAM_JSON) as well as any subtype of application that has the +x-ndjson suffix. In the later case, the media type MUST be concrete for it to be considered.

For example application/vnd.myapp+x-ndjson is considered a streaming type while application/*+x-ndjson isn't.

参数:

acceptedMediaTypes - the collection of acceptable media types in the request

返回:

the concrete streaming MediaType if one could be found or null if none could be found

getMediaTypes

private Collection<MediaType> getMediaTypes(RequestContext request)
                                     throws HttpMediaTypeNotAcceptableException

抛出:

HttpMediaTypeNotAcceptableException

getEmitter

private ResponseBodyEmitter getEmitter(MediaType mediaType)