From 502d275b414c7291c75ac52e772eb38023254c0b Mon Sep 17 00:00:00 2001 From: Ilayaperumal Gopinathan Date: Tue, 15 Mar 2016 18:43:41 +0530 Subject: [PATCH] Move message header mode as a generic property - Both the producer and consumer properties have `HeaderMode` - Handle the case of embeddedHeaders and raw for both the Sending/ReceivingHandlers in Redis binder This resolves #408 Move message values extraction to superclass --- .../binder/kafka/KafkaConsumerProperties.java | 10 ----- .../kafka/KafkaMessageChannelBinder.java | 43 ++++++------------- .../binder/kafka/KafkaProducerProperties.java | 11 ----- .../KafkaBinderConfigurationProperties.java | 12 ------ .../cloud/stream/binder/AbstractBinder.java | 23 ++++++++++ .../stream/binder/ConsumerProperties.java | 9 ++++ .../cloud/stream/binder/HeaderMode.java | 24 +++++++++++ .../stream/binder/ProducerProperties.java | 10 +++++ 8 files changed, 79 insertions(+), 63 deletions(-) create mode 100644 spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/HeaderMode.java diff --git a/spring-cloud-stream-binders/spring-cloud-stream-binder-kafka/src/main/java/org/springframework/cloud/stream/binder/kafka/KafkaConsumerProperties.java b/spring-cloud-stream-binders/spring-cloud-stream-binder-kafka/src/main/java/org/springframework/cloud/stream/binder/kafka/KafkaConsumerProperties.java index ed398226e..9c9a22134 100644 --- a/spring-cloud-stream-binders/spring-cloud-stream-binder-kafka/src/main/java/org/springframework/cloud/stream/binder/kafka/KafkaConsumerProperties.java +++ b/spring-cloud-stream-binders/spring-cloud-stream-binder-kafka/src/main/java/org/springframework/cloud/stream/binder/kafka/KafkaConsumerProperties.java @@ -33,8 +33,6 @@ public class KafkaConsumerProperties { private KafkaMessageChannelBinder.StartOffset startOffset = null; - private KafkaMessageChannelBinder.Mode mode = KafkaMessageChannelBinder.Mode.embeddedHeaders; - public void setMinPartitionCount(int minPartitionCount) { this.minPartitionCount = minPartitionCount; } @@ -52,14 +50,6 @@ public class KafkaConsumerProperties { this.autoCommitOffset = autoCommitOffset; } - public KafkaMessageChannelBinder.Mode getMode() { - return mode; - } - - public void setMode(KafkaMessageChannelBinder.Mode mode) { - this.mode = mode; - } - public boolean isResetOffsets() { return resetOffsets; } diff --git a/spring-cloud-stream-binders/spring-cloud-stream-binder-kafka/src/main/java/org/springframework/cloud/stream/binder/kafka/KafkaMessageChannelBinder.java b/spring-cloud-stream-binders/spring-cloud-stream-binder-kafka/src/main/java/org/springframework/cloud/stream/binder/kafka/KafkaMessageChannelBinder.java index 6c371e5b4..8a7f0a7a3 100644 --- a/spring-cloud-stream-binders/spring-cloud-stream-binder-kafka/src/main/java/org/springframework/cloud/stream/binder/kafka/KafkaMessageChannelBinder.java +++ b/spring-cloud-stream-binders/spring-cloud-stream-binder-kafka/src/main/java/org/springframework/cloud/stream/binder/kafka/KafkaMessageChannelBinder.java @@ -29,16 +29,9 @@ import java.util.Properties; import java.util.UUID; import java.util.concurrent.atomic.AtomicInteger; -import kafka.admin.AdminUtils; -import kafka.api.OffsetRequest; -import kafka.serializer.Decoder; -import kafka.serializer.DefaultDecoder; -import kafka.utils.ZKStringSerializer$; -import kafka.utils.ZkUtils; import org.I0Itec.zkclient.ZkClient; import org.apache.kafka.clients.producer.ProducerConfig; import org.apache.kafka.common.serialization.ByteArraySerializer; -import scala.collection.Seq; import org.springframework.beans.factory.DisposableBean; import org.springframework.beans.factory.config.ConfigurableListableBeanFactory; @@ -48,10 +41,10 @@ import org.springframework.cloud.stream.binder.BinderException; import org.springframework.cloud.stream.binder.BinderHeaders; import org.springframework.cloud.stream.binder.Binding; import org.springframework.cloud.stream.binder.DefaultBinding; -import org.springframework.cloud.stream.binder.EmbeddedHeadersMessageConverter; import org.springframework.cloud.stream.binder.ExtendedConsumerProperties; import org.springframework.cloud.stream.binder.ExtendedProducerProperties; import org.springframework.cloud.stream.binder.ExtendedPropertiesBinder; +import org.springframework.cloud.stream.binder.HeaderMode; import org.springframework.cloud.stream.binder.MessageValues; import org.springframework.cloud.stream.binder.PartitionHandler; import org.springframework.http.MediaType; @@ -90,6 +83,14 @@ import org.springframework.util.Assert; import org.springframework.util.CollectionUtils; import org.springframework.util.StringUtils; +import kafka.admin.AdminUtils; +import kafka.api.OffsetRequest; +import kafka.serializer.Decoder; +import kafka.serializer.DefaultDecoder; +import kafka.utils.ZKStringSerializer$; +import kafka.utils.ZkUtils; +import scala.collection.Seq; + /** * A {@link Binder} that uses Kafka as the underlying middleware. * @@ -109,9 +110,6 @@ public class KafkaMessageChannelBinder extends AbstractBinder> topicsInUse = new HashMap<>(); - private final EmbeddedHeadersMessageConverter embeddedHeadersMessageConverter = new - EmbeddedHeadersMessageConverter(); - private final ZookeeperConnect zookeeperConnect; private final String brokers; @@ -577,17 +575,8 @@ public class KafkaMessageChannelBinder extends AbstractBinder requestMessage) { - if (Mode.embeddedHeaders.equals(consumerProperties.getExtension().getMode())) { - MessageValues messageValues; - try { - messageValues = embeddedHeadersMessageConverter.extractHeaders((Message) requestMessage, - true); - } - catch (Exception e) { - logger.error(EmbeddedHeadersMessageConverter.decodeExceptionMessage(requestMessage), e); - messageValues = new MessageValues(requestMessage); - } - messageValues = deserializePayloadIfNecessary(messageValues); + if (HeaderMode.embeddedHeaders.equals(consumerProperties.getHeaderMode())) { + MessageValues messageValues = extractMessageValues(requestMessage); return MessageBuilder.createMessage(messageValues.getPayload(), new KafkaBinderHeaders( messageValues)); } @@ -648,14 +637,13 @@ public class KafkaMessageChannelBinder extends AbstractBinder receivedMessage) { + MessageValues messageValues; + try { + messageValues = embeddedHeadersMessageConverter.extractHeaders((Message) receivedMessage, + true); + } + catch (Exception e) { + logger.error(EmbeddedHeadersMessageConverter.decodeExceptionMessage(receivedMessage), e); + messageValues = new MessageValues(receivedMessage); + } + return deserializePayloadIfNecessary(messageValues); + } + /** * Subclasses may implement this method to perform any necessary initialization. * It will be invoked from {@link #afterPropertiesSet()} which is itself {@code final}. diff --git a/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/ConsumerProperties.java b/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/ConsumerProperties.java index 8867191da..503efb0c3 100644 --- a/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/ConsumerProperties.java +++ b/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/ConsumerProperties.java @@ -47,6 +47,8 @@ public class ConsumerProperties { private double backOffMultiplier = 2.0; + private HeaderMode headerMode = HeaderMode.embeddedHeaders; + @Min(value = 1, message = "Concurrency should be greater than zero.") public int getConcurrency() { return concurrency; @@ -118,5 +120,12 @@ public class ConsumerProperties { return backOffMultiplier; } + public HeaderMode getHeaderMode() { + return this.headerMode; + } + + public void setHeaderMode(HeaderMode headerMode) { + this.headerMode = headerMode; + } } diff --git a/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/HeaderMode.java b/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/HeaderMode.java new file mode 100644 index 000000000..6b3650b72 --- /dev/null +++ b/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/HeaderMode.java @@ -0,0 +1,24 @@ +/* + * Copyright 2016 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.springframework.cloud.stream.binder; + +/** + * @author Marius Bogoevici + */ +public enum HeaderMode { + raw, + embeddedHeaders +} diff --git a/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/ProducerProperties.java b/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/ProducerProperties.java index 65565bd56..984cbba29 100644 --- a/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/ProducerProperties.java +++ b/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/ProducerProperties.java @@ -48,6 +48,8 @@ public class ProducerProperties { private String[] requiredGroups = new String[] {}; + private HeaderMode headerMode = HeaderMode.embeddedHeaders; + public Expression getPartitionKeyExpression() { return partitionKeyExpression; } @@ -111,4 +113,12 @@ public class ProducerProperties { return (this.partitionSelectorClass == null) || (this.partitionSelectorExpression == null); } + public HeaderMode getHeaderMode() { + return this.headerMode; + } + + public void setHeaderMode(HeaderMode headerMode) { + this.headerMode = headerMode; + } + }