Fix composite environment aot and native image generation (#2412)
This commit is contained in:
Olga Maciaszek-Sharma
committed by
GitHub
GitHub
parent
d2168e90bb
commit
aaabcdd4c2
@@ -238,6 +238,11 @@
|
||||
<artifactId>spring-cloud-aws-s3</artifactId>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework</groupId>
|
||||
<artifactId>spring-core-test</artifactId>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
<properties>
|
||||
|
||||
@@ -0,0 +1,206 @@
|
||||
/*
|
||||
* Copyright 2014-2024 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.cloud.config.server.aot;
|
||||
|
||||
import java.lang.reflect.Type;
|
||||
import java.util.Arrays;
|
||||
import java.util.HashSet;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
import java.util.regex.Matcher;
|
||||
import java.util.regex.Pattern;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
import javax.lang.model.element.Modifier;
|
||||
|
||||
import org.springframework.aot.generate.GeneratedMethod;
|
||||
import org.springframework.aot.generate.GenerationContext;
|
||||
import org.springframework.aot.hint.MemberCategory;
|
||||
import org.springframework.aot.hint.ReflectionHints;
|
||||
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.aot.BeanFactoryInitializationCode;
|
||||
import org.springframework.beans.factory.aot.BeanRegistrationExcludeFilter;
|
||||
import org.springframework.beans.factory.config.BeanDefinition;
|
||||
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
|
||||
import org.springframework.beans.factory.support.AbstractBeanDefinition;
|
||||
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
|
||||
import org.springframework.beans.factory.support.DefaultListableBeanFactory;
|
||||
import org.springframework.beans.factory.support.RegisteredBean;
|
||||
import org.springframework.boot.context.properties.bind.Binder;
|
||||
import org.springframework.cloud.config.server.composite.CompositeEnvironmentBeanFactoryPostProcessor;
|
||||
import org.springframework.cloud.config.server.composite.CompositeUtils;
|
||||
import org.springframework.cloud.config.server.environment.EnvironmentRepository;
|
||||
import org.springframework.cloud.config.server.environment.EnvironmentRepositoryFactory;
|
||||
import org.springframework.cloud.config.server.support.EnvironmentRepositoryProperties;
|
||||
import org.springframework.core.env.Environment;
|
||||
import org.springframework.javapoet.MethodSpec;
|
||||
import org.springframework.util.Assert;
|
||||
import org.springframework.util.ClassUtils;
|
||||
|
||||
/**
|
||||
* A {@link BeanFactoryInitializationAotProcessor} implementation that generates code for
|
||||
* registering composite environment repository beans.
|
||||
*
|
||||
* @author Olga Maciaszek-Sharma
|
||||
* @since 4.1.2
|
||||
*/
|
||||
public class CompositeEnvironmentBeanFactoryInitializationAotProcessor
|
||||
implements BeanFactoryInitializationAotProcessor, BeanRegistrationExcludeFilter {
|
||||
|
||||
@SuppressWarnings("NullableProblems")
|
||||
@Override
|
||||
public BeanFactoryInitializationAotContribution processAheadOfTime(ConfigurableListableBeanFactory beanFactory) {
|
||||
Assert.isInstanceOf(ConfigurableListableBeanFactory.class, beanFactory,
|
||||
ConfigurableListableBeanFactory.class.getSimpleName() + " instance expected.");
|
||||
Map<String, BeanDefinition> propertyBeanDefinitions = getCompositeEnvironmentBeanDefinitions(beanFactory,
|
||||
"-env-repo-properties", EnvironmentRepositoryProperties.class);
|
||||
Map<String, BeanDefinition> repoBeanDefinitions = getCompositeEnvironmentBeanDefinitions(beanFactory,
|
||||
"-env-repo", EnvironmentRepository.class);
|
||||
return new CompositeEnvironmentBeanFactoryInitializationAotContribution(propertyBeanDefinitions,
|
||||
repoBeanDefinitions, beanFactory);
|
||||
}
|
||||
|
||||
private static Map<String, BeanDefinition> getCompositeEnvironmentBeanDefinitions(
|
||||
ConfigurableListableBeanFactory beanFactory, String infix, Class<?> beanClass) {
|
||||
return Arrays.stream(beanFactory.getBeanDefinitionNames()).filter(beanName -> beanName.contains(infix))
|
||||
.map(beanName -> Map.entry(beanName, beanFactory.getBeanDefinition(beanName))).filter(entry -> {
|
||||
try {
|
||||
return beanClass.isAssignableFrom(Class.forName(entry.getValue().getBeanClassName()));
|
||||
}
|
||||
catch (ClassNotFoundException e) {
|
||||
throw new RuntimeException(
|
||||
"Class " + entry.getValue().getBeanClassName() + " could not be found", e);
|
||||
}
|
||||
}).collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isExcludedFromAotProcessing(RegisteredBean registeredBean) {
|
||||
return CompositeEnvironmentBeanFactoryPostProcessor.class.isAssignableFrom(registeredBean.getBeanClass())
|
||||
|| EnvironmentRepositoryProperties.class.isAssignableFrom(registeredBean.getBeanClass())
|
||||
&& registeredBean.getBeanName().contains("-env-repo-properties")
|
||||
|| EnvironmentRepository.class.isAssignableFrom(registeredBean.getBeanClass())
|
||||
&& registeredBean.getBeanName().contains("-env-repo");
|
||||
}
|
||||
|
||||
private static final class CompositeEnvironmentBeanFactoryInitializationAotContribution
|
||||
implements BeanFactoryInitializationAotContribution {
|
||||
|
||||
private final Map<String, BeanDefinition> propertyBeanDefinitions;
|
||||
|
||||
private final Map<String, BeanDefinition> repoBeanDefinitions;
|
||||
|
||||
private final ConfigurableListableBeanFactory beanFactory;
|
||||
|
||||
private final Set<Class<?>> hintClasses = new HashSet<>();
|
||||
|
||||
private CompositeEnvironmentBeanFactoryInitializationAotContribution(
|
||||
Map<String, BeanDefinition> propertyBeanDefinitions, Map<String, BeanDefinition> repoBeanDefinitions,
|
||||
ConfigurableListableBeanFactory beanFactory) {
|
||||
this.propertyBeanDefinitions = propertyBeanDefinitions;
|
||||
this.repoBeanDefinitions = repoBeanDefinitions;
|
||||
this.beanFactory = beanFactory;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void applyTo(GenerationContext generationContext,
|
||||
BeanFactoryInitializationCode beanFactoryInitializationCode) {
|
||||
GeneratedMethod environmentRepositoryPropertiesGeneratedMethod = beanFactoryInitializationCode.getMethods()
|
||||
.add("registerCompositeEnvironmentRepositoryPropertiesBeanDefinitions",
|
||||
this::generateRegisterBeanDefinitionsMethod);
|
||||
beanFactoryInitializationCode
|
||||
.addInitializer(environmentRepositoryPropertiesGeneratedMethod.toMethodReference());
|
||||
generateRuntimeHints(generationContext.getRuntimeHints());
|
||||
}
|
||||
|
||||
private void generateRuntimeHints(RuntimeHints runtimeHints) {
|
||||
ReflectionHints hints = runtimeHints.reflection();
|
||||
for (Class<?> clazz : hintClasses) {
|
||||
hints.registerType(TypeReference.of(clazz), MemberCategory.INVOKE_PUBLIC_METHODS,
|
||||
MemberCategory.INTROSPECT_DECLARED_METHODS);
|
||||
introspectPublicMethodsOnAllInterfaces(hints, clazz);
|
||||
}
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
private void generateRegisterBeanDefinitionsMethod(MethodSpec.Builder method) {
|
||||
method.addJavadoc(
|
||||
"Register composite environment repository bean definitions for composite config data sources.");
|
||||
method.addModifiers(Modifier.PUBLIC);
|
||||
method.addParameter(DefaultListableBeanFactory.class, "beanFactory");
|
||||
method.addParameter(Environment.class, "environment");
|
||||
method.addStatement("$T binder = Binder.get(environment)", Binder.class);
|
||||
Pattern findIndexPattern = Pattern.compile("(^.*)(-env-repo-properties)([0-9]+)$");
|
||||
propertyBeanDefinitions.keySet().forEach(beanName -> {
|
||||
Matcher matcher = findIndexPattern.matcher(beanName);
|
||||
if (matcher.find()) {
|
||||
String repoBeanName = beanName.replace("repo-properties", "repo");
|
||||
String factoryName = repoBeanDefinitions.get(repoBeanName).getFactoryBeanName();
|
||||
Class<? extends EnvironmentRepositoryFactory<? extends EnvironmentRepository, ? extends EnvironmentRepositoryProperties>> factoryClass = (Class<? extends EnvironmentRepositoryFactory<? extends EnvironmentRepository, ? extends EnvironmentRepositoryProperties>>) CompositeUtils
|
||||
.getFactoryClass(beanFactory, factoryName);
|
||||
Type[] environmentRepositoryFactoryTypeParams = CompositeUtils
|
||||
.getEnvironmentRepositoryFactoryTypeParams(factoryClass);
|
||||
Class<? extends EnvironmentRepositoryProperties> repoClass = (Class<? extends EnvironmentRepositoryProperties>) environmentRepositoryFactoryTypeParams[0];
|
||||
Class<? extends EnvironmentRepositoryProperties> propertiesClass = (Class<? extends EnvironmentRepositoryProperties>) environmentRepositoryFactoryTypeParams[1];
|
||||
hintClasses.addAll(Set.of(repoClass, propertiesClass, factoryClass));
|
||||
String indexString = matcher.group(3);
|
||||
int index = Integer.parseInt(indexString);
|
||||
String environmentConfigurationPropertyName = String
|
||||
.format("spring.cloud.config.server.composite[%d]", index);
|
||||
method.addStatement("$T properties$L = binder.bindOrCreate($S, $T.class)",
|
||||
EnvironmentRepositoryProperties.class, index, environmentConfigurationPropertyName,
|
||||
propertiesClass);
|
||||
method.addStatement("properties$L.setOrder($L)", index, index + 1);
|
||||
method.addStatement(
|
||||
"$T propertiesDefinition$L = "
|
||||
+ "$T.genericBeanDefinition($T.class, () -> properties$L).getBeanDefinition()",
|
||||
AbstractBeanDefinition.class, index, BeanDefinitionBuilder.class,
|
||||
EnvironmentRepositoryProperties.class, index);
|
||||
method.addStatement("beanFactory.registerBeanDefinition($S, propertiesDefinition$L)", beanName,
|
||||
index);
|
||||
method.addStatement(
|
||||
"""
|
||||
$T repoBeanDefinition$L = $T.genericBeanDefinition($T.class).setFactoryMethodOnBean("build", $S)
|
||||
.addConstructorArgValue(properties$L).getBeanDefinition()""",
|
||||
AbstractBeanDefinition.class, index, BeanDefinitionBuilder.class,
|
||||
EnvironmentRepository.class, factoryName, index);
|
||||
method.addStatement("beanFactory.registerBeanDefinition($S, repoBeanDefinition$L)", repoBeanName,
|
||||
index);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// from Spring Framework BeanRegistrationsAotContribution
|
||||
private void introspectPublicMethodsOnAllInterfaces(ReflectionHints hints, Class<?> type) {
|
||||
Class<?> currentClass = type;
|
||||
while (currentClass != null && currentClass != Object.class) {
|
||||
for (Class<?> interfaceType : currentClass.getInterfaces()) {
|
||||
if (!ClassUtils.isJavaLanguageInterface(interfaceType)) {
|
||||
hints.registerType(interfaceType, MemberCategory.INTROSPECT_PUBLIC_METHODS);
|
||||
introspectPublicMethodsOnAllInterfaces(hints, interfaceType);
|
||||
}
|
||||
}
|
||||
currentClass = currentClass.getSuperclass();
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2018-2019 the original author or authors.
|
||||
* Copyright 2018-2024 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.
|
||||
@@ -31,10 +31,12 @@ import org.springframework.boot.context.properties.bind.Binder;
|
||||
import org.springframework.cloud.config.server.environment.EnvironmentRepositoryFactory;
|
||||
import org.springframework.core.env.Environment;
|
||||
import org.springframework.core.type.MethodMetadata;
|
||||
import org.springframework.util.Assert;
|
||||
import org.springframework.util.StringUtils;
|
||||
|
||||
/**
|
||||
* @author Dylan Roberts
|
||||
* @author Olga Maciaszek-Sharma
|
||||
*/
|
||||
public final class CompositeUtils {
|
||||
|
||||
@@ -68,7 +70,7 @@ public final class CompositeUtils {
|
||||
}
|
||||
|
||||
/**
|
||||
* Given a Factory Name return the generic type parameters of the factory (The actual
|
||||
* Given a Factory Name, return the generic type parameters of the factory (The actual
|
||||
* repository class, and its properties class).
|
||||
* @param beanFactory Spring Bean Factory
|
||||
* @param factoryName name of the factory
|
||||
@@ -76,14 +78,17 @@ public final class CompositeUtils {
|
||||
*/
|
||||
public static Type[] getEnvironmentRepositoryFactoryTypeParams(ConfigurableListableBeanFactory beanFactory,
|
||||
String factoryName) {
|
||||
MethodMetadata methodMetadata = (MethodMetadata) beanFactory.getBeanDefinition(factoryName).getSource();
|
||||
Class<?> factoryClass = null;
|
||||
try {
|
||||
factoryClass = Class.forName(methodMetadata.getReturnTypeName());
|
||||
}
|
||||
catch (ClassNotFoundException e) {
|
||||
throw new IllegalStateException(e);
|
||||
}
|
||||
Class<?> factoryClass = getFactoryClass(beanFactory, factoryName);
|
||||
return getEnvironmentRepositoryFactoryTypeParams(factoryClass);
|
||||
}
|
||||
|
||||
/**
|
||||
* Given a Factory {@link Class}, return the generic type parameters of the factory
|
||||
* (The actual repository class, and its properties class).
|
||||
* @param factoryClass Factory {@link Class}
|
||||
* @return generic type params of the factory
|
||||
*/
|
||||
public static Type[] getEnvironmentRepositoryFactoryTypeParams(Class<?> factoryClass) {
|
||||
Optional<AnnotatedType> annotatedFactoryType = Arrays.stream(factoryClass.getAnnotatedInterfaces())
|
||||
.filter(i -> {
|
||||
ParameterizedType parameterizedType = (ParameterizedType) i.getType();
|
||||
@@ -94,6 +99,25 @@ public final class CompositeUtils {
|
||||
return factoryParameterizedType.getActualTypeArguments();
|
||||
}
|
||||
|
||||
/**
|
||||
* Given a Factory Name, return the Factory {@link Class}.
|
||||
* @param beanFactory Spring Bean Factory
|
||||
* @param factoryName name of the factory
|
||||
* @return factory {@link Class}
|
||||
*/
|
||||
public static Class<?> getFactoryClass(ConfigurableListableBeanFactory beanFactory, String factoryName) {
|
||||
MethodMetadata methodMetadata = (MethodMetadata) beanFactory.getBeanDefinition(factoryName).getSource();
|
||||
Assert.notNull(methodMetadata, "Factory MethodMetadata cannot be null.");
|
||||
Class<?> factoryClass;
|
||||
try {
|
||||
factoryClass = Class.forName(methodMetadata.getReturnTypeName());
|
||||
}
|
||||
catch (ClassNotFoundException e) {
|
||||
throw new IllegalStateException(e);
|
||||
}
|
||||
return factoryClass;
|
||||
}
|
||||
|
||||
static class CompositeConfig {
|
||||
|
||||
List<Map<String, Object>> composite;
|
||||
|
||||
@@ -1,2 +1,8 @@
|
||||
org.springframework.aot.hint.RuntimeHintsRegistrar=\
|
||||
org.springframework.cloud.config.server.config.ConfigServerRuntimeHints
|
||||
|
||||
org.springframework.beans.factory.aot.BeanFactoryInitializationAotProcessor= \
|
||||
org.springframework.cloud.config.server.aot.CompositeEnvironmentBeanFactoryInitializationAotProcessor
|
||||
|
||||
org.springframework.beans.factory.aot.BeanRegistrationExcludeFilter=\
|
||||
org.springframework.cloud.config.server.aot.CompositeEnvironmentBeanFactoryInitializationAotProcessor
|
||||
|
||||
@@ -0,0 +1,97 @@
|
||||
/*
|
||||
* Copyright 2014-2024 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.cloud.config.server.aot;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.nio.charset.Charset;
|
||||
import java.util.Optional;
|
||||
import java.util.Set;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import org.springframework.aot.generate.GeneratedFiles;
|
||||
import org.springframework.aot.hint.ReflectionHints;
|
||||
import org.springframework.aot.test.generate.TestGenerationContext;
|
||||
import org.springframework.boot.test.context.runner.WebApplicationContextRunner;
|
||||
import org.springframework.boot.web.servlet.context.AnnotationConfigServletWebApplicationContext;
|
||||
import org.springframework.cloud.config.server.environment.MultipleJGitEnvironmentProperties;
|
||||
import org.springframework.cloud.config.server.environment.MultipleJGitEnvironmentRepository;
|
||||
import org.springframework.cloud.config.server.environment.MultipleJGitEnvironmentRepositoryFactory;
|
||||
import org.springframework.cloud.config.server.environment.SvnEnvironmentRepositoryFactory;
|
||||
import org.springframework.cloud.config.server.environment.SvnKitEnvironmentProperties;
|
||||
import org.springframework.cloud.config.server.environment.SvnKitEnvironmentRepository;
|
||||
import org.springframework.cloud.config.server.test.TestConfigServerApplication;
|
||||
import org.springframework.context.aot.ApplicationContextAotGenerator;
|
||||
import org.springframework.context.support.GenericApplicationContext;
|
||||
import org.springframework.javapoet.ClassName;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
/**
|
||||
* Tests for {@link CompositeEnvironmentBeanFactoryInitializationAotProcessor}.
|
||||
*
|
||||
* @author Olga Maciaszek-Sharma
|
||||
*/
|
||||
class CompositeEnvironmentBeanFactoryInitializationAotProcessorTests {
|
||||
|
||||
@Test
|
||||
void shouldCreateCompositeEnvironmentBeansRegistrationContribution() {
|
||||
Set<Class<?>> hintClasses = Set.of(MultipleJGitEnvironmentRepository.class, SvnKitEnvironmentRepository.class,
|
||||
SvnKitEnvironmentProperties.class, MultipleJGitEnvironmentRepositoryFactory.class,
|
||||
SvnEnvironmentRepositoryFactory.class, MultipleJGitEnvironmentProperties.class);
|
||||
new WebApplicationContextRunner(AnnotationConfigServletWebApplicationContext::new)
|
||||
.withUserConfiguration(TestConfigServerApplication.class)
|
||||
.withPropertyValues("spring.cloud.refresh.enabled=false",
|
||||
"spring.cloud.config.server.composite[0].uri:file:./target/repos/config-repo",
|
||||
"spring.cloud.config.server.composite[0].type:git",
|
||||
"spring.cloud.config.server.composite[1].uri:file:///./target/repos/svn-config-repo",
|
||||
"spring.cloud.config.server.composite[1].type:svn", "spring.profiles.active:test,composite")
|
||||
.prepare(context -> {
|
||||
TestGenerationContext generationContext = new TestGenerationContext(TestTarget.class);
|
||||
ClassName className = new ApplicationContextAotGenerator().processAheadOfTime(
|
||||
(GenericApplicationContext) context.getSourceApplicationContext(), generationContext);
|
||||
generationContext.writeGeneratedContent();
|
||||
Optional<String> source = getGeneratedSource(generationContext, className.simpleName());
|
||||
assertThat(source).isNotEmpty();
|
||||
assertThat(source.get()).contains(
|
||||
"beanFactory.registerBeanDefinition(\"git-env-repo-properties0\", propertiesDefinition0);",
|
||||
"beanFactory.registerBeanDefinition(\"git-env-repo0\", repoBeanDefinition0);",
|
||||
"beanFactory.registerBeanDefinition(\"svn-env-repo-properties1\", propertiesDefinition1);",
|
||||
"beanFactory.registerBeanDefinition(\"svn-env-repo1\", repoBeanDefinition1);");
|
||||
ReflectionHints hints = generationContext.getRuntimeHints().reflection();
|
||||
hintClasses.forEach(clazz -> assertThat(hints.getTypeHint(clazz)).isNotNull());
|
||||
});
|
||||
}
|
||||
|
||||
private static Optional<String> getGeneratedSource(TestGenerationContext generationContext,
|
||||
String simpleClassName) {
|
||||
return generationContext.getGeneratedFiles().getGeneratedFiles(GeneratedFiles.Kind.SOURCE).values().stream()
|
||||
.map(inputStreamSource -> {
|
||||
try {
|
||||
return new String(inputStreamSource.getInputStream().readAllBytes(), Charset.defaultCharset());
|
||||
}
|
||||
catch (IOException e) {
|
||||
throw new RuntimeException(e);
|
||||
}
|
||||
}).filter(source -> source.contains(simpleClassName)).findAny();
|
||||
}
|
||||
|
||||
static class TestTarget {
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user