@KafkaListener @Payload 验证

从版本 2.2 开始,现在可以更轻松地添加一个 Validator 来验证 @KafkaListener @Payload 参数。以前,您必须配置一个自定义 DefaultMessageHandlerMethodFactory 并将其添加到注册器。现在,您可以将验证器添加到注册器本身。以下代码展示了如何执行此操作

@Configuration
@EnableKafka
public class Config implements KafkaListenerConfigurer {

    ...

    @Override
    public void configureKafkaListeners(KafkaListenerEndpointRegistrar registrar) {
      registrar.setValidator(new MyValidator());
    }

}
当您将 Spring Boot 与验证启动器一起使用时,将自动配置一个 LocalValidatorFactoryBean,如下例所示
@Configuration
@EnableKafka
public class Config implements KafkaListenerConfigurer {

    @Autowired
    private LocalValidatorFactoryBean validator;
    ...

    @Override
    public void configureKafkaListeners(KafkaListenerEndpointRegistrar registrar) {
      registrar.setValidator(this.validator);
    }
}

以下示例展示了如何验证

public static class ValidatedClass {

  @Max(10)
  private int bar;

  public int getBar() {
    return this.bar;
  }

  public void setBar(int bar) {
    this.bar = bar;
  }

}
@KafkaListener(id="validated", topics = "annotated35", errorHandler = "validationErrorHandler",
      containerFactory = "kafkaJsonListenerContainerFactory")
public void validatedListener(@Payload @Valid ValidatedClass val) {
    ...
}

@Bean
public KafkaListenerErrorHandler validationErrorHandler() {
    return (m, e) -> {
        ...
    };
}

从版本 2.5.11 开始,验证现在适用于类级别侦听器中的 @KafkaHandler 方法的有效负载。请参阅 类上的 @KafkaListener

从版本 3.1 开始,您可以在 ErrorHandlingDeserializer 中执行验证。有关详细信息,请参阅 使用 ErrorHandlingDeserializer