8.2. Apicurio Registry serializer/deserializer 配置属性

SCHEMA_RESOLVER

apicurio.registry.schema-resolver

由序列化器和反序列化器使用。实现 SchemaResolver 的完全限定 Java 类名称。

字符串

io.apicurio.registry.resolver.DefaultSchemaResolver

REGISTRY_URL

apicurio.registry.url

由序列化器和反序列化器使用。用于访问 registry API 的 URL。

字符串

None

AUTH_TOKEN_ENDPOINT

apicurio.registry.auth.service.token.endpoint

由序列化器和反序列化器使用。令牌端点的 URL。

字符串

None

AUTH_CLIENT_ID

apicurio.registry.auth.client.id

由序列化器和反序列化器使用。用于访问身份验证服务的客户端 ID。在使用 OAuth 客户端凭证流访问安全 registry 时需要此项。

字符串

None

AUTH_CLIENT_SECRET

apicurio.registry.auth.client.secret

由序列化器和反序列化器使用。用于访问身份验证服务的客户端机密。在使用 OAuth 客户端凭证流访问安全 registry 时需要此项。

字符串

None

AUTH_USERNAME

apicurio.registry.auth.username

由序列化器和反序列化器使用。用于访问 registry 的用户名。使用 HTTP 基本身份验证访问安全 registry 时需要此项。

字符串

None

AUTH_PASSWORD

apicurio.registy.auth.password

由序列化器和反序列化器使用。访问 registry 的密码。使用 HTTP 基本身份验证访问安全 registry 时需要此项。

字符串

None

ARTIFACT_RESOLVER_STRATEGY

apicurio.registry.artifact-resolver-strategy

仅由 serializers 使用。实现 ArtifactReferenceResolverStrategy 的完全限定 Java classname，并将每个 Kafka 消息映射到 ArtifactReference (groupId、artifactId 和 version)。例如，默认策略使用主题名称作为 schema artifactId。

字符串

io.apicurio.registry.serde.strategy.TopicIdStrategy

EXPLICIT_ARTIFACT_GROUP_ID

apicurio.registry.artifact.group-id

仅由 serializers 使用。设置用于查询或创建工件的 groupId。覆盖 ArtifactResolverStrategy 返回的 groupId。

字符串

None

EXPLICIT_ARTIFACT_ID

apicurio.registry.artifact.artifact-id

仅由 serializers 使用。设置用于查询或创建工件的 artifactId。覆盖 ArtifactResolverStrategy 返回的 artifactId。

字符串

None

EXPLICIT_ARTIFACT_VERSION

apicurio.registry.artifact.version

仅由 serializers 使用。设置用于查询或创建工件的工件版本。覆盖 ArtifactResolverStrategy 返回的版本。

字符串

None

FIND_LATEST_ARTIFACT

apicurio.registry.find-latest

仅由 serializers 使用。指定序列化器是否尝试为对应的组 ID 和工件 ID 在 registry 中查找最新的工件。

布尔值

false

AUTO_REGISTER_ARTIFACT

apicurio.registry.auto-register

仅由 serializers 使用。指定序列化器是否在 registry 中创建工件。JSON 架构序列化器不支持此功能。

布尔值，布尔值字符串

false

DEREFERENCE_SCHEMA

apicurio.registry.dereference-schema

用于指示用来解引用模式的语义。这在两个不同的情况下使用，在注册模式后，指示该范围向服务器询问架构被取消引用。它还用来指示序列化器在注册 registry 前解引用模式，但这只支持 Avro。

布尔值

false

AUTO_REGISTER_ARTIFACT_IF_EXISTS

apicurio.registry.auto-register.if-exists

仅由 serializers 使用。在创建工件时配置客户端的行为，因为工件已存在。可用值包括 FAIL、UPDATE、RETURN 或 RETURN_OR_UPDATE。

字符串

RETURN_OR_UPDATE

CHECK_PERIOD_MS

apicurio.registry.check-period-ms

由序列化器和反序列化器使用。指定在自动运行前缓存工件的时间（毫秒）。如果设置为零，则每次都会获取工件。

java.time.Duration, non-negative Number, 或 integer String

30000

RETRY_BACKOFF_MS

apicurio.registry.retry-backoff-ms

由序列化器和反序列化器使用。如果无法从 Registry 检索架构，它可能会重试次数。此配置选项控制重试尝试之间的延迟（毫秒）。

java.time.Duration, non-negative Number, 或 integer String

300

RETRY_COUNT

apicurio.registry.retry-count

由序列化器和反序列化器使用。如果无法从 Registry 检索架构，它可能会重试次数。此配置选项控制重试尝试的数量。

非负号或整数字符串

3

USE_ID

apicurio.registry.use-id

由序列化器和反序列化器使用。配置以使用指定的 IdOption 作为工件的标识符。选项为 globalId 和 contentId。指示序列化器将指定的 ID 写入 Kafka，并指示反序列化器使用这个 ID 来查找 schema。

字符串

contentId

ENABLE_HEADERS

apicurio.registry.headers.enabled

由序列化器和反序列化器使用。配置为将工件标识符读/写到 Kafka 消息标头，而不是在消息有效负载中。

布尔值

false

HEADERS_HANDLER

apicurio.registry.headers.handler

由序列化器和反序列化器使用。实现 HeadersHandler 以及到/从 Kafka 消息标头写入/读取工件标识的完全限定的 Java 类名称，。

字符串

io.apicurio.registry.serde.headers.DefaultHeadersHandler

ID_HANDLER

apicurio.registry.id-handler

由序列化器和反序列化器使用。实施 IdHandler 的类的完全限定 Java 类名称，将工件标识符写入/读取工件标识符到消息有效负载。默认为 4 字节格式，其在消息有效负载中包含 contentId。

字符串

io.apicurio.registry.serde.Default4ByteIdHandler

FALLBACK_ARTIFACT_PROVIDER

apicurio.registry.fallback.provider

仅限反序列化器使用。设置 FallbackArtifactProvider 的自定义实现，用于解析用于反序列化的工件。FallbackArtifactProvider 将回退工件配置为从 registry 获取，以防查找失败。

字符串

io.apicurio.registry.serde.fallback.DefaultFallbackArtifactProvider

FALLBACK_ARTIFACT_ID

apicurio.registry.fallback.artifact-id

仅限反序列化器使用。设置用于解析用于序列化的工件的 artifactId 作为 fallback。

字符串

None

FALLBACK_ARTIFACT_GROUP_ID

apicurio.registry.fallback.group-id

仅限反序列化器使用。设置用于解析用于序列化的组的 groupId。

字符串

None

FALLBACK_ARTIFACT_VERSION

apicurio.registry.fallback.version

仅限反序列化器使用。将用于解析用于序列化的工件的版本设置为回退。

字符串

None