-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2457 from joshlong/boot3-aot
add a module for Spring Boot 3 AOT
- Loading branch information
Showing
7 changed files
with
219 additions
and
5 deletions.
There are no files selected for viewing
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
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
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
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,87 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
<modelVersion>4.0.0</modelVersion> | ||
<groupId>io.kubernetes</groupId> | ||
<artifactId>client-java-spring-aot-integration</artifactId> | ||
<packaging>bundle</packaging> | ||
<name>client-java-spring-aot-integration</name> | ||
<url>https://github.com/kubernetes-client/java</url> | ||
<parent> | ||
<artifactId>client-java-parent</artifactId> | ||
<groupId>io.kubernetes</groupId> | ||
<version>16.0.0-SNAPSHOT</version> | ||
<relativePath>../pom.xml</relativePath> | ||
</parent> | ||
<properties> | ||
<spring.boot.version>3.0.0</spring.boot.version> | ||
</properties> | ||
<dependencies> | ||
<dependency> | ||
<groupId>org.reflections</groupId> | ||
<artifactId>reflections</artifactId> | ||
<version>${reflections.version}</version> | ||
</dependency> | ||
<dependency> | ||
<groupId>io.kubernetes</groupId> | ||
<artifactId>client-java-spring-integration</artifactId> | ||
<version>${project.version}</version> | ||
</dependency> | ||
<dependency> | ||
<groupId>org.springframework.boot</groupId> | ||
<artifactId>spring-boot</artifactId> | ||
</dependency> | ||
<dependency> | ||
<groupId>junit</groupId> | ||
<artifactId>junit</artifactId> | ||
<scope>test</scope> | ||
</dependency> | ||
<dependency> | ||
<groupId>org.springframework.boot</groupId> | ||
<artifactId>spring-boot-test</artifactId> | ||
<scope>test</scope> | ||
</dependency> | ||
<dependency> | ||
<groupId>org.springframework</groupId> | ||
<artifactId>spring-test</artifactId> | ||
<scope>test</scope> | ||
</dependency> | ||
</dependencies> | ||
<build> | ||
<plugins> | ||
<plugin> | ||
<groupId>org.jacoco</groupId> | ||
<artifactId>jacoco-maven-plugin</artifactId> | ||
<version>0.8.8</version> | ||
<executions> | ||
<execution> | ||
<id>jacoco-initialize</id> | ||
<goals> | ||
<goal>prepare-agent</goal> | ||
</goals> | ||
</execution> | ||
<execution> | ||
<id>jacoco-report</id> | ||
<phase>test</phase> | ||
<goals> | ||
<goal>report</goal> | ||
</goals> | ||
</execution> | ||
</executions> | ||
</plugin> | ||
<plugin> | ||
<groupId>org.apache.felix</groupId> | ||
<artifactId>maven-bundle-plugin</artifactId> | ||
<extensions>true</extensions> | ||
</plugin> | ||
<plugin> | ||
<groupId>org.apache.maven.plugins</groupId> | ||
<artifactId>maven-compiler-plugin</artifactId> | ||
<configuration> | ||
<source>17</source> | ||
<target>17</target> | ||
</configuration> | ||
</plugin> | ||
</plugins> | ||
</build> | ||
</project> |
105 changes: 105 additions & 0 deletions
105
...java/io/kubernetes/client/spring/aot/KubernetesBeanFactoryInitializationAotProcessor.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,105 @@ | ||
/* | ||
Copyright 2022 The Kubernetes 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 io.kubernetes.client.spring.aot; | ||
|
||
import com.google.gson.annotations.JsonAdapter; | ||
import io.kubernetes.client.extended.controller.Controller; | ||
import io.swagger.annotations.ApiModel; | ||
import java.lang.annotation.Annotation; | ||
import java.util.Collection; | ||
import java.util.HashSet; | ||
import java.util.Set; | ||
import org.jetbrains.annotations.NotNull; | ||
import org.reflections.Reflections; | ||
import org.slf4j.Logger; | ||
import org.slf4j.LoggerFactory; | ||
import org.springframework.aot.hint.MemberCategory; | ||
import org.springframework.aot.hint.RuntimeHints; | ||
import org.springframework.aot.hint.TypeReference; | ||
import org.springframework.beans.factory.aot.BeanFactoryInitializationAotContribution; | ||
import org.springframework.beans.factory.aot.BeanFactoryInitializationAotProcessor; | ||
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory; | ||
import org.springframework.boot.autoconfigure.AutoConfigurationPackages; | ||
|
||
/** | ||
* GraalVM native images need to know about when you might reflectively work with types at runtime. | ||
* The Kubernetes Java client works with several types reflectively at runtime. This code uses the | ||
* third-party Reflections library to reflect upon all the code in your Spring Boot application or | ||
* in the official Kubernetes Java client that has {@link ApiModel}, {@link JsonAdapter}, and | ||
* registers them. It also registers a few other specific handful of classes that should be | ||
* accounted for, in specific cases. | ||
* | ||
* @author Josh Long | ||
*/ | ||
@SuppressWarnings("unused") | ||
public class KubernetesBeanFactoryInitializationAotProcessor | ||
implements BeanFactoryInitializationAotProcessor { | ||
|
||
private static final Logger LOGGER = | ||
LoggerFactory.getLogger(KubernetesBeanFactoryInitializationAotProcessor.class); | ||
|
||
private final MemberCategory[] allMemberCategories = MemberCategory.values(); | ||
|
||
@Override | ||
public BeanFactoryInitializationAotContribution processAheadOfTime( | ||
@NotNull ConfigurableListableBeanFactory beanFactory) { | ||
return (generationContext, beanFactoryInitializationCode) -> { | ||
RuntimeHints hints = generationContext.getRuntimeHints(); | ||
String[] classNames = | ||
new String[] { | ||
"com.google.gson.JsonElement", // | ||
"io.kubernetes.client.informer.cache.ProcessorListener", // | ||
"io.kubernetes.client.extended.controller.Controller", // | ||
"io.kubernetes.client.util.generic.GenericKubernetesApi$StatusPatch", // | ||
"io.kubernetes.client.util.Watch$Response" // | ||
}; | ||
for (String className : classNames) { | ||
LOGGER.info("registering " + className + " for reflection"); | ||
hints.reflection().registerType(TypeReference.of(className), allMemberCategories); | ||
} | ||
registerForPackage("io.kubernetes", hints); | ||
Collection<String> packages = AutoConfigurationPackages.get(beanFactory); | ||
for (String packageName : packages) { | ||
registerForPackage(packageName, hints); | ||
} | ||
}; | ||
} | ||
|
||
private void registerForPackage(String packageName, RuntimeHints hints) { | ||
Reflections reflections = new Reflections(packageName); | ||
Set<Class<?>> apiModels = reflections.getTypesAnnotatedWith(ApiModel.class); | ||
Set<Class<? extends Controller>> controllers = reflections.getSubTypesOf(Controller.class); | ||
Set<Class<?>> jsonAdapters = findJsonAdapters(reflections); | ||
Set<Class<?>> all = new HashSet<>(); | ||
all.addAll(jsonAdapters); | ||
all.addAll(controllers); | ||
all.addAll(apiModels); | ||
for (Class<?> clazz : all) { | ||
LOGGER.info("registering " + clazz.getName() + " for reflection"); | ||
hints.reflection().registerType(clazz, allMemberCategories); | ||
} | ||
} | ||
|
||
private <R extends Annotation> Set<Class<?>> findJsonAdapters(Reflections reflections) { | ||
Class<JsonAdapter> jsonAdapterClass = JsonAdapter.class; | ||
Set<Class<?>> classes = new HashSet<>(); | ||
for (Class<?> clazz : reflections.getTypesAnnotatedWith(jsonAdapterClass)) { | ||
JsonAdapter annotation = clazz.getAnnotation(jsonAdapterClass); | ||
if (null != annotation) { | ||
classes.add(annotation.value()); | ||
} | ||
classes.add(clazz); | ||
} | ||
return classes; | ||
} | ||
} |
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 @@ | ||
org.springframework.beans.factory.aot.BeanFactoryInitializationAotProcessor=io.kubernetes.client.spring.aot.KubernetesBeanFactoryInitializationAotProcessor |
3 changes: 3 additions & 0 deletions
3
...esources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
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,3 @@ | ||
io.kubernetes.client.spring.extended.controller.config.KubernetesInformerAutoConfiguration | ||
io.kubernetes.client.spring.extended.controller.config.KubernetesReconcilerAutoConfiguration | ||
io.kubernetes.client.spring.extended.manifests.config.KubernetesManifestsAutoConfiguration |