第 2 章 使用 ProtoStream Marshalling 自定义对象

Data Grid 使用 ProtoStream 库，它可以为键和值处理以下类型，在使用原语类型时，会取消选择的等效项：

额外的类型集合

ProtoStream 库包括几个用于常见 Java 类型的适配器类，例如：

Data Grid 为 protostream-types 工件中的一些常见 JDK 类提供所有适配器类，它们包含在 infinispan-core 和 infinispan-client-hotrod 依赖项中。您不需要任何配置将适配器类存储为键或值。

但是，如果要使用适配器类作为 ProtoStream-annotated POJOS 中的可 marshallable 字段，您可以使用以下方法进行：

@AutoProtoSchemaBuilder(dependsOn = {org.infinispan.protostream.types.java.CommonTypes, org.infinispan.protostream.types.java.CommonContainerTypes}, schemaFileName = "library.proto", schemaFilePath = "proto", schemaPackageName = "example")
public interface LibraryInitalizer extends SerializationContextInitializer {
}

@AutoProtoSchemaBuilder(dependsOn = {org.infinispan.protostream.types.java.CommonTypes, org.infinispan.protostream.types.java.CommonContainerTypes}, schemaFileName = "library.proto", schemaFilePath = "proto", schemaPackageName = "example")
public interface LibraryInitalizer extends SerializationContextInitializer {
}

@AutoProtoSchemaBuilder(includeClasses = { Author.class, Book.class, UUIDAdapter.class, java.math.BigInteger }, schemaFileName = "library.proto", schemaFilePath = "proto", schemaPackageName = "library")
public interface LibraryInitalizer extends SerializationContextInitializer {

}

@AutoProtoSchemaBuilder(includeClasses = { Author.class, Book.class, UUIDAdapter.class, java.math.BigInteger }, schemaFileName = "library.proto", schemaFilePath = "proto", schemaPackageName = "library")
public interface LibraryInitalizer extends SerializationContextInitializer {

}

ProtoStream API 包含可添加到 Java 应用程序的注解，以定义 Protobuf 模式，它为对象提供结构化格式。

本主题提供有关 ProtoStream 注解的更多详情。如需更多信息，您应该参考 org.infinispan.protostream.annotations 软件包中的文档。

ProtoField

@ProtoField 定义一个 Protobuf 消息字段。

此注解是必需的，适用于字段以及 getter 和 setter 方法。类必须至少使用 @ProtoField 注解一个字段，然后才能将它作为 Protobuf。

ProtoFactory

@ProtoFactory 标记单一构造器或静态工厂方法，用于创建消息类实例。

您可以使用此注解来支持不可变消息类。所有使用 @ProtoField 注解的字段都必须包含在参数中。

AutoProtoSchemaBuilder

@AutoProtoSchemaBuilder 生成类或接口的实施，用于扩展 SerializationContextInitializer。

如果活跃，ProtoStream 处理器会在编译时以 Impl 后缀或您使用 className 参数指定的名称编译时生成实施。

includeClasses 或 basePackages 参数引用 ProtoStream 处理器应该扫描并包含在 Protobuf 模式和 marshaller 中。如果您没有设置其中一个参数，ProtoStream 处理器会扫描整个源路径，这可能会导致意外的结果，我们不建议这样做。您还可以将 excludeClasses 参数与 basePackages 参数一起使用，以排除类。

schemaFileName 和 schemaPackageName 参数在此名称下注册生成的 Protobuf 模式。如果没有设置这些参数，则会将注解的简单类名称与未命名或默认软件包一起使用。模式名称必须以 .proto 文件扩展名结尾。您还可以使用 marshallersOnly 来只生成 marshallers，并阻止 Protobuf 模式生成。

ProtoStream 进程自动生成 META-INF/services 服务元数据文件，您可以使用该文件以便 Data Grid 服务器自动获取 JAR 注册 Protobuf 模式。

dependentOn 参数列出了用于首先执行 SerializedContextInitializer 的注解类。如果类没有实施 SerializedContextInitializer，或者没有使用 AutoProtoSchemaBuilder 注解，则会出现编译时间错误。

ProtoAdapter

@ProtoAdapter 是无法直接注解的类或枚举的 marshalling 适配器。

如果您使用此注解：

ProtoDoc 和 ProtoDocs

@ProtoDoc 和 @ProtoDocs 是人类可读的文本，用于记录生成的模式的消息类型、枚举或字段。

您可以使用这些注解为 Ickle 查询配置索引。

ProtoName

@ProtoName 是一个可选注解，用于指定 Protobuf 消息或枚举类型名称，并替换 @ProtoMessage 注释。

ProtoEnumValue

@ProtoEnumValue 定义 Protobuf enum 值。您只能将此注解应用到 Java enum 的成员。

ProtoReserved 和 ProtoReservedStatements

@ProtoReserved 和 @ProtoReservedStatements 向生成的消息或枚举定义添加 reserved 语句，以防止以后使用数字、范围和名称。

ProtoTypeId

@ProtoTypeId （可选）为 Protobuf 消息或 enum 类型指定全局唯一的数字类型标识符。

ProtoUnknownFieldSet

@ProtoUnknownFieldSet （可选）表示字段或类型为 {@link org.infinispan.protostream.UnknownFieldSet} 的 JavaBean 属性，它存储任何未知字段。