类 ProtobufMessageConverter
- java.lang.Object
- org.springframework.messaging.converter.AbstractMessageConverter
- org.springframework.messaging.converter.ProtobufMessageConverter
- 所有已实现的接口:
MessageConverter,SmartMessageConverter
public class ProtobufMessageConverter extends AbstractMessageConverter
AnMessageConverterthat reads and writescom.google.protobuf.Messagesusing Google Protocol Buffers.To generate
MessageJava classes, you need to install theprotocbinary.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 CharsetDEFAULT_CHARSETThe default charset used by the converter.static MimeTypePROTOBUFThe 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 booleancanConvertTo(Object payload, MessageHeaders headers)protected ObjectconvertFromInternal(Message<?> message, Class<?> targetClass, Object conversionHint)Convert the message payload from serialized form to an Object.protected ObjectconvertToInternal(Object payload, MessageHeaders headers, Object conversionHint)Convert the payload object to serialized form.protected booleansupports(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)
从类复制的说明:AbstractMessageConverterWhether the given class is supported by this converter.- 指定者:
supports在类中AbstractMessageConverter- 参数:
clazz- the class to test for support- 返回:
trueif supported;falseotherwise
canConvertTo
protected boolean canConvertTo(Object payload, @Nullable MessageHeaders headers)
convertFromInternal
protected Object convertFromInternal(Message<?> message, Class<?> targetClass, @Nullable Object conversionHint)
从类复制的说明:AbstractMessageConverterConvert 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
nullif the converter cannot perform the conversion
convertToInternal
protected Object convertToInternal(Object payload, @Nullable MessageHeaders headers, @Nullable Object conversionHint)
从类复制的说明:AbstractMessageConverterConvert 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
nullif the converter cannot perform the conversion