Null Payloads and Log Compaction of 'Tombstone' Records

在使用日志压缩时，您可以发送和接收具有 null 有效负载的消息，以识别密钥的删除。您还可以出于其他原因接收 null 值，例如反序列化程序在无法反序列化值时可能会返回 null。

When using log compaction, you can send and receive messages with null payloads to identify the deletion of a key. You can also receive null values for other reasons, such as a deserializer that might return null when it cannot deserialize a value.

Producing Null Payloads

要使用 PulsarTemplate 发送 null 有效负载，可以使用 fluent API，并将 null 传入 newMessage() 方法的值参数，例如：

To send a null payload by using the PulsarTemplate, you can use the fluent API and pass null into the value argument of the newMessage() method, for example:

pulsarTemplate
        .newMessage(null)
        .withTopic("my-topic")
        .withSchema(Schema.STRING)
        .withMessageCustomizer((mb) -> mb.key("key:1234"))
        .send();

发送空值时，您必须指定模式类型，因为系统无法从 null 有效负载确定消息的类型。

When sending null values you must specify the schema type as the system can not determine the type of the message from a null payload.

Consuming Null Payloads

对于 @PulsarListener 和 @PulsarReader，将基于其消息参数的类型按如下方式将 null 有效负载传递到侦听器方法中：

For @PulsarListener and @PulsarReader, the null payload is passed into the listener method based on the type of its message parameter as follows:

Parameter type Passed-in value

primitive

null

user-defined

null

org.apache.pulsar.client.api.Message<T>

non-null Pulsar message whose getValue() returns null

org.springframework.messaging.Message<T>

non-null Spring message whose getPayload() returns PulsarNull

List<X>

non-null list whose entries (X) are one of the above types and act accordingly (ie. primitive entries are null etc..)

org.apache.pulsar.client.api.Messages<T>

non-null container of non-null Pulsar messages whose getValue() returns null

当传入参数为 null（例如，带有原始类型或用户自定义类型的单记录侦听器）时，您必须使用 @Payload 带有 required = false 的参数注释。

When the passed-in value is null (ie. single record listeners with primitive or user-defined types) you must use the @Payload parameter annotation with required = false.

当为您的侦听器负载类型使用 Spring org.springframework.messaging.Message 时，其泛型类型信息必须足够广泛，以接受 Message<PulsarNull>（例如 Message、Message<?> 或 Message<Object>）。这是由于 Spring 消息不允许其负载为空值，而是使用 PulsarNull 占位符。

When using the Spring org.springframework.messaging.Message for your listener payload type, its generic type information must be wide enough to accept Message<PulsarNull> (eg. Message, Message<?>, or Message<Object>). This is due to the fact that the Spring Message does not allow null values for its payload and instead uses the PulsarNull placeholder.

如果它是压缩日志的墓碑消息，则您通常还需要密钥，以便您的应用程序可以确定哪个键是被 "`删除` 的"。以下示例显示了此类配置：

If it is a tombstone message for a compacted log, you usually also need the key so that your application can determine which key was “deleted”. The following example shows such a configuration:

@PulsarListener(
        topics = "my-topic",
        subscriptionName = "my-topic-sub",
        schemaType = SchemaType.STRING)
void myListener(
        @Payload(required = false) String msg,
        @Header(PulsarHeaders.KEY) String key) {
    ...
}

@PulsarReader 还不支持 @Header 参数，因此在日志压缩方案中不太有用。

The @PulsarReader does not yet support @Header arguments, so it is less useful in the log compaction scenario.