程序包 cn.taketoday.http.codec.support

类 BaseDefaultCodecs

java.lang.Object

cn.taketoday.http.codec.support.BaseDefaultCodecs

所有已实现的接口:

CodecConfigurer.DefaultCodecConfig, CodecConfigurer.DefaultCodecs

直接已知子类:

ClientDefaultCodecsImpl, ServerDefaultCodecsImpl

class BaseDefaultCodecs
extends Object
implements CodecConfigurer.DefaultCodecs, CodecConfigurer.DefaultCodecConfig

Default implementation of CodecConfigurer.DefaultCodecs that serves as a base for client and server specific variants.

作者:

Rossen Stoyanchev, Sebastien Deleuze

嵌套类概要

嵌套类

修饰符和类型	类	说明
protected class	BaseDefaultCodecs.DefaultMultipartCodecs	Default implementation of CodecConfigurer.MultipartCodecs.

字段概要

字段

修饰符和类型	字段	说明
private Consumer<Object>	codecConsumer
private Boolean	enableLoggingRequestDetails
private cn.taketoday.core.codec.Decoder<?>	jackson2JsonDecoder
private cn.taketoday.core.codec.Encoder<?>	jackson2JsonEncoder
(专用程序包) static final boolean	jackson2Present
private cn.taketoday.core.codec.Decoder<?>	jackson2SmileDecoder
private cn.taketoday.core.codec.Encoder<?>	jackson2SmileEncoder
private static final boolean	jackson2SmilePresent
private Integer	maxInMemorySize
private BaseDefaultCodecs.DefaultMultipartCodecs	multipartCodecs
private HttpMessageReader<?>	multipartReader
(专用程序包) static final boolean	netty5BufferPresent
(专用程序包) static final boolean	nettyByteBufPresent
private final ArrayList<HttpMessageReader<?>>	objectReaders
private final ArrayList<HttpMessageWriter<?>>	objectWriters
private Supplier<List<HttpMessageWriter<?>>>	partWritersSupplier
private cn.taketoday.core.codec.Decoder<?>	protobufDecoder
private cn.taketoday.core.codec.Encoder<?>	protobufEncoder
private static final boolean	protobufPresent
private boolean	registerDefaults
(专用程序包) static final boolean	synchronossMultipartPresent
private final ArrayList<HttpMessageReader<?>>	typedReaders
private final ArrayList<HttpMessageWriter<?>>	typedWriters

构造器概要

构造器

限定符	构造器	说明
(专用程序包)	BaseDefaultCodecs()
protected	BaseDefaultCodecs(BaseDefaultCodecs other)	Create a deep copy of the given BaseDefaultCodecs.

方法概要

修饰符和类型	方法	说明
protected <T> void	addCodec(List<T> codecs, T codec)	Initialize a codec and add it to the List.
(专用程序包) void	applyDefaultConfig(BaseCodecConfigurer.DefaultCustomCodecs customCodecs)
private void	applyDefaultConfig(Map<?,Boolean> readers)
void	configureDefaultCodec(Consumer<Object> codecConsumer)	Register a consumer to apply to default config instances.
void	enableLoggingRequestDetails(boolean enable)	Whether to log form data at DEBUG level, and headers at TRACE level.
protected void	extendObjectReaders(List<HttpMessageReader<?>> objectReaders)	Hook for client or server specific Object readers.
protected void	extendObjectWriters(List<HttpMessageWriter<?>> objectWriters)	Hook for client or server specific Object writers.
protected void	extendTypedReaders(List<HttpMessageReader<?>> typedReaders)	Hook for client or server specific typed readers.
protected void	extendTypedWriters(List<HttpMessageWriter<?>> typedWriters)	Hook for client or server specific typed writers.
(专用程序包) final List<HttpMessageWriter<?>>	getBaseObjectWriters()	Return "base" object writers only, i.e. common to client and server.
(专用程序包) final List<HttpMessageWriter<?>>	getBaseTypedWriters()	Return "base" typed writers only, i.e. common to client and server.
(专用程序包) final List<HttpMessageReader<?>>	getCatchAllReaders()	Return readers that need to be at the end, after all others.
(专用程序包) List<HttpMessageWriter<?>>	getCatchAllWriters()	Return writers that need to be at the end, after all others.
protected cn.taketoday.core.codec.Decoder<?>	getJackson2JsonDecoder()
protected cn.taketoday.core.codec.Encoder<?>	getJackson2JsonEncoder()
(专用程序包) final List<HttpMessageReader<?>>	getObjectReaders()	Return Object readers (JSON, XML, SSE).
(专用程序包) final List<HttpMessageWriter<?>>	getObjectWriters()	Return Object writers (JSON, XML, SSE).
private List<HttpMessageWriter<?>>	getPartWriters()
(专用程序包) final List<HttpMessageReader<?>>	getTypedReaders()	Return readers that support specific types.
(专用程序包) final List<HttpMessageWriter<?>>	getTypedWriters()	Return all writers that support specific types.
private void	initCodec(Object codec)	Apply maxInMemorySize() and enableLoggingRequestDetails, if configured by the application, to the given codec , including any codec it contains.
protected void	initObjectReaders()	Reset and initialize object readers.
protected void	initObjectWriters()	Reset and initialize object writers.
protected void	initReaders()	Reset and initialize typed readers and object readers.
protected void	initTypedReaders()	Reset and initialize typed readers.
protected void	initTypedWriters()	Reset and initialize typed writers.
protected void	initWriters()	Reset and initialize typed writers and object writers.
Boolean	isEnableLoggingRequestDetails()	Whether to log form data at DEBUG level, and headers at TRACE level.
void	jackson2JsonDecoder(cn.taketoday.core.codec.Decoder<?> decoder)	Override the default Jackson JSON Decoder.
void	jackson2JsonEncoder(cn.taketoday.core.codec.Encoder<?> encoder)	Override the default Jackson JSON Encoder.
void	jackson2SmileDecoder(cn.taketoday.core.codec.Decoder<?> decoder)	Override the default Jackson Smile Decoder.
void	jackson2SmileEncoder(cn.taketoday.core.codec.Encoder<?> encoder)	Override the default Jackson Smile Encoder.
Integer	maxInMemorySize()	Get the configured limit on the number of bytes that can be buffered whenever the input stream needs to be aggregated.
void	maxInMemorySize(int byteCount)	Configure a limit on the number of bytes that can be buffered whenever the input stream needs to be aggregated.
CodecConfigurer.MultipartCodecs	multipartCodecs()	Configure encoders or writers for use with MultipartHttpMessageWriter.
void	multipartReader(HttpMessageReader<?> multipartReader)	Configure the HttpMessageReader to use for multipart requests.
void	protobufDecoder(cn.taketoday.core.codec.Decoder<?> decoder)	Override the default Protobuf Decoder.
void	protobufEncoder(cn.taketoday.core.codec.Encoder<?> encoder)	Override the default Protobuf Encoder.
(专用程序包) void	registerDefaults(boolean registerDefaults)	Delegate method used from BaseCodecConfigurer.registerDefaults(boolean).
(专用程序包) void	setPartWritersSupplier(Supplier<List<HttpMessageWriter<?>>> supplier)	Set a supplier for part writers to use when multipartCodecs() are not explicitly configured.

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

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

字段详细资料

jackson2Present

static final boolean jackson2Present

nettyByteBufPresent

static final boolean nettyByteBufPresent

synchronossMultipartPresent

static final boolean synchronossMultipartPresent

protobufPresent

private static final boolean protobufPresent

jackson2SmilePresent

private static final boolean jackson2SmilePresent

netty5BufferPresent

static final boolean netty5BufferPresent

jackson2JsonDecoder

@Nullable
private cn.taketoday.core.codec.Decoder<?> jackson2JsonDecoder

jackson2JsonEncoder

@Nullable
private cn.taketoday.core.codec.Encoder<?> jackson2JsonEncoder

jackson2SmileEncoder

@Nullable
private cn.taketoday.core.codec.Encoder<?> jackson2SmileEncoder

jackson2SmileDecoder

@Nullable
private cn.taketoday.core.codec.Decoder<?> jackson2SmileDecoder

protobufDecoder

@Nullable
private cn.taketoday.core.codec.Decoder<?> protobufDecoder

protobufEncoder

@Nullable
private cn.taketoday.core.codec.Encoder<?> protobufEncoder

multipartCodecs

@Nullable
private BaseDefaultCodecs.DefaultMultipartCodecs multipartCodecs

partWritersSupplier

@Nullable
private Supplier<List<HttpMessageWriter<?>>> partWritersSupplier

multipartReader

@Nullable
private HttpMessageReader<?> multipartReader

codecConsumer

@Nullable
private Consumer<Object> codecConsumer

maxInMemorySize

@Nullable
private Integer maxInMemorySize

enableLoggingRequestDetails

@Nullable
private Boolean enableLoggingRequestDetails

registerDefaults

private boolean registerDefaults

typedReaders

private final ArrayList<HttpMessageReader<?>> typedReaders

objectReaders

private final ArrayList<HttpMessageReader<?>> objectReaders

typedWriters

private final ArrayList<HttpMessageWriter<?>> typedWriters

objectWriters

private final ArrayList<HttpMessageWriter<?>> objectWriters

构造器详细资料

BaseDefaultCodecs

BaseDefaultCodecs()

BaseDefaultCodecs

protected BaseDefaultCodecs(BaseDefaultCodecs other)

Create a deep copy of the given BaseDefaultCodecs.

方法详细资料

initReaders

protected void initReaders()

Reset and initialize typed readers and object readers.

initWriters

protected void initWriters()

Reset and initialize typed writers and object writers.

jackson2JsonDecoder

public void jackson2JsonDecoder(cn.taketoday.core.codec.Decoder<?> decoder)

从接口复制的说明: CodecConfigurer.DefaultCodecs

Override the default Jackson JSON Decoder.

Note that CodecConfigurer.DefaultCodecs.maxInMemorySize(int), if configured, will be applied to the given decoder.

指定者:

jackson2JsonDecoder 在接口中 CodecConfigurer.DefaultCodecs

参数:

decoder - the decoder instance to use

另请参阅:

• Jackson2JsonDecoder

jackson2JsonEncoder

public void jackson2JsonEncoder(cn.taketoday.core.codec.Encoder<?> encoder)

从接口复制的说明: CodecConfigurer.DefaultCodecs

Override the default Jackson JSON Encoder.

指定者:

jackson2JsonEncoder 在接口中 CodecConfigurer.DefaultCodecs

参数:

encoder - the encoder instance to use

另请参阅:

• Jackson2JsonEncoder

jackson2SmileDecoder

public void jackson2SmileDecoder(cn.taketoday.core.codec.Decoder<?> decoder)

从接口复制的说明: CodecConfigurer.DefaultCodecs

Override the default Jackson Smile Decoder.

Note that CodecConfigurer.DefaultCodecs.maxInMemorySize(int), if configured, will be applied to the given decoder.

指定者:

jackson2SmileDecoder 在接口中 CodecConfigurer.DefaultCodecs

参数:

decoder - the decoder instance to use

另请参阅:

• Jackson2SmileDecoder

jackson2SmileEncoder

public void jackson2SmileEncoder(cn.taketoday.core.codec.Encoder<?> encoder)

从接口复制的说明: CodecConfigurer.DefaultCodecs

Override the default Jackson Smile Encoder.

指定者:

jackson2SmileEncoder 在接口中 CodecConfigurer.DefaultCodecs

参数:

encoder - the encoder instance to use

另请参阅:

• Jackson2SmileEncoder

protobufDecoder

public void protobufDecoder(cn.taketoday.core.codec.Decoder<?> decoder)

从接口复制的说明: CodecConfigurer.DefaultCodecs

Override the default Protobuf Decoder.

Note that CodecConfigurer.DefaultCodecs.maxInMemorySize(int), if configured, will be applied to the given decoder.

指定者:

protobufDecoder 在接口中 CodecConfigurer.DefaultCodecs

参数:

decoder - the decoder instance to use

另请参阅:

• ProtobufDecoder

protobufEncoder

public void protobufEncoder(cn.taketoday.core.codec.Encoder<?> encoder)

从接口复制的说明: CodecConfigurer.DefaultCodecs

Override the default Protobuf Encoder.

指定者:

protobufEncoder 在接口中 CodecConfigurer.DefaultCodecs

参数:

encoder - the encoder instance to use

另请参阅:

• ProtobufEncoder
• ProtobufHttpMessageWriter

configureDefaultCodec

public void configureDefaultCodec(Consumer<Object> codecConsumer)

从接口复制的说明: CodecConfigurer.DefaultCodecs

Register a consumer to apply to default config instances. This can be used to configure rather than replace a specific codec or multiple codecs. The consumer is applied to every default Encoder, Decoder, HttpMessageReader and HttpMessageWriter instance.

指定者:

configureDefaultCodec 在接口中 CodecConfigurer.DefaultCodecs

参数:

codecConsumer - the consumer to apply

maxInMemorySize

public void maxInMemorySize(int byteCount)

从接口复制的说明: CodecConfigurer.DefaultCodecs

Configure a limit on the number of bytes that can be buffered whenever the input stream needs to be aggregated. This can be a result of decoding to a single DataBuffer, ByteBuffer, byte[], Resource, String, etc. It can also occur when splitting the input stream, e.g. delimited text, in which case the limit applies to data buffered between delimiters.

By default this is not set, in which case individual codec defaults apply. All codecs are limited to 256K by default.

指定者:

maxInMemorySize 在接口中 CodecConfigurer.DefaultCodecs

参数:

byteCount - the max number of bytes to buffer, or -1 for unlimited

maxInMemorySize

@Nullable
public Integer maxInMemorySize()

从接口复制的说明: CodecConfigurer.DefaultCodecConfig

Get the configured limit on the number of bytes that can be buffered whenever the input stream needs to be aggregated.

指定者:

maxInMemorySize 在接口中 CodecConfigurer.DefaultCodecConfig

enableLoggingRequestDetails

public void enableLoggingRequestDetails(boolean enable)

从接口复制的说明: CodecConfigurer.DefaultCodecs

Whether to log form data at DEBUG level, and headers at TRACE level. Both may contain sensitive information.

By default set to false so that request details are not shown.

指定者:

enableLoggingRequestDetails 在接口中 CodecConfigurer.DefaultCodecs

参数:

enable - whether to enable or not

multipartCodecs

public CodecConfigurer.MultipartCodecs multipartCodecs()

从接口复制的说明: CodecConfigurer.DefaultCodecs

Configure encoders or writers for use with MultipartHttpMessageWriter.

指定者:

multipartCodecs 在接口中 CodecConfigurer.DefaultCodecs

multipartReader

public void multipartReader(HttpMessageReader<?> multipartReader)

从接口复制的说明: CodecConfigurer.DefaultCodecs

Configure the HttpMessageReader to use for multipart requests.

Note that CodecConfigurer.DefaultCodecs.maxInMemorySize(int) and/or CodecConfigurer.DefaultCodecs.enableLoggingRequestDetails(boolean), if configured, will be applied to the given reader, if applicable.

指定者:

multipartReader 在接口中 CodecConfigurer.DefaultCodecs

参数:

multipartReader - the message reader to use for multipart requests.

setPartWritersSupplier

void setPartWritersSupplier(Supplier<List<HttpMessageWriter<?>>> supplier)

Set a supplier for part writers to use when multipartCodecs() are not explicitly configured. That's the same set of writers as for general except for the multipart writer itself.

isEnableLoggingRequestDetails

@Nullable
public Boolean isEnableLoggingRequestDetails()

从接口复制的说明: CodecConfigurer.DefaultCodecConfig

Whether to log form data at DEBUG level, and headers at TRACE level. Both may contain sensitive information.

指定者:

isEnableLoggingRequestDetails 在接口中 CodecConfigurer.DefaultCodecConfig

registerDefaults

void registerDefaults(boolean registerDefaults)

Delegate method used from BaseCodecConfigurer.registerDefaults(boolean).

getTypedReaders

final List<HttpMessageReader<?>> getTypedReaders()

Return readers that support specific types.

initTypedReaders

protected void initTypedReaders()

Reset and initialize typed readers.

addCodec

protected <T> void addCodec(List<T> codecs,
 T codec)

Initialize a codec and add it to the List.

initCodec

private void initCodec(@Nullable
 Object codec)

Apply maxInMemorySize() and enableLoggingRequestDetails, if configured by the application, to the given codec , including any codec it contains.

extendTypedReaders

protected void extendTypedReaders(List<HttpMessageReader<?>> typedReaders)

Hook for client or server specific typed readers.

getObjectReaders

final List<HttpMessageReader<?>> getObjectReaders()

Return Object readers (JSON, XML, SSE).

initObjectReaders

protected void initObjectReaders()

Reset and initialize object readers.

extendObjectReaders

protected void extendObjectReaders(List<HttpMessageReader<?>> objectReaders)

Hook for client or server specific Object readers.

getCatchAllReaders

final List<HttpMessageReader<?>> getCatchAllReaders()

Return readers that need to be at the end, after all others.

getTypedWriters

final List<HttpMessageWriter<?>> getTypedWriters()

Return all writers that support specific types.

initTypedWriters

protected void initTypedWriters()

Reset and initialize typed writers.

从以下版本开始:

4.0

getBaseTypedWriters

final List<HttpMessageWriter<?>> getBaseTypedWriters()

Return "base" typed writers only, i.e. common to client and server.

getPartWriters

private List<HttpMessageWriter<?>> getPartWriters()

extendTypedWriters

protected void extendTypedWriters(List<HttpMessageWriter<?>> typedWriters)

Hook for client or server specific typed writers.

getObjectWriters

final List<HttpMessageWriter<?>> getObjectWriters()

Return Object writers (JSON, XML, SSE).

initObjectWriters

protected void initObjectWriters()

Reset and initialize object writers.

getBaseObjectWriters

final List<HttpMessageWriter<?>> getBaseObjectWriters()

Return "base" object writers only, i.e. common to client and server.

extendObjectWriters

protected void extendObjectWriters(List<HttpMessageWriter<?>> objectWriters)

Hook for client or server specific Object writers.

getCatchAllWriters

List<HttpMessageWriter<?>> getCatchAllWriters()

Return writers that need to be at the end, after all others.

applyDefaultConfig

void applyDefaultConfig(BaseCodecConfigurer.DefaultCustomCodecs customCodecs)

applyDefaultConfig

private void applyDefaultConfig(Map<?,Boolean> readers)

getJackson2JsonDecoder

protected cn.taketoday.core.codec.Decoder<?> getJackson2JsonDecoder()

getJackson2JsonEncoder

protected cn.taketoday.core.codec.Encoder<?> getJackson2JsonEncoder()