|
| 1 | +/* |
| 2 | + * Copyright 2016-present the original author or authors. |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * https://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | + |
| 17 | +package org.springframework.kafka.listener; |
| 18 | + |
| 19 | +import java.lang.reflect.Type; |
| 20 | +import java.util.Arrays; |
| 21 | +import java.util.List; |
| 22 | + |
| 23 | +import org.apache.kafka.clients.consumer.ConsumerRecord; |
| 24 | +import org.junit.jupiter.api.Test; |
| 25 | + |
| 26 | +import org.springframework.kafka.support.converter.BatchMessagingMessageConverter; |
| 27 | +import org.springframework.kafka.support.converter.MessagingMessageConverter; |
| 28 | +import org.springframework.messaging.Message; |
| 29 | +import org.springframework.messaging.MessageHeaders; |
| 30 | +import org.springframework.messaging.converter.SmartMessageConverter; |
| 31 | +import org.springframework.messaging.support.MessageBuilder; |
| 32 | + |
| 33 | +import static org.assertj.core.api.Assertions.assertThat; |
| 34 | + |
| 35 | +/** |
| 36 | + * Tests for SmartMessageConverter support in batch listeners. |
| 37 | + * Reproduces the issue described in GH-4097. |
| 38 | + * |
| 39 | + * @author Jujuwryy |
| 40 | + * @since 3.3.11 |
| 41 | + */ |
| 42 | +class BatchSmartMessageConverterTests { |
| 43 | + |
| 44 | + @Test |
| 45 | + void testSmartMessageConverterWorksInBatchConversion() { |
| 46 | + // Given: A BatchMessagingMessageConverter with a record converter and SmartMessageConverter |
| 47 | + MessagingMessageConverter recordConverter = new MessagingMessageConverter(); |
| 48 | + BatchMessagingMessageConverter batchConverter = new BatchMessagingMessageConverter(recordConverter); |
| 49 | + |
| 50 | + // Set up SmartMessageConverter that converts byte[] to String |
| 51 | + TestStringMessageConverter smartConverter = new TestStringMessageConverter(); |
| 52 | + batchConverter.setMessagingConverter(smartConverter); |
| 53 | + |
| 54 | + // Create test records with byte[] values that need conversion to String |
| 55 | + List<ConsumerRecord<?, ?>> records = Arrays.asList( |
| 56 | + new ConsumerRecord<>("topic", 0, 0, "key", "hello".getBytes()), |
| 57 | + new ConsumerRecord<>("topic", 0, 1, "key", "world".getBytes()) |
| 58 | + ); |
| 59 | + |
| 60 | + // When: Convert batch with List<String> target type |
| 61 | + Type targetType = new TestParameterizedType(List.class, new Type[]{String.class}); |
| 62 | + Message<?> result = batchConverter.toMessage(records, null, null, targetType); |
| 63 | + |
| 64 | + // Then: Verify the SmartMessageConverter was applied and byte[] was converted to String |
| 65 | + assertThat(result).isNotNull(); |
| 66 | + assertThat(result.getPayload()).isInstanceOf(List.class); |
| 67 | + |
| 68 | + List<?> payloads = (List<?>) result.getPayload(); |
| 69 | + assertThat(payloads).hasSize(2); |
| 70 | + assertThat(payloads.get(0)).isEqualTo("hello"); |
| 71 | + assertThat(payloads.get(1)).isEqualTo("world"); |
| 72 | + } |
| 73 | + |
| 74 | + @Test |
| 75 | + void testBatchConversionWithoutSmartMessageConverter() { |
| 76 | + // Given: A BatchMessagingMessageConverter without SmartMessageConverter |
| 77 | + MessagingMessageConverter recordConverter = new MessagingMessageConverter(); |
| 78 | + BatchMessagingMessageConverter batchConverter = new BatchMessagingMessageConverter(recordConverter); |
| 79 | + |
| 80 | + // Create test records with byte[] values |
| 81 | + List<ConsumerRecord<?, ?>> records = Arrays.asList( |
| 82 | + new ConsumerRecord<>("topic", 0, 0, "key", "test".getBytes()) |
| 83 | + ); |
| 84 | + |
| 85 | + // When: Convert batch |
| 86 | + Type targetType = new TestParameterizedType(List.class, new Type[]{String.class}); |
| 87 | + Message<?> result = batchConverter.toMessage(records, null, null, targetType); |
| 88 | + |
| 89 | + // Then: Should work but payloads remain as byte[] |
| 90 | + assertThat(result).isNotNull(); |
| 91 | + List<?> payloads = (List<?>) result.getPayload(); |
| 92 | + assertThat(payloads.get(0)).isInstanceOf(byte[].class); |
| 93 | + } |
| 94 | + |
| 95 | + /** |
| 96 | + * Test SmartMessageConverter that converts byte[] to String. |
| 97 | + */ |
| 98 | + static class TestStringMessageConverter implements SmartMessageConverter { |
| 99 | + |
| 100 | + @Override |
| 101 | + public Object fromMessage(Message<?> message, Class<?> targetClass) { |
| 102 | + return convertPayload(message.getPayload()); |
| 103 | + } |
| 104 | + |
| 105 | + @Override |
| 106 | + public Object fromMessage(Message<?> message, Class<?> targetClass, Object conversionHint) { |
| 107 | + return convertPayload(message.getPayload()); |
| 108 | + } |
| 109 | + |
| 110 | + @Override |
| 111 | + public Message<?> toMessage(Object payload, MessageHeaders headers) { |
| 112 | + return MessageBuilder.withPayload(payload).copyHeaders(headers).build(); |
| 113 | + } |
| 114 | + |
| 115 | + @Override |
| 116 | + public Message<?> toMessage(Object payload, MessageHeaders headers, Object conversionHint) { |
| 117 | + return toMessage(payload, headers); |
| 118 | + } |
| 119 | + |
| 120 | + private Object convertPayload(Object payload) { |
| 121 | + // Convert byte[] to String - this is the core functionality being tested |
| 122 | + if (payload instanceof byte[] bytes) { |
| 123 | + return new String(bytes); |
| 124 | + } |
| 125 | + return payload; |
| 126 | + } |
| 127 | + } |
| 128 | + |
| 129 | + /** |
| 130 | + * Helper class for creating parameterized types for testing. |
| 131 | + */ |
| 132 | + static class TestParameterizedType implements java.lang.reflect.ParameterizedType { |
| 133 | + |
| 134 | + private final Type rawType; |
| 135 | + |
| 136 | + private final Type[] typeArguments; |
| 137 | + |
| 138 | + TestParameterizedType(Type rawType, Type[] typeArguments) { |
| 139 | + this.rawType = rawType; |
| 140 | + this.typeArguments = typeArguments; |
| 141 | + } |
| 142 | + |
| 143 | + public Type[] getActualTypeArguments() { |
| 144 | + return typeArguments; |
| 145 | + } |
| 146 | + |
| 147 | + public Type getRawType() { |
| 148 | + return rawType; |
| 149 | + } |
| 150 | + |
| 151 | + public Type getOwnerType() { |
| 152 | + return null; |
| 153 | + } |
| 154 | + } |
| 155 | +} |
0 commit comments