类 ProtobufEncoder
- java.lang.Object
- org.springframework.http.codec.protobuf.ProtobufCodecSupport
- org.springframework.http.codec.protobuf.ProtobufEncoder
- 所有已实现的接口:
Encoder<com.google.protobuf.Message>
,HttpMessageEncoder<com.google.protobuf.Message>
public class ProtobufEncoder extends ProtobufCodecSupport implements HttpMessageEncoder<com.google.protobuf.Message>
AnEncoder
that writesMessage
s using Google Protocol Buffers.Flux are serialized using delimited Protobuf messages with the size of each message specified before the message itself. Single values are serialized using regular Protobuf message format (without the size prepended before the message).
To generate
Message
Java classes, you need to install theprotoc
binary.This encoder requires Protobuf 3 or higher, and supports
"application/x-protobuf"
and"application/octet-stream"
with the official"com.google.protobuf:protobuf-java"
library.- 从以下版本开始:
- 5.1
- 作者:
- S茅bastien Deleuze
- 另请参阅:
ProtobufDecoder
构造器概要
构造器 构造器 说明 ProtobufEncoder()
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 boolean
canEncode(ResolvableType elementType, MimeType mimeType)
Whether the encoder supports the given source element type and the MIME type for the output stream.reactor.core.publisher.Flux<DataBuffer>
encode(org.reactivestreams.Publisher<? extends com.google.protobuf.Message> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String,Object> hints)
Encode a stream of Objects of typeT
into aDataBuffer
output stream.DataBuffer
encodeValue(com.google.protobuf.Message message, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String,Object> hints)
Encode an Object of type T to a data buffer.List<MimeType>
getEncodableMimeTypes()
Return the list of mime types this encoder supports.List<MediaType>
getStreamingMediaTypes()
Return "streaming" media types for which flushing should be performed automatically vs at the end of the input stream.从类继承的方法 org.springframework.http.codec.protobuf.ProtobufCodecSupport
getMimeTypes, supportsMimeType
从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
从接口继承的方法 org.springframework.http.codec.HttpMessageEncoder
getEncodeHints
构造器详细资料
ProtobufEncoder
public ProtobufEncoder()
方法详细资料
canEncode
public boolean canEncode(ResolvableType elementType, @Nullable MimeType mimeType)
从接口复制的说明:Encoder
Whether the encoder supports the given source element type and the MIME type for the output stream.
encode
public reactor.core.publisher.Flux<DataBuffer> encode(org.reactivestreams.Publisher<? extends com.google.protobuf.Message> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, @Nullable MimeType mimeType, @Nullable Map<String,Object> hints)
从接口复制的说明:Encoder
Encode a stream of Objects of typeT
into aDataBuffer
output stream.- 指定者:
encode
在接口中Encoder<com.google.protobuf.Message>
- 参数:
inputStream
- the input stream of Objects to encode. If the input should be encoded as a single value rather than as a stream of elements, an instance ofMono
should be used.bufferFactory
- for creating output streamDataBuffer
'selementType
- the expected type of elements in the input stream; this type must have been previously passed to theEncoder.canEncode(org.springframework.core.ResolvableType, org.springframework.util.MimeType)
method and it must have returnedtrue
.mimeType
- the MIME type for the output content (optional)hints
- additional information about how to encode- 返回:
- the output stream
encodeValue
public DataBuffer encodeValue(com.google.protobuf.Message message, DataBufferFactory bufferFactory, ResolvableType valueType, @Nullable MimeType mimeType, @Nullable Map<String,Object> hints)
从接口复制的说明:Encoder
Encode an Object of type T to a data buffer. This is useful for scenarios, that distinct messages (or events) are encoded and handled individually, in fully aggregated form.By default this method raises
UnsupportedOperationException
and it is expected that some encoders cannot produce a single buffer or cannot do so synchronously (e.g. encoding aResource
).- 指定者:
encodeValue
在接口中Encoder<com.google.protobuf.Message>
- 参数:
message
- the value to be encodedbufferFactory
- for creating the outputDataBuffer
valueType
- the type for the value being encodedmimeType
- the MIME type for the output content (optional)hints
- additional information about how to encode- 返回:
- the encoded content
getStreamingMediaTypes
public List<MediaType> getStreamingMediaTypes()
从接口复制的说明:HttpMessageEncoder
Return "streaming" media types for which flushing should be performed automatically vs at the end of the input stream.- 指定者:
getStreamingMediaTypes
在接口中HttpMessageEncoder<com.google.protobuf.Message>
getEncodableMimeTypes
public List<MimeType> getEncodableMimeTypes()
从接口复制的说明:Encoder
Return the list of mime types this encoder supports.- 指定者:
getEncodableMimeTypes
在接口中Encoder<com.google.protobuf.Message>