第 2 章 使用 ProtoStream 实现自定义对象

Data Grid 使用了一个 ProtoStream 库，它可以针对键和值处理以下类型，并在原语类型中处理未附带的等效类型：

其他类型的集合

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

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

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

@ProtoSchema(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 {
}

@ProtoSchema(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 {
}

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

}

@ProtoSchema(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 软件包中的文档来获取完整的信息。

Proto

@proto 定义协议缓冲消息，无需使用 @Proto Field 注释给所有字段标注。

ProtoField

@ProtoField 定义 Protobuf message 字段。

此注解适用于字段以及 getter 和 setter 方法。除非使用的是 @Proto 注释，否则类必须至少有一个字段标上 @ProtoField，然后 Data Grid 可以将其 marshall 作为 Protobuf。

ProtoFactory

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

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

ProtoSchema

@ProtoSchema 生成扩展 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，或使用 ProtoSchema 注解，则会出现编译时间错误。

ProtoAdapter

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

如果您将此注解用于：

ProtoName

@ProtoName 是一个可选注释，用于指定 Protobuf 消息或 enum 类型名称。它可用于类、记录和枚举。

ProtoEnumValue

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

ProtoReserved 和 ProtoReservedStatements

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

ProtoTypeId

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

ProtoUnknownFieldSet

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

其他注解

Data Grid 将类、字段和方法上的任何其他注解复制为生成的 Protobuf 模式中的注释。这包括索引注释，如 @Indexed 和 @Basic。