-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
GH-2359: Initial AOT Support for Native
Resolves #2359 This is sufficient for the basic Kafka smoke test. * Remove duplicates; register annotations properly; remove avro from factories. * Remove `@MessageMapping`, `@EnableKafka`. * Fix Spring proxies. * Add `KafkaAvroBeanRegistrationAotProcessor` to detect Avro types. * Use `registerTypeIfPresent()` for Kafka Streams. * Polish Avro detection. * Polish use of MergedAnnotations. * Kafka Avro AOT Processor polishing; no need to register for `@KafkaListener` only `GenericMessageListener`. * Fix `BatchMessageListener` (`List<ConsumerRecord<Foo, Bar>>`).
- Loading branch information
1 parent
eb7648a
commit 3d8dcce
Showing
4 changed files
with
371 additions
and
0 deletions.
There are no files selected for viewing
140 changes: 140 additions & 0 deletions
140
...ka/src/main/java/org/springframework/kafka/aot/KafkaAvroBeanRegistrationAotProcessor.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,140 @@ | ||
/* | ||
* Copyright 2022 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 | ||
* | ||
* https://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.kafka.aot; | ||
|
||
import java.lang.reflect.ParameterizedType; | ||
import java.lang.reflect.Type; | ||
import java.util.HashSet; | ||
import java.util.List; | ||
import java.util.Set; | ||
|
||
import org.apache.kafka.clients.consumer.ConsumerRecord; | ||
|
||
import org.springframework.aot.hint.MemberCategory; | ||
import org.springframework.aot.hint.ReflectionHints; | ||
import org.springframework.beans.factory.aot.BeanRegistrationAotContribution; | ||
import org.springframework.beans.factory.aot.BeanRegistrationAotProcessor; | ||
import org.springframework.beans.factory.support.RegisteredBean; | ||
import org.springframework.core.ResolvableType; | ||
import org.springframework.core.annotation.MergedAnnotations; | ||
import org.springframework.kafka.listener.GenericMessageListener; | ||
import org.springframework.lang.Nullable; | ||
import org.springframework.util.ClassUtils; | ||
import org.springframework.util.ReflectionUtils; | ||
|
||
/** | ||
* Detect and register Avro types for Apache Kafka listeners. | ||
* | ||
* @author Gary Russell | ||
* @since 3.0 | ||
* | ||
*/ | ||
public class KafkaAvroBeanRegistrationAotProcessor implements BeanRegistrationAotProcessor { | ||
|
||
private static final String CONSUMER_RECORD_CLASS_NAME = ConsumerRecord.class.getName(); | ||
|
||
private static final String CONSUMER_RECORDS_CLASS_NAME = ConsumerRecord.class.getName(); | ||
|
||
private static final String AVRO_GENERATED_CLASS_NAME = "org.apache.avro.specific.AvroGenerated"; | ||
|
||
private static final boolean AVRO_PRESENT = ClassUtils.isPresent(AVRO_GENERATED_CLASS_NAME, null); | ||
|
||
@Override | ||
@Nullable | ||
public BeanRegistrationAotContribution processAheadOfTime(RegisteredBean registeredBean) { | ||
if (!AVRO_PRESENT) { | ||
return null; | ||
} | ||
Class<?> beanType = registeredBean.getBeanClass(); | ||
if (!isListener(beanType)) { | ||
return null; | ||
} | ||
Set<Class<?>> avroTypes = new HashSet<>(); | ||
if (GenericMessageListener.class.isAssignableFrom(beanType)) { | ||
ReflectionUtils.doWithMethods(beanType, method -> { | ||
Type[] types = method.getGenericParameterTypes(); | ||
if (types.length > 0) { | ||
ResolvableType resolvableType = ResolvableType.forType(types[0]); | ||
if (List.class.equals(resolvableType.getRawClass())) { | ||
resolvableType = resolvableType.getGeneric(0); | ||
} | ||
Class<?> keyType = resolvableType.resolveGeneric(0); | ||
Class<?> valueType = resolvableType.resolveGeneric(1); | ||
checkType(keyType, avroTypes); | ||
checkType(valueType, avroTypes); | ||
} | ||
}, method -> method.getName().equals("onMessage")); | ||
} | ||
if (avroTypes.size() > 0) { | ||
return (generationContext, beanRegistrationCode) -> { | ||
ReflectionHints reflectionHints = generationContext.getRuntimeHints().reflection(); | ||
avroTypes.forEach(type -> reflectionHints.registerType(type, | ||
builder -> builder.withMembers(MemberCategory.INVOKE_DECLARED_CONSTRUCTORS, | ||
MemberCategory.INVOKE_PUBLIC_METHODS))); | ||
}; | ||
} | ||
return null; | ||
} | ||
|
||
private static boolean isListener(Class<?> beanType) { | ||
return GenericMessageListener.class.isAssignableFrom(beanType); | ||
} | ||
|
||
private static void checkType(@Nullable Type paramType, Set<Class<?>> avroTypes) { | ||
if (paramType == null) { | ||
return; | ||
} | ||
boolean container = isContainer(paramType); | ||
if (!container && paramType instanceof Class) { | ||
MergedAnnotations mergedAnnotations = MergedAnnotations.from((Class<?>) paramType); | ||
if (mergedAnnotations.isPresent(AVRO_GENERATED_CLASS_NAME)) { | ||
avroTypes.add((Class<?>) paramType); | ||
} | ||
} | ||
else if (container) { | ||
if (paramType instanceof ParameterizedType) { | ||
Type[] generics = ((ParameterizedType) paramType).getActualTypeArguments(); | ||
if (generics.length > 0) { | ||
checkAvro(generics[0], avroTypes); | ||
} | ||
if (generics.length == 2) { | ||
checkAvro(generics[1], avroTypes); | ||
} | ||
} | ||
} | ||
} | ||
|
||
private static void checkAvro(@Nullable Type generic, Set<Class<?>> avroTypes) { | ||
if (generic instanceof Class) { | ||
MergedAnnotations methodAnnotations = MergedAnnotations.from((Class<?>) generic); | ||
if (methodAnnotations.isPresent(AVRO_GENERATED_CLASS_NAME)) { | ||
avroTypes.add((Class<?>) generic); | ||
} | ||
} | ||
} | ||
|
||
private static boolean isContainer(Type paramType) { | ||
if (paramType instanceof ParameterizedType) { | ||
Type rawType = ((ParameterizedType) paramType).getRawType(); | ||
return (rawType.equals(List.class)) | ||
|| rawType.getTypeName().equals(CONSUMER_RECORD_CLASS_NAME) | ||
|| rawType.getTypeName().equals(CONSUMER_RECORDS_CLASS_NAME); | ||
} | ||
return false; | ||
} | ||
|
||
} |
223 changes: 223 additions & 0 deletions
223
spring-kafka/src/main/java/org/springframework/kafka/aot/KafkaRuntimeHintsRegistrar.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,223 @@ | ||
/* | ||
* Copyright 2022 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 | ||
* | ||
* https://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.kafka.aot; | ||
|
||
import java.util.stream.Stream; | ||
import java.util.zip.CRC32C; | ||
|
||
import org.apache.kafka.clients.admin.NewTopic; | ||
import org.apache.kafka.clients.consumer.Consumer; | ||
import org.apache.kafka.clients.consumer.CooperativeStickyAssignor; | ||
import org.apache.kafka.clients.consumer.RangeAssignor; | ||
import org.apache.kafka.clients.consumer.RoundRobinAssignor; | ||
import org.apache.kafka.clients.consumer.StickyAssignor; | ||
import org.apache.kafka.clients.producer.Producer; | ||
import org.apache.kafka.clients.producer.RoundRobinPartitioner; | ||
import org.apache.kafka.clients.producer.UniformStickyPartitioner; | ||
import org.apache.kafka.clients.producer.internals.DefaultPartitioner; | ||
import org.apache.kafka.common.message.CreateTopicsRequestData.CreatableTopic; | ||
import org.apache.kafka.common.protocol.Message; | ||
import org.apache.kafka.common.serialization.ByteArrayDeserializer; | ||
import org.apache.kafka.common.serialization.ByteArraySerializer; | ||
import org.apache.kafka.common.serialization.ByteBufferDeserializer; | ||
import org.apache.kafka.common.serialization.ByteBufferSerializer; | ||
import org.apache.kafka.common.serialization.BytesDeserializer; | ||
import org.apache.kafka.common.serialization.BytesSerializer; | ||
import org.apache.kafka.common.serialization.DoubleDeserializer; | ||
import org.apache.kafka.common.serialization.DoubleSerializer; | ||
import org.apache.kafka.common.serialization.FloatDeserializer; | ||
import org.apache.kafka.common.serialization.FloatSerializer; | ||
import org.apache.kafka.common.serialization.IntegerDeserializer; | ||
import org.apache.kafka.common.serialization.IntegerSerializer; | ||
import org.apache.kafka.common.serialization.ListDeserializer; | ||
import org.apache.kafka.common.serialization.ListSerializer; | ||
import org.apache.kafka.common.serialization.LongDeserializer; | ||
import org.apache.kafka.common.serialization.LongSerializer; | ||
import org.apache.kafka.common.serialization.Serdes; | ||
import org.apache.kafka.common.serialization.StringDeserializer; | ||
import org.apache.kafka.common.serialization.StringSerializer; | ||
import org.apache.kafka.common.utils.AppInfoParser.AppInfo; | ||
import org.apache.kafka.common.utils.ImplicitLinkedHashCollection; | ||
|
||
import org.springframework.aop.framework.AopProxyUtils; | ||
import org.springframework.aot.hint.MemberCategory; | ||
import org.springframework.aot.hint.ReflectionHints; | ||
import org.springframework.aot.hint.RuntimeHints; | ||
import org.springframework.aot.hint.RuntimeHintsRegistrar; | ||
import org.springframework.aot.hint.support.RuntimeHintsUtils; | ||
import org.springframework.kafka.annotation.KafkaBootstrapConfiguration; | ||
import org.springframework.kafka.annotation.KafkaListener; | ||
import org.springframework.kafka.annotation.KafkaListenerAnnotationBeanPostProcessor; | ||
import org.springframework.kafka.annotation.KafkaListeners; | ||
import org.springframework.kafka.annotation.PartitionOffset; | ||
import org.springframework.kafka.annotation.TopicPartition; | ||
import org.springframework.kafka.config.AbstractKafkaListenerContainerFactory; | ||
import org.springframework.kafka.config.ConcurrentKafkaListenerContainerFactory; | ||
import org.springframework.kafka.config.KafkaListenerContainerFactory; | ||
import org.springframework.kafka.config.KafkaListenerEndpointRegistry; | ||
import org.springframework.kafka.core.ConsumerFactory; | ||
import org.springframework.kafka.core.DefaultKafkaConsumerFactory; | ||
import org.springframework.kafka.core.DefaultKafkaProducerFactory; | ||
import org.springframework.kafka.core.KafkaAdmin; | ||
import org.springframework.kafka.core.KafkaOperations; | ||
import org.springframework.kafka.core.KafkaResourceFactory; | ||
import org.springframework.kafka.core.KafkaTemplate; | ||
import org.springframework.kafka.core.ProducerFactory; | ||
import org.springframework.kafka.listener.ConsumerProperties; | ||
import org.springframework.kafka.listener.ContainerProperties; | ||
import org.springframework.kafka.support.LoggingProducerListener; | ||
import org.springframework.kafka.support.ProducerListener; | ||
import org.springframework.kafka.support.serializer.DelegatingByTopicDeserializer; | ||
import org.springframework.kafka.support.serializer.DelegatingByTypeSerializer; | ||
import org.springframework.kafka.support.serializer.DelegatingDeserializer; | ||
import org.springframework.kafka.support.serializer.DelegatingSerializer; | ||
import org.springframework.kafka.support.serializer.ErrorHandlingDeserializer; | ||
import org.springframework.kafka.support.serializer.JsonDeserializer; | ||
import org.springframework.kafka.support.serializer.JsonSerializer; | ||
import org.springframework.kafka.support.serializer.ParseStringDeserializer; | ||
import org.springframework.kafka.support.serializer.StringOrBytesSerializer; | ||
import org.springframework.kafka.support.serializer.ToStringSerializer; | ||
import org.springframework.lang.Nullable; | ||
|
||
/** | ||
* {@link RuntimeHintsRegistrar} for Spring for Apache Kafka. | ||
* | ||
* @author Gary Russell | ||
* @since 3.0 | ||
* | ||
*/ | ||
public class KafkaRuntimeHintsRegistrar implements RuntimeHintsRegistrar { | ||
|
||
@Override | ||
public void registerHints(RuntimeHints hints, @Nullable ClassLoader classLoader) { | ||
RuntimeHintsUtils.registerAnnotation(hints, KafkaListener.class); | ||
RuntimeHintsUtils.registerAnnotation(hints, KafkaListeners.class); | ||
RuntimeHintsUtils.registerAnnotation(hints, PartitionOffset.class); | ||
RuntimeHintsUtils.registerAnnotation(hints, TopicPartition.class); | ||
ReflectionHints reflectionHints = hints.reflection(); | ||
Stream.of( | ||
ConsumerProperties.class, | ||
ContainerProperties.class, | ||
ProducerListener.class) | ||
.forEach(type -> reflectionHints.registerType(type, | ||
builder -> builder.withMembers(MemberCategory.INVOKE_DECLARED_METHODS))); | ||
|
||
Stream.of( | ||
Message.class, | ||
ImplicitLinkedHashCollection.Element.class, | ||
NewTopic.class, | ||
AbstractKafkaListenerContainerFactory.class, | ||
ConcurrentKafkaListenerContainerFactory.class, | ||
KafkaListenerContainerFactory.class, | ||
KafkaListenerEndpointRegistry.class, | ||
DefaultKafkaConsumerFactory.class, | ||
DefaultKafkaProducerFactory.class, | ||
KafkaAdmin.class, | ||
KafkaOperations.class, | ||
KafkaResourceFactory.class, | ||
KafkaTemplate.class, | ||
ProducerFactory.class, | ||
KafkaOperations.class, | ||
ConsumerFactory.class, | ||
LoggingProducerListener.class, | ||
ImplicitLinkedHashCollection.Element.class, | ||
KafkaListenerAnnotationBeanPostProcessor.class) | ||
.forEach(type -> reflectionHints.registerType(type, | ||
builder -> builder.withMembers(MemberCategory.INVOKE_DECLARED_CONSTRUCTORS, | ||
MemberCategory.INVOKE_DECLARED_METHODS, | ||
MemberCategory.INTROSPECT_PUBLIC_METHODS))); | ||
|
||
Stream.of( | ||
KafkaBootstrapConfiguration.class, | ||
CreatableTopic.class, | ||
KafkaListenerEndpointRegistry.class) | ||
.forEach(type -> reflectionHints.registerType(type, | ||
builder -> builder.withMembers(MemberCategory.INVOKE_DECLARED_CONSTRUCTORS))); | ||
|
||
Stream.of( | ||
AppInfo.class, | ||
// standard assignors | ||
CooperativeStickyAssignor.class, | ||
RangeAssignor.class, | ||
RoundRobinAssignor.class, | ||
StickyAssignor.class, | ||
// standard partitioners | ||
DefaultPartitioner.class, | ||
RoundRobinPartitioner.class, | ||
UniformStickyPartitioner.class, | ||
// standard serialization | ||
ByteArrayDeserializer.class, | ||
ByteArraySerializer.class, | ||
ByteBufferDeserializer.class, | ||
ByteBufferSerializer.class, | ||
BytesDeserializer.class, | ||
BytesSerializer.class, | ||
DoubleSerializer.class, | ||
DoubleDeserializer.class, | ||
FloatSerializer.class, | ||
FloatDeserializer.class, | ||
IntegerSerializer.class, | ||
IntegerDeserializer.class, | ||
ListDeserializer.class, | ||
ListSerializer.class, | ||
LongSerializer.class, | ||
LongDeserializer.class, | ||
StringDeserializer.class, | ||
StringSerializer.class, | ||
// Spring serialization | ||
DelegatingByTopicDeserializer.class, | ||
DelegatingByTypeSerializer.class, | ||
DelegatingDeserializer.class, | ||
ErrorHandlingDeserializer.class, | ||
DelegatingSerializer.class, | ||
JsonDeserializer.class, | ||
JsonSerializer.class, | ||
ParseStringDeserializer.class, | ||
StringOrBytesSerializer.class, | ||
ToStringSerializer.class, | ||
Serdes.class, | ||
Serdes.ByteArraySerde.class, | ||
Serdes.BytesSerde.class, | ||
Serdes.ByteBufferSerde.class, | ||
Serdes.DoubleSerde.class, | ||
Serdes.FloatSerde.class, | ||
Serdes.IntegerSerde.class, | ||
Serdes.LongSerde.class, | ||
Serdes.ShortSerde.class, | ||
Serdes.StringSerde.class, | ||
Serdes.UUIDSerde.class, | ||
Serdes.VoidSerde.class, | ||
CRC32C.class) | ||
.forEach(type -> reflectionHints.registerType(type, builder -> | ||
builder.withMembers(MemberCategory.INVOKE_PUBLIC_CONSTRUCTORS))); | ||
|
||
hints.proxies().registerJdkProxy(AopProxyUtils.completeJdkProxyInterfaces(Consumer.class)); | ||
hints.proxies().registerJdkProxy(AopProxyUtils.completeJdkProxyInterfaces(Producer.class)); | ||
|
||
Stream.of( | ||
"org.apache.kafka.streams.processor.internals.StreamsPartitionAssignor", | ||
"org.apache.kafka.streams.errors.DefaultProductionExceptionHandler", | ||
"org.apache.kafka.streams.processor.FailOnInvalidTimestamp", | ||
"org.apache.kafka.streams.processor.internals.assignment.HighAvailabilityTaskAssignor", | ||
"org.apache.kafka.streams.processor.internals.assignment.StickyTaskAssignor", | ||
"org.apache.kafka.streams.processor.internals.assignment.FallbackPriorTaskAssignor", | ||
"org.apache.kafka.streams.errors.LogAndFailExceptionHandler") | ||
.forEach(type -> reflectionHints.registerTypeIfPresent(classLoader, type, builder -> | ||
builder.withMembers(MemberCategory.INVOKE_PUBLIC_CONSTRUCTORS))); | ||
} | ||
|
||
} |
6 changes: 6 additions & 0 deletions
6
spring-kafka/src/main/java/org/springframework/kafka/aot/package-info.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
/** | ||
* Provides classes to support Spring AOT. | ||
*/ | ||
@org.springframework.lang.NonNullApi | ||
@org.springframework.lang.NonNullFields | ||
package org.springframework.kafka.aot; |
2 changes: 2 additions & 0 deletions
2
spring-kafka/src/main/resources/META-INF/spring/aot.factories
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
org.springframework.aot.hint.RuntimeHintsRegistrar=org.springframework.kafka.aot.KafkaRuntimeHintsRegistrar | ||
org.springframework.beans.factory.aot.BeanRegistrationAotProcessor=org.springframework.kafka.aot.KafkaAvroBeanRegistrationAotProcessor |