8.3. 如何配置不同的客户端 serializer/deserializer 类型

配置 Avro serializer

您可以使用以下方法配置 Avro serializer 类：

ID 位置

序列化器将模式的唯一 ID 作为 Kafka 消息的一部分传递，以便消费者使用正确的模式进行反序列化。ID 可以位于消息有效负载中，也可以在邮件标头中使用。默认位置是消息有效负载。要在消息标头中发送 ID，请设置以下配置属性：

ID 编码

您可以在 Kafka 消息正文中传递时自定义如何编码 schema ID。将 apicurio.registry.id-handler 配置属性设置为实现 io.apicurio.registry.serde.IdHandler 接口的类。Apicurio Registry 提供以下实现：

Avro datum 供应商

Avro 提供不同的 datum 写入器和读取器来写入和读取数据。Apicurio Registry 支持三种不同的类型：

Avro 编码

使用 Avro 对数据进行序列化时，您可以使用 Avro 二进制编码格式确保以尽可能高效的方式编码数据。Avro 还支持将数据编码为 JSON，这有助于检查每条消息的载荷，例如用于日志记录或调试。

配置 Avro deserializer

您必须配置 Avro deserializer 类，以匹配 serializer 的以下配置设置：

Avro SerDes 和 artifact 引用

在使用 Avro 消息和带有嵌套记录的模式时，会为每个嵌套记录注册一个新的工件。例如，以下 TradeKey 模式包括嵌套的 Exchange 模式：

带有嵌套交换模式的 TradeKey 模式

{
  "namespace": "com.kubetrade.schema.trade",
  "type": "record",
  "name": "TradeKey",
  "fields": [
    {
      "name": "exchange",
      "type": "com.kubetrade.schema.common.Exchange"
    },
    {
      "name": "key",
      "type": "string"
    }
  ]
}

Exchange schema

{
  "namespace": "com.kubetrade.schema.common",
  "type": "enum",
  "name": "Exchange",
  "symbols" : ["GEMINI"]
}

配置 JSON Schema serializer

您可以配置 JSON Schema serializer 类，如下所示：

配置 JSON Schema deserializer

您可以配置 JSON Schema deserializer 类，如下所示：

JSON Schema SerDes 和 artifact 引用

JSON Schema SerDes 无法从消息有效负载发现 schema，因此必须预先注册架构工件，这也会应用工件引用。

公民.json 模式，并参考 city.json 模式

{
 "$id": "https://example.com/citizen.schema.json",
 "$schema": "http://json-schema.org/draft-07/schema#",
 "title": "Citizen",
 "type": "object",
 "properties": {
   "firstName": {
     "type": "string",
     "description": "The citizen's first name."
   },
   "lastName": {
     "type": "string",
     "description": "The citizen's last name."
   },
   "age": {
     "description": "Age in years which must be equal to or greater than zero.",
     "type": "integer",
     "minimum": 0
   },
   "city": {
     "$ref": "city.json"
   }
 }
}

City.json 模式

{
 "$id": "https://example.com/city.schema.json",
 "$schema": "http://json-schema.org/draft-07/schema#",
 "title": "City",
 "type": "object",
 "properties": {
   "name": {
     "type": "string",
     "description": "The city's name."
   },
   "zipCode": {
     "type": "integer",
     "description": "The zip code.",
     "minimum": 0
   }
 }
}

配置 Protobuf serializer

您可以按照如下所示配置 Protobuf serializer 类：

配置 Protobuf deserializer

您必须配置 Protobuf deserializer 类，以匹配 serializer 中的以下配置设置：

protobuf SerDes 和 artifact 引用

当使用 导入 语句的复杂 Protobuf 消息时，导入的 Protobuf 消息会作为单独的工件存储在 Apicurio Registry 中。然后，当 Apicurio Registry 获取主要 schema 来检查 Protobuf 消息时，还会检索引用的方案，以便可以检查和序列化的完整消息模式。

带有导入的 .mode.proto 文件的 table_info.proto 文件

syntax = "proto3";
package sample;
option java_package = "io.api.sample";
option java_multiple_files = true;

import "sample/mode.proto";

message TableInfo {

 int32 winIndex = 1;
 Mode mode = 2;
 int32 min = 3;
 int32 max = 4;
 string id = 5;
 string dataAdapter = 6;
 string schema = 7;
 string selector = 8;
 string subscription_id = 9;
}

mode.proto file

syntax = "proto3";
package sample;
option java_package = "io.api.sample";
option java_multiple_files = true;

enum Mode {

MODE_UNKNOWN = 0;
RAW = 1;
MERGE = 2;
DISTINCT = 3;
COMMAND = 4;
}