Schema注册表客户端

Schema注册表客户端

与模式注册表服务器交互的客户端抽象是SchemaRegistryClient接口，具有以下结构：

public interface SchemaRegistryClient {

	SchemaRegistrationResponse register(String subject, String format, String schema);

	String fetch(SchemaReference schemaReference);

	String fetch(Integer id);

}

Spring Cloud Stream提供了开箱即用的实现，用于与其自己的模式服务器交互，以及与Confluent Schema注册表进行交互。

可以使用@EnableSchemaRegistryClient配置Spring Cloud Stream模式注册表的客户端，如下所示：

  @EnableBinding(Sink.class)
  @SpringBootApplication
  @EnableSchemaRegistryClient
  public static class AvroSinkApplication {
    ...
  }

注意	优化了默认转换器，以缓存来自远程服务器的模式，而且还会非常昂贵的parse()和toString()方法。因此，它使用不缓存响应的DefaultSchemaRegistryClient。如果您打算直接在代码上使用客户端，您可以请求一个也缓存要创建的响应的bean。为此，只需将属性spring.cloud.stream.schemaRegistryClient.cached=true添加到应用程序属性中即可。

Schema注册表客户端属性

Schema注册表客户端支持以下属性：

spring.cloud.stream.schemaRegistryClient.endpoint

模式服务器的位置。在设置时使用完整的URL，包括协议（http或https），端口和上下文路径。

默认

http://localhost:8990/

spring.cloud.stream.schemaRegistryClient.cached

客户端是否应缓存模式服务器响应。通常设置为false，因为缓存发生在消息转换器中。使用模式注册表客户端的客户端应将其设置为true。

默认

true

Avro Schema注册表客户端消息转换器

对于在应用程序上下文中注册了SchemaRegistryClient bean的Spring Boot应用程序，Spring Cloud Stream将自动配置使用模式注册表客户端进行模式管理的Apache Avro消息转换器。这简化了模式演进，因为接收消息的应用程序可以轻松访问可与自己的读取器模式进行协调的写入器模式。

对于出站邮件，如果频道的内容类型设置为application/*+avro，MessageConverter将被激活，例如：

spring.cloud.stream.bindings.output.contentType=application/*+avro

在出站转换期间，消息转换器将尝试基于其类型推断出站消息的模式，并使用SchemaRegistryClient根据有效载荷类型将其注册到主题。如果已经找到相同的模式，那么将会检索对它的引用。如果没有，则将注册模式并提供新的版本号。该消息将使用application/[prefix].[subject].v[version]+avro的方案contentType头发送，其中prefix是可配置的，并且从有效载荷类型推导出subject。

例如，类型为User的消息可以作为内容类型为application/vnd.user.v2+avro的二进制有效载荷发送，其中user是主题，2是版本号。

当接收到消息时，转换器将从传入消息的头部推断出模式引用，并尝试检索它。该模式将在反序列化过程中用作写入器模式。

Avro Schema注册表消息转换器属性

如果您已通过设置spring.cloud.stream.bindings.output.contentType=application/*+avro启用基于Avro的模式注册表客户端，则可以使用以下属性自定义注册的行为。

spring.cloud.stream.schema.avro.dynamicSchemaGenerationEnabled

如果您希望转换器使用反射从POJO推断Schema，则启用。

默认

false

spring.cloud.stream.schema.avro.readerSchema

Avro通过查看编写器模式（源有效载荷）和读取器模式（应用程序有效负载）来比较模式版本，查看Avro文档以获取更多信息。如果设置，这将覆盖模式服务器上的任何查找，并将本地模式用作读取器模式。

默认

null

spring.cloud.stream.schema.avro.schemaLocations

使用Schema服务器注册此属性中列出的任何.avsc文件。

默认

empty

spring.cloud.stream.schema.avro.prefix

要在Content-Type头上使用的前缀。

默认

vnd

Schema注册和解决

为了更好地了解Spring Cloud Stream注册和解决新模式以及其使用Avro模式比较功能，我们将提供两个单独的子部分：一个用于注册，一个用于解析模式。

Schema注册流程（序列化）

注册过程的第一部分是从通过信道发送的有效载荷中提取模式。Avro类型，如SpecificRecord或GenericRecord已经包含一个模式，可以从实例中立即检索。在POJO的情况下，如果属性spring.cloud.stream.schema.avro.dynamicSchemaGenerationEnabled设置为true（默认），则会推断出一个模式。

图10. Schema Writer Resolution Process

一旦获得了架构，转换器就会从远程服务器加载其元数据（版本）。首先，它查询本地缓存，如果没有找到它，则将数据提交到将使用版本控制信息回复的服务器。转换器将始终缓存结果，以避免为每个需要序列化的新消息查询Schema服务器的开销。

图11. Schema注册流程

使用模式版本信息，转换器设置消息的contentType头，以携带版本信息，如application/vnd.user.v1+avro

Schema解析过程（反序列化）

当读取包含版本信息的消息（即，具有上述方案的contentType标头）时，转换器将查询Schema服务器以获取消息的写入器架构。一旦找到传入消息的正确架构，它就会检索读取器架构，并使用Avro的架构解析支持将其读入读取器定义（设置默认值和缺少的属性）。

图12. Schema阅读决议程序

注意	了解编写器架构（写入消息的应用程序）和读取器架构（接收应用程序）之间的区别很重要。请花点时间阅读Avro术语并了解此过程。Spring Cloud Stream将始终提取writer模式以确定如何读取消息。如果您想要Avro的架构演进支持工作，您需要确保为您的应用程序正确设置了readerSchema。