程序包 cn.taketoday.http.converter.protobuf

类 ProtobufHttpMessageConverter

java.lang.Object

cn.taketoday.http.converter.AbstractHttpMessageConverter<com.google.protobuf.Message>

cn.taketoday.http.converter.protobuf.ProtobufHttpMessageConverter

所有已实现的接口:

HttpMessageConverter<com.google.protobuf.Message>

直接已知子类:

ProtobufJsonFormatHttpMessageConverter

public class ProtobufHttpMessageConverter
extends AbstractHttpMessageConverter<com.google.protobuf.Message>

An HttpMessageConverter that reads and writes com.google.protobuf.Messages using Google Protocol Buffers.

To generate Message Java classes, you need to install the protoc binary.

This converter supports by default "application/x-protobuf" and "text/plain" with the official "com.google.protobuf:protobuf-java" library. Other formats can be supported with one of the following additional libraries on the classpath:

• "application/json", "application/xml", and "text/html" (write-only) with the "com.googlecode.protobuf-java-format:protobuf-java-format" third-party library
• "application/json" with the official "com.google.protobuf:protobuf-java-util" for Protobuf 3 (see ProtobufJsonFormatHttpMessageConverter for a configurable variant)

Requires Protobuf 2.6 or higher (and Protobuf Java Format 1.4 or higher for formatting). This converter will auto-adapt to Protobuf 3 and its default protobuf-java-util JSON format if the Protobuf 2 based protobuf-java-format isn't present; however, for more explicit JSON setup on Protobuf 3, consider ProtobufJsonFormatHttpMessageConverter.

从以下版本开始:

4.0

作者:

Alex Antonov, Brian Clozel, Juergen Hoeller, Sebastien Deleuze

另请参阅:

• FormatFactory
• JsonFormat
• ProtobufJsonFormatHttpMessageConverter

嵌套类概要

嵌套类

修饰符和类型	类	说明
(专用程序包) static interface	ProtobufHttpMessageConverter.ProtobufFormatSupport	Protobuf format support.
(专用程序包) static class	ProtobufHttpMessageConverter.ProtobufJavaFormatSupport	ProtobufHttpMessageConverter.ProtobufFormatSupport implementation used when com.googlecode.protobuf.format.FormatFactory is available.
(专用程序包) static class	ProtobufHttpMessageConverter.ProtobufJavaUtilSupport	ProtobufHttpMessageConverter.ProtobufFormatSupport implementation used when com.google.protobuf.util.JsonFormat is available.

字段概要

字段

修饰符和类型	字段	说明
static final Charset	DEFAULT_CHARSET	The default charset used by the converter.
(专用程序包) final com.google.protobuf.ExtensionRegistry	extensionRegistry
private static final Map<Class<?>,Method>	methodCache
static final MediaType	PROTOBUF	The media-type for protobuf application/x-protobuf.
private final ProtobufHttpMessageConverter.ProtobufFormatSupport	protobufFormatSupport
static final String	X_PROTOBUF_MESSAGE_HEADER	The HTTP header containing the protobuf message.
static final String	X_PROTOBUF_SCHEMA_HEADER	The HTTP header containing the protobuf schema.

从类继承的字段 cn.taketoday.http.converter.AbstractHttpMessageConverter

logger

构造器概要

构造器

构造器	说明
ProtobufHttpMessageConverter()	Construct a new ProtobufHttpMessageConverter.
ProtobufHttpMessageConverter(ProtobufHttpMessageConverter.ProtobufFormatSupport formatSupport, com.google.protobuf.ExtensionRegistry extensionRegistry)
ProtobufHttpMessageConverter(com.google.protobuf.ExtensionRegistry extensionRegistry)	Construct a new ProtobufHttpMessageConverter with a registry that specifies protocol message extensions.

方法概要

修饰符和类型	方法	说明
protected boolean	canWrite(MediaType mediaType)	Returns true if the given media type includes any of the supported media types.
protected MediaType	getDefaultContentType(com.google.protobuf.Message message)	Returns the default content type for the given type.
private com.google.protobuf.Message.Builder	getMessageBuilder(Class<? extends com.google.protobuf.Message> clazz)	Create a new Message.Builder instance for the given class.
protected com.google.protobuf.Message	readInternal(Class<? extends com.google.protobuf.Message> clazz, HttpInputMessage inputMessage)	Abstract template method that reads the actual object.
private void	setProtoHeader(HttpOutputMessage response, com.google.protobuf.Message message)	Set the "X-Protobuf-*" HTTP headers when responding with a message of content type "application/x-protobuf"
protected boolean	supports(Class<?> clazz)	Indicates whether the given class is supported by this converter.
protected void	writeInternal(com.google.protobuf.Message message, HttpOutputMessage outputMessage)	Abstract template method that writes the actual body.

从类继承的方法 cn.taketoday.http.converter.AbstractHttpMessageConverter

addDefaultHeaders, canRead, canRead, canWrite, getContentLength, getDefaultCharset, getSupportedMediaTypes, read, setDefaultCharset, setSupportedMediaTypes, write

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

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

从接口继承的方法 cn.taketoday.http.converter.HttpMessageConverter

getSupportedMediaTypes

字段详细资料

DEFAULT_CHARSET

public static final Charset DEFAULT_CHARSET

The default charset used by the converter.

PROTOBUF

public static final MediaType PROTOBUF

The media-type for protobuf application/x-protobuf.

X_PROTOBUF_SCHEMA_HEADER

public static final String X_PROTOBUF_SCHEMA_HEADER

The HTTP header containing the protobuf schema.

另请参阅:

• 常量字段值

X_PROTOBUF_MESSAGE_HEADER

public static final String X_PROTOBUF_MESSAGE_HEADER

The HTTP header containing the protobuf message.

另请参阅:

• 常量字段值

methodCache

private static final Map<Class<?>,Method> methodCache

extensionRegistry

final com.google.protobuf.ExtensionRegistry extensionRegistry

protobufFormatSupport

@Nullable
private final ProtobufHttpMessageConverter.ProtobufFormatSupport protobufFormatSupport

构造器详细资料

ProtobufHttpMessageConverter

public ProtobufHttpMessageConverter()

Construct a new ProtobufHttpMessageConverter.

ProtobufHttpMessageConverter

public ProtobufHttpMessageConverter(com.google.protobuf.ExtensionRegistry extensionRegistry)

Construct a new ProtobufHttpMessageConverter with a registry that specifies protocol message extensions.

参数:

extensionRegistry - the registry to populate

ProtobufHttpMessageConverter

ProtobufHttpMessageConverter(@Nullable
 ProtobufHttpMessageConverter.ProtobufFormatSupport formatSupport,
 @Nullable
 com.google.protobuf.ExtensionRegistry extensionRegistry)

方法详细资料

supports

protected boolean supports(Class<?> clazz)

从类复制的说明: AbstractHttpMessageConverter

Indicates whether the given class is supported by this converter.

指定者:

supports 在类中 AbstractHttpMessageConverter<com.google.protobuf.Message>

参数:

clazz - the class to test for support

返回:

true if supported; false otherwise

getDefaultContentType

protected MediaType getDefaultContentType(com.google.protobuf.Message message)

从类复制的说明: AbstractHttpMessageConverter

Returns the default content type for the given type. Called when AbstractHttpMessageConverter.write(T, cn.taketoday.http.MediaType, cn.taketoday.http.HttpOutputMessage) is invoked without a specified content type parameter.

By default, this returns the first element of the supportedMediaTypes property, if any. Can be overridden in subclasses.

覆盖:

getDefaultContentType 在类中 AbstractHttpMessageConverter<com.google.protobuf.Message>

参数:

message - the type to return the content type for

返回:

the content type, or null if not known

readInternal

protected com.google.protobuf.Message readInternal(Class<? extends com.google.protobuf.Message> clazz,
 HttpInputMessage inputMessage)
                                            throws IOException,
HttpMessageNotReadableException

从类复制的说明: AbstractHttpMessageConverter

Abstract template method that reads the actual object. Invoked from AbstractHttpMessageConverter.read(java.lang.Class<? extends T>, cn.taketoday.http.HttpInputMessage).

指定者:

readInternal 在类中 AbstractHttpMessageConverter<com.google.protobuf.Message>

参数:

clazz - the type of object to return

inputMessage - the HTTP input message to read from

返回:

the converted object

抛出:

IOException - in case of I/O errors

HttpMessageNotReadableException - in case of conversion errors

getMessageBuilder

private com.google.protobuf.Message.Builder getMessageBuilder(Class<? extends com.google.protobuf.Message> clazz)

Create a new Message.Builder instance for the given class.

This method uses a ConcurrentReferenceHashMap for caching method lookups.

canWrite

protected boolean canWrite(@Nullable
 MediaType mediaType)

从类复制的说明: AbstractHttpMessageConverter

Returns true if the given media type includes any of the supported media types.

覆盖:

canWrite 在类中 AbstractHttpMessageConverter<com.google.protobuf.Message>

参数:

mediaType - the media type to write, can be null if not specified. Typically the value of an Accept header.

返回:

true if the supported media types are compatible with the media type, or if the media type is null

writeInternal

protected void writeInternal(com.google.protobuf.Message message,
 HttpOutputMessage outputMessage)
                      throws IOException,
HttpMessageNotWritableException

从类复制的说明: AbstractHttpMessageConverter

Abstract template method that writes the actual body. Invoked from AbstractHttpMessageConverter.write(T, cn.taketoday.http.MediaType, cn.taketoday.http.HttpOutputMessage).

指定者:

writeInternal 在类中 AbstractHttpMessageConverter<com.google.protobuf.Message>

参数:

message - the object to write to the output message

outputMessage - the HTTP output message to write to

抛出:

IOException - in case of I/O errors

HttpMessageNotWritableException - in case of conversion errors

setProtoHeader

private void setProtoHeader(HttpOutputMessage response,
 com.google.protobuf.Message message)

Set the "X-Protobuf-*" HTTP headers when responding with a message of content type "application/x-protobuf"

Note: outputMessage.getBody() should not have been called before because it writes HTTP headers (making them read only).