Skip to content

Logback configuration that relies on inner-classes does not work in a native image #44021

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Logback configuration that relies on inner-classes does not work in a native image #44021

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions ...t/src/main/java/org/springframework/boot/logging/logback/SpringBootJoranConfigurator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2012-2024 the original author or authors.
* Copyright 2012-2025 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.
Expand Down Expand Up @@ -231,12 +231,12 @@ private Set<Class<? extends Serializable>> serializationTypes(Model model) {
return modelClasses;
}

private Set<String> reflectionTypes(Model model) {
private Set<Class<?>> reflectionTypes(Model model) {
return reflectionTypes(model, () -> null);
}

private Set<String> reflectionTypes(Model model, Supplier<Object> parent) {
Set<String> reflectionTypes = new HashSet<>();
private Set<Class<?>> reflectionTypes(Model model, Supplier<Object> parent) {
Set<Class<?>> reflectionTypes = new HashSet<>();
Class<?> componentType = determineType(model, parent);
if (componentType != null) {
processComponent(componentType, reflectionTypes);
Expand Down Expand Up @@ -306,23 +306,22 @@ private Object instantiate(Class<?> type) {
}
}

private void processComponent(Class<?> componentType, Set<String> reflectionTypes) {
private void processComponent(Class<?> componentType, Set<Class<?>> reflectionTypes) {
BeanDescription beanDescription = this.modelInterpretationContext.getBeanDescriptionCache()
.getBeanDescription(componentType);
reflectionTypes.addAll(parameterTypesNames(beanDescription.getPropertyNameToAdder().values()));
reflectionTypes.addAll(parameterTypesNames(beanDescription.getPropertyNameToSetter().values()));
reflectionTypes.add(componentType.getCanonicalName());
reflectionTypes.add(componentType);
}

private Collection<String> parameterTypesNames(Collection<Method> methods) {
private Collection<Class<?>> parameterTypesNames(Collection<Method> methods) {
return methods.stream()
.filter((method) -> !method.getDeclaringClass().equals(ContextAware.class)
&& !method.getDeclaringClass().equals(ContextAwareBase.class))
.map(Method::getParameterTypes)
.flatMap(Stream::of)
.filter((type) -> !type.isPrimitive() && !type.equals(String.class))
.map((type) -> type.isArray() ? type.getComponentType() : type)
.map(Class::getName)
.toList();
}

Expand Down
83 changes: 62 additions & 21 deletions ...va/org/springframework/boot/logging/logback/LogbackConfigurationAotContributionTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2012-2024 the original author or authors.
* Copyright 2012-2025 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.
Expand Down Expand Up @@ -54,6 +54,7 @@
import org.springframework.aot.hint.MemberCategory;
import org.springframework.aot.hint.RuntimeHints;
import org.springframework.aot.hint.SerializationHints;
import org.springframework.aot.hint.TypeHint;
import org.springframework.aot.hint.TypeReference;
import org.springframework.aot.hint.predicate.RuntimeHintsPredicates;
import org.springframework.aot.test.generate.TestGenerationContext;
Expand Down Expand Up @@ -149,15 +150,18 @@ void componentModelClassAndSetterParametersAreRegisteredForReflection() {
Model model = new Model();
model.getSubModels().add(component);
TestGenerationContext generationContext = applyContribution(model);
RuntimeHints runtimeHints = generationContext.getRuntimeHints();
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(SizeAndTimeBasedRollingPolicy.class))
.accepts(generationContext.getRuntimeHints());
.accepts(runtimeHints);
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(FileAppender.class))
.accepts(generationContext.getRuntimeHints());
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(FileSize.class))
.accepts(generationContext.getRuntimeHints());
.accepts(runtimeHints);
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(FileSize.class)).accepts(runtimeHints);
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(
TimeBasedFileNamingAndTriggeringPolicy.class))
.accepts(generationContext.getRuntimeHints());
.accepts(runtimeHints);
assertThat(runtimeHints).satisfies(hasValidTypeName(SizeAndTimeBasedRollingPolicy.class));
assertThat(runtimeHints).satisfies(hasValidTypeName(FileSize.class));
assertThat(runtimeHints).satisfies(hasValidTypeName(FileAppender.class));
}

@Test
Expand All @@ -167,12 +171,14 @@ void implicitModelClassAndSetterParametersAreRegisteredForReflection() {
Model model = new Model();
model.getSubModels().add(implicit);
TestGenerationContext generationContext = applyContribution(model);
RuntimeHints runtimeHints = generationContext.getRuntimeHints();
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(PatternLayoutEncoder.class))
.accepts(generationContext.getRuntimeHints());
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(Layout.class))
.accepts(generationContext.getRuntimeHints());
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(Charset.class))
.accepts(generationContext.getRuntimeHints());
.accepts(runtimeHints);
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(Layout.class)).accepts(runtimeHints);
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(Charset.class)).accepts(runtimeHints);
assertThat(runtimeHints).satisfies(hasValidTypeName(PatternLayoutEncoder.class));
assertThat(runtimeHints).satisfies(hasValidTypeName(Layout.class));
assertThat(runtimeHints).satisfies(hasValidTypeName(Charset.class));
}

@Test
Expand All @@ -186,6 +192,8 @@ void componentModelReferencingImportedClassNameIsRegisteredForReflection() {
TestGenerationContext generationContext = applyContribution(model);
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(SizeAndTimeBasedRollingPolicy.class))
.accepts(generationContext.getRuntimeHints());
assertThat(generationContext.getRuntimeHints())
.satisfies(hasValidTypeName(SizeAndTimeBasedRollingPolicy.class));
}

@Test
Expand All @@ -196,10 +204,12 @@ void typeFromParentsSetterIsRegisteredForReflection() {
component.setClassName(Outer.class.getName());
component.getSubModels().add(implementation);
TestGenerationContext generationContext = applyContribution(component);
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(Outer.class))
.accepts(generationContext.getRuntimeHints());
RuntimeHints runtimeHints = generationContext.getRuntimeHints();
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(Outer.class)).accepts(runtimeHints);
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(Implementation.class))
.accepts(generationContext.getRuntimeHints());
.accepts(runtimeHints);
assertThat(runtimeHints).satisfies(hasValidTypeName(Outer.class));
assertThat(runtimeHints).satisfies(hasValidTypeName(Implementation.class));
}

@Test
Expand All @@ -210,19 +220,28 @@ void typeFromParentsDefaultClassAnnotatedSetterIsRegisteredForReflection() {
component.setClassName(OuterWithDefaultClass.class.getName());
component.getSubModels().add(contract);
TestGenerationContext generationContext = applyContribution(component);
RuntimeHints runtimeHints = generationContext.getRuntimeHints();
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(OuterWithDefaultClass.class))
.accepts(generationContext.getRuntimeHints());
.accepts(runtimeHints);
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(Implementation.class))
.accepts(generationContext.getRuntimeHints());
.accepts(runtimeHints);
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(BaseImplementation.Details.class))
.accepts(runtimeHints);
assertThat(runtimeHints).satisfies(hasValidTypeName(OuterWithDefaultClass.class));
assertThat(runtimeHints).satisfies(hasValidTypeName(Implementation.class));
assertThat(runtimeHints).satisfies(hasValidTypeName(BaseImplementation.Details.class));
}

@Test
void componentTypesOfArraysAreRegisteredForReflection() {
ComponentModel component = new ComponentModel();
component.setClassName(ArrayParameters.class.getName());
TestGenerationContext generationContext = applyContribution(component);
RuntimeHints runtimeHints = generationContext.getRuntimeHints();
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(InetSocketAddress.class))
.accepts(generationContext.getRuntimeHints());
.accepts(runtimeHints);
assertThat(runtimeHints).satisfies(hasValidTypeName(InetSocketAddress.class));
assertThat(runtimeHints).satisfies(hasValidTypeName(ArrayParameters.class));
}

@Test
Expand All @@ -231,10 +250,12 @@ void placeholdersInComponentClassAttributeAreReplaced() {
component.setClassName("${VARIABLE_CLASS_NAME}");
TestGenerationContext generationContext = applyContribution(component,
(context) -> context.putProperty("VARIABLE_CLASS_NAME", Outer.class.getName()));
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(Outer.class))
.accepts(generationContext.getRuntimeHints());
RuntimeHints runtimeHints = generationContext.getRuntimeHints();
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(Outer.class)).accepts(runtimeHints);
assertThat(invokePublicConstructorsAndInspectAndInvokePublicMethodsOf(Implementation.class))
.accepts(generationContext.getRuntimeHints());
.accepts(runtimeHints);
assertThat(runtimeHints).satisfies(hasValidTypeName(Outer.class));
assertThat(runtimeHints).satisfies(hasValidTypeName(Implementation.class));
}

private Predicate<RuntimeHints> invokePublicConstructorsOf(String name) {
Expand All @@ -250,6 +271,12 @@ private Predicate<RuntimeHints> invokePublicConstructorsAndInspectAndInvokePubli
MemberCategory.INVOKE_PUBLIC_METHODS);
}

private Consumer<RuntimeHints> hasValidTypeName(Class<?> type) {
return (runtimeHints) -> assertThat(runtimeHints.reflection().getTypeHint(type)).extracting(TypeHint::getType)
.extracting(TypeReference::getName)
.isEqualTo(type.getName());
}

private Properties load(InputStreamSource source) {
try (InputStream inputStream = source.getInputStream()) {
Properties properties = new Properties();
Expand Down Expand Up @@ -323,7 +350,21 @@ public void setContract(Contract contract) {

}

public static class Implementation implements Contract {
public static class BaseImplementation implements Contract {

private Details details;

public void setDetails(Details details) {
this.details = details;
}

public static final class Details {

}

}

public static class Implementation extends BaseImplementation {

}

Expand Down