类 ProtobufMessageConverter
- java.lang.Object
- org.springframework.messaging.converter.AbstractMessageConverter
- org.springframework.messaging.converter.ProtobufMessageConverter
- 所有已实现的接口:
MessageConverter
,SmartMessageConverter
public class ProtobufMessageConverter extends AbstractMessageConverter
AnMessageConverter
that reads and writescom.google.protobuf.Messages
using Google Protocol Buffers.To generate
Message
Java classes, you need to install theprotoc
binary.This converter supports by default
"application/x-protobuf"
with the official"com.google.protobuf:protobuf-java"
library."application/json"
can be supported with the official"com.google.protobuf:protobuf-java-util"
3.x, with 3.3 or higher recommended.- 从以下版本开始:
- 5.2.2
- 作者:
- Parviz Rozikov, Rossen Stoyanchev
字段概要
字段 修饰符和类型 字段 说明 static Charset
DEFAULT_CHARSET
The default charset used by the converter.static MimeType
PROTOBUF
The mime-type for protobufapplication/x-protobuf
.从类继承的字段 org.springframework.messaging.converter.AbstractMessageConverter
logger
构造器概要
构造器 构造器 说明 ProtobufMessageConverter()
Constructor with a default instance ofExtensionRegistry
.ProtobufMessageConverter(com.google.protobuf.ExtensionRegistry extensionRegistry)
Constructor with a givenExtensionRegistry
.
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 protected boolean
canConvertTo(Object payload, MessageHeaders headers)
protected Object
convertFromInternal(Message<?> message, Class<?> targetClass, Object conversionHint)
Convert the message payload from serialized form to an Object.protected Object
convertToInternal(Object payload, MessageHeaders headers, Object conversionHint)
Convert the payload object to serialized form.protected boolean
supports(Class<?> clazz)
Whether the given class is supported by this converter.从类继承的方法 org.springframework.messaging.converter.AbstractMessageConverter
addSupportedMimeTypes, canConvertFrom, fromMessage, fromMessage, getContentTypeResolver, getDefaultContentType, getMimeType, getSerializedPayloadClass, getSupportedMimeTypes, isStrictContentTypeMatch, setContentTypeResolver, setSerializedPayloadClass, setStrictContentTypeMatch, supportsMimeType, toMessage, toMessage
字段详细资料
DEFAULT_CHARSET
public static final Charset DEFAULT_CHARSET
The default charset used by the converter.
构造器详细资料
ProtobufMessageConverter
public ProtobufMessageConverter()
Constructor with a default instance ofExtensionRegistry
.
ProtobufMessageConverter
public ProtobufMessageConverter(com.google.protobuf.ExtensionRegistry extensionRegistry)
Constructor with a givenExtensionRegistry
.
方法详细资料
supports
protected boolean supports(Class<?> clazz)
从类复制的说明:AbstractMessageConverter
Whether the given class is supported by this converter.- 指定者:
supports
在类中AbstractMessageConverter
- 参数:
clazz
- the class to test for support- 返回:
true
if supported;false
otherwise
canConvertTo
protected boolean canConvertTo(Object payload, @Nullable MessageHeaders headers)
convertFromInternal
protected Object convertFromInternal(Message<?> message, Class<?> targetClass, @Nullable Object conversionHint)
从类复制的说明:AbstractMessageConverter
Convert the message payload from serialized form to an Object.- 覆盖:
convertFromInternal
在类中AbstractMessageConverter
- 参数:
message
- the input messagetargetClass
- the target class for the conversionconversionHint
- an extra object passed to theMessageConverter
, e.g. the associatedMethodParameter
(may benull
}- 返回:
- the result of the conversion, or
null
if the converter cannot perform the conversion
convertToInternal
protected Object convertToInternal(Object payload, @Nullable MessageHeaders headers, @Nullable Object conversionHint)
从类复制的说明:AbstractMessageConverter
Convert the payload object to serialized form.- 覆盖:
convertToInternal
在类中AbstractMessageConverter
- 参数:
payload
- the Object to convertheaders
- optional headers for the message (may benull
)conversionHint
- an extra object passed to theMessageConverter
, e.g. the associatedMethodParameter
(may benull
}- 返回:
- the resulting payload for the message, or
null
if the converter cannot perform the conversion